+Wed Apr 23 12:18:11 EST 2008 Daniel P. Berrange <berrange@redhat.com>
+
+ * docs/libvir.html, docs/*.html.in: Removed merged HTML docs
+ and replaced with one file per page
+ * docs/*.html: Re-generated with new page layout
+ * docs/page.xsl: New master page template and navigation
+ * docs/site.xsl, docs/newapi.xsl, docs/ChangeLog.xsl: Updated
+ to use new page.xsl templates
+ * libvirt-net-*.{fig,png}: Added diagrams illustrating some
+ ways of using virtual networking
+ * docs/*.css: New styles for site
+ * docs/html/*: Re-generated for new page layout & removed
+ unused files
+
2008-04-21 Jim Meyering <meyering@redhat.com>
Enable 'make syntax-check's sc_changelog rule.
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
- <!-- Import the rest of the site stylesheets -->
- <xsl:import href="site.xsl"/>
-
<!-- Generate XHTML-1.0 transitional -->
<xsl:output method="xml" encoding="ISO-8859-1" indent="yes"
doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"/>
- <xsl:param name="module">libvirt</xsl:param>
-
- <!-- The table of content for the HTML page -->
- <xsl:variable name="menu_name">API Menu</xsl:variable>
- <xsl:variable name="develtoc">
- <form action="../search.php"
- enctype="application/x-www-form-urlencoded" method="get">
- <input name="query" type="text" size="20" value=""/>
- <input name="submit" type="submit" value="Search ..."/>
- </form>
- <ul><!-- style="margin-left: -1em" -->
- <li><a style="font-weight:bold"
- href="{$href_base}index.html">Main Menu</a></li>
- <li><a style="font-weight:bold"
- href="{$href_base}html/index.html">Modules Index</a></li>
- <li><a style="font-weight:bold"
- href="index.html">API Menu</a></li>
- </ul>
- </xsl:variable>
-
- <xsl:template match="bug">
- <a href="https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id={@number}">
- <xsl:value-of select="@number"/></a>
- </xsl:template>
-
<xsl:template match="item">
<li><xsl:apply-templates/></li>
</xsl:template>
<xsl:template match="entry">
-
<p>
- <b><xsl:value-of select="@who"/></b>
- <xsl:text> </xsl:text>
- <xsl:value-of select="@date"/>
- <xsl:text> </xsl:text>
- <xsl:value-of select="@timezone"/>
+ <span class="author"><xsl:value-of select="@who"/> </span>
+ <span class="date"><xsl:value-of select="@date"/> </span>
+ <span class="timezone"><xsl:value-of select="@timezone"/> </span>
+ </p>
<ul>
<xsl:apply-templates select="item"/>
</ul>
- </p>
</xsl:template>
<xsl:template match="log">
- <xsl:variable name="title">ChangeLog last entries of <xsl:value-of select="$module"/></xsl:variable>
- <html>
- <head>
- <xsl:call-template name="style"/>
- <xsl:element name="title">
- <xsl:value-of select="$title"/>
- </xsl:element>
- </head>
- <body>
- <div id="container">
- <div id="intro">
- <div id="adjustments"/>
- <div id="pageHeader"/>
- <div id="content2">
- <xsl:call-template name="titlebox">
- <xsl:with-param name="title" select="$title"/>
- </xsl:call-template>
- <xsl:apply-templates select="entry"/>
- </div>
- </div>
- <xsl:call-template name="linkList2"/>
- <xsl:call-template name="bottom"/>
- </div>
- </body>
- </html>
+ <html>
+ <body>
+ <h1>Log of recent changes to libvirt</h1>
+ <div id="changelog">
+ <xsl:apply-templates select="entry"/>
+ </div>
+ </body>
+ </html>
</xsl:template>
</xsl:stylesheet>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>FAQ</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">FAQ</h1><p>Table of Contents:</p><ul><li><a href="FAQ.html#License">License(s)</a></li>
- <li><a href="FAQ.html#Installati">Installation</a></li>
- <li><a href="FAQ.html#Compilatio">Compilation</a></li>
- <li><a href="FAQ.html#Developer">Developer corner</a></li>
-</ul><h3><a name="License" id="License">License</a>(s)</h3><ol><li><em>Licensing Terms for libvirt</em>
- <p>libvirt is released under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU Lesser
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from FAQ.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: FAQ</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>FAQ</h1>
+ <p>Table of Contents:</p>
+ <ul><li>
+ <a href="FAQ.html#License">License(s)</a>
+ </li><li>
+ <a href="FAQ.html#Installati">Installation</a>
+ </li><li>
+ <a href="FAQ.html#Compilatio">Compilation</a>
+ </li><li>
+ <a href="FAQ.html#Developer">Developer corner</a>
+ </li></ul>
+ <h3><a name="License" id="License">License</a>(s)</h3>
+ <ol><li>
+ <em>Licensing Terms for libvirt</em>
+ <p>libvirt is released under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU Lesser
General Public License</a>, see the file COPYING.LIB in the distribution
for the precise wording. The only library that libvirt depends upon is
the Xen store access library which is also licenced under the LGPL.</p>
- </li>
- <li><em>Can I embed libvirt in a proprietary application ?</em>
- <p>Yes. The LGPL allows you to embed libvirt into a proprietary
+ </li><li>
+ <em>Can I embed libvirt in a proprietary application ?</em>
+
<p>Yes. The LGPL allows you to embed libvirt into a proprietary
application. It would be graceful to send-back bug fixes and improvements
as patches for possible incorporation in the main development tree. It
will decrease your maintenance costs anyway if you do so.</p>
- </li>
-</ol><h3><a name="Installati" id="Installati">Installation</a></h3><ol><li><em>Where can I get libvirt</em> ?
+ </li></ol>
+ <h3>
+ <a name="Installati" id="Installati">Installation</a>
+ </h3>
+ <ol><li><em>Where can I get libvirt</em> ?
<p>The original distribution comes from <a href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/</a>.</p>
- </li>
- <li><em>I can't install the libvirt/libvirt-devel RPM packages due to
+ </li><li>
+ <em>I can't install the libvirt/libvirt-devel RPM packages due to
failed dependencies</em>
- <p>The most generic solution is to re-fetch the latest src.rpm , and
+
<p>The most generic solution is to re-fetch the latest src.rpm , and
rebuild it locally with</p>
- <p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p>
- <p>If everything goes well it will generate two binary rpm packages (one
+
<p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p>
+
<p>If everything goes well it will generate two binary rpm packages (one
providing the shared libs and virsh, and the other one, the -devel
package, providing includes, static libraries and scripts needed to build
applications with libvirt that you can install locally.</p>
- <p>One can also rebuild the RPMs from a tarball:</p>
- <p><code>rpmbuild -ta libdir-xxx.tar.gz</code></p>
- <p>Or from a configured tree with:</p>
- <p><code>make rpm</code></p>
- </li>
- <li><em>Failure to use the API for non-root users</em>
- <p>Large parts of the API may only be accessible with root privileges,
+ <p>One can also rebuild the RPMs from a tarball:</p>
+ <p>
+ <code>rpmbuild -ta libdir-xxx.tar.gz</code>
+ </p>
+ <p>Or from a configured tree with:</p>
+ <p>
+ <code>make rpm</code>
+ </p>
+ </li><li>
+ <em>Failure to use the API for non-root users</em>
+ <p>Large parts of the API may only be accessible with root privileges,
however the read only access to the xenstore data doesnot have to be
forbidden to user, at least for monitoring purposes. If "virsh dominfo"
fails to run as an user, change the mode of the xenstore read-only socket
with:</p>
- <p><code>chmod 666 /var/run/xenstored/socket_ro</code></p>
- <p>and also make sure that the Xen Daemon is running correctly with local
+ <p>
+ <code>chmod 666 /var/run/xenstored/socket_ro</code>
+ </p>
+ <p>and also make sure that the Xen Daemon is running correctly with local
HTTP server enabled, this is defined in
<code>/etc/xen/xend-config.sxp</code> which need the following line to be
enabled:</p>
- <p><code>(xend-http-server yes)</code></p>
- <p>If needed restart the xend daemon after making the change with the
+ <p>
+ <code>(xend-http-server yes)</code>
+ </p>
+ <p>If needed restart the xend daemon after making the change with the
following command run as root:</p>
- <p><code>service xend restart</code></p>
- </li>
-</ol><h3><a name="Compilatio" id="Compilatio">Compilation</a></h3><ol><li><em>What is the process to compile libvirt ?</em>
- <p>As most UNIX libraries libvirt follows the "standard":</p>
- <p><code>gunzip -c libvirt-xxx.tar.gz | tar xvf -</code></p>
- <p><code>cd libvirt-xxxx</code></p>
- <p><code>./configure --help</code></p>
- <p>to see the options, then the compilation/installation proper</p>
- <p><code>./configure [possible options]</code></p>
- <p><code>make</code></p>
- <p><code>make install</code></p>
- <p>At that point you may have to rerun ldconfig or a similar utility to
+ <p>
+ <code>service xend restart</code>
+ </p>
+ </li></ol>
+ <h3>
+ <a name="Compilatio" id="Compilatio">Compilation</a>
+ </h3>
+ <ol><li>
+ <em>What is the process to compile libvirt ?</em>
+ <p>As most UNIX libraries libvirt follows the "standard":</p>
+ <p>
+ <code>gunzip -c libvirt-xxx.tar.gz | tar xvf -</code>
+ </p>
+ <p>
+ <code>cd libvirt-xxxx</code>
+ </p>
+ <p>
+ <code>./configure --help</code>
+ </p>
+ <p>to see the options, then the compilation/installation proper</p>
+ <p>
+ <code>./configure [possible options]</code>
+ </p>
+ <p>
+ <code>make</code>
+ </p>
+ <p>
+ <code>make install</code>
+ </p>
+ <p>At that point you may have to rerun ldconfig or a similar utility to
update your list of installed shared libs.</p>
- </li>
- <li><em>What other libraries are needed to compile/install libvirt ?</em>
- <p>Libvirt requires libxenstore, which is usually provided by the xen
+ </li><li>
+ <em>What other libraries are needed to compile/install libvirt ?</em>
+
<p>Libvirt requires libxenstore, which is usually provided by the xen
packages as well as the public headers to compile against libxenstore.</p>
- </li>
- <li><em>I use the CVS version and there is no configure script</em>
- <p>The configure script (and other Makefiles) are generated. Use the
+ </li><li>
+ <em>I use the CVS version and there is no configure script</em>
+
<p>The configure script (and other Makefiles) are generated. Use the
autogen.sh script to regenerate the configure script and Makefiles,
like:</p>
- <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
- </li>
-</ol><h3><a name="Developer" id="Developer">Developer</a> corner</h3><ol><li><em>Troubles compiling or linking programs using libvirt</em>
- <p>To simplify the process of reusing the library, libvirt comes with
+ <p>
+ <code>./autogen.sh --prefix=/usr --disable-shared</code>
+ </p>
+ </li></ol>
+ <h3><a name="Developer" id="Developer">Developer</a> corner</h3>
+ <ol><li>
+ <em>Troubles compiling or linking programs using libvirt</em>
+ <p>To simplify the process of reusing the library, libvirt comes with
pkgconfig support, which can be used directly from autoconf support or
via the pkg-config command line tool, like:</p>
- <p><code>pkg-config libvirt --libs</code></p>
- </li>
-</ol></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+ <p>
+ <code>pkg-config libvirt --libs</code>
+ </p>
+ </li></ol>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <span class="active">FAQ</span>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1 >FAQ</h1>
+ <p>Table of Contents:</p>
+ <ul>
+ <li>
+ <a href="FAQ.html#License">License(s)</a>
+ </li>
+ <li>
+ <a href="FAQ.html#Installati">Installation</a>
+ </li>
+ <li>
+ <a href="FAQ.html#Compilatio">Compilation</a>
+ </li>
+ <li>
+ <a href="FAQ.html#Developer">Developer corner</a>
+ </li>
+ </ul>
+ <h3><a name="License" id="License">License</a>(s)</h3>
+ <ol>
+ <li>
+ <em>Licensing Terms for libvirt</em>
+ <p>libvirt is released under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU Lesser
+ General Public License</a>, see the file COPYING.LIB in the distribution
+ for the precise wording. The only library that libvirt depends upon is
+ the Xen store access library which is also licenced under the LGPL.</p>
+ </li>
+ <li>
+ <em>Can I embed libvirt in a proprietary application ?</em>
+ <p>Yes. The LGPL allows you to embed libvirt into a proprietary
+ application. It would be graceful to send-back bug fixes and improvements
+ as patches for possible incorporation in the main development tree. It
+ will decrease your maintenance costs anyway if you do so.</p>
+ </li>
+ </ol>
+ <h3>
+ <a name="Installati" id="Installati">Installation</a>
+ </h3>
+ <ol>
+ <li><em>Where can I get libvirt</em> ?
+ <p>The original distribution comes from <a href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/</a>.</p>
+ </li>
+ <li>
+ <em>I can't install the libvirt/libvirt-devel RPM packages due to
+ failed dependencies</em>
+ <p>The most generic solution is to re-fetch the latest src.rpm , and
+ rebuild it locally with</p>
+ <p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p>
+ <p>If everything goes well it will generate two binary rpm packages (one
+ providing the shared libs and virsh, and the other one, the -devel
+ package, providing includes, static libraries and scripts needed to build
+ applications with libvirt that you can install locally.</p>
+ <p>One can also rebuild the RPMs from a tarball:</p>
+ <p>
+ <code>rpmbuild -ta libdir-xxx.tar.gz</code>
+ </p>
+ <p>Or from a configured tree with:</p>
+ <p>
+ <code>make rpm</code>
+ </p>
+ </li>
+ <li>
+ <em>Failure to use the API for non-root users</em>
+ <p>Large parts of the API may only be accessible with root privileges,
+ however the read only access to the xenstore data doesnot have to be
+ forbidden to user, at least for monitoring purposes. If "virsh dominfo"
+ fails to run as an user, change the mode of the xenstore read-only socket
+ with:</p>
+ <p>
+ <code>chmod 666 /var/run/xenstored/socket_ro</code>
+ </p>
+ <p>and also make sure that the Xen Daemon is running correctly with local
+ HTTP server enabled, this is defined in
+ <code>/etc/xen/xend-config.sxp</code> which need the following line to be
+ enabled:</p>
+ <p>
+ <code>(xend-http-server yes)</code>
+ </p>
+ <p>If needed restart the xend daemon after making the change with the
+ following command run as root:</p>
+ <p>
+ <code>service xend restart</code>
+ </p>
+ </li>
+ </ol>
+ <h3>
+ <a name="Compilatio" id="Compilatio">Compilation</a>
+ </h3>
+ <ol>
+ <li>
+ <em>What is the process to compile libvirt ?</em>
+ <p>As most UNIX libraries libvirt follows the "standard":</p>
+ <p>
+ <code>gunzip -c libvirt-xxx.tar.gz | tar xvf -</code>
+ </p>
+ <p>
+ <code>cd libvirt-xxxx</code>
+ </p>
+ <p>
+ <code>./configure --help</code>
+ </p>
+ <p>to see the options, then the compilation/installation proper</p>
+ <p>
+ <code>./configure [possible options]</code>
+ </p>
+ <p>
+ <code>make</code>
+ </p>
+ <p>
+ <code>make install</code>
+ </p>
+ <p>At that point you may have to rerun ldconfig or a similar utility to
+ update your list of installed shared libs.</p>
+ </li>
+ <li>
+ <em>What other libraries are needed to compile/install libvirt ?</em>
+ <p>Libvirt requires libxenstore, which is usually provided by the xen
+ packages as well as the public headers to compile against libxenstore.</p>
+ </li>
+ <li>
+ <em>I use the CVS version and there is no configure script</em>
+ <p>The configure script (and other Makefiles) are generated. Use the
+ autogen.sh script to regenerate the configure script and Makefiles,
+ like:</p>
+ <p>
+ <code>./autogen.sh --prefix=/usr --disable-shared</code>
+ </p>
+ </li>
+ </ol>
+ <h3><a name="Developer" id="Developer">Developer</a> corner</h3>
+ <ol>
+ <li>
+ <em>Troubles compiling or linking programs using libvirt</em>
+ <p>To simplify the process of reusing the library, libvirt comes with
+ pkgconfig support, which can be used directly from autoconf support or
+ via the pkg-config command line tool, like:</p>
+ <p>
+ <code>pkg-config libvirt --libs</code>
+ </p>
+ </li>
+ </ol>
+ </body>
+</html>
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=../src
-PAGES= index.html bugs.html FAQ.html remote.html
-
man_MANS=
-html = \
- book1.html \
+apihtml = \
index.html \
- libvirt-conf.html \
- libvirt-lib.html \
libvirt-libvirt.html \
libvirt-virterror.html
-png = \
+apipng = \
left.png \
up.png \
home.png \
right.png
+png = \
+ 16favicon.png \
+ 32favicon.png \
+ et_logo.png \
+ footer_corner.png \
+ footer_pattern.png \
+ libvirHeader.png \
+ libvirLogo.png \
+ libvirt-header-bg.png \
+ libvirt-header-logo.png \
+ libvirtLogo.png \
+ libvirt-net-logical.png \
+ libvirt-net-physical.png \
+ madeWith.png \
+ windows-cygwin-1.png \
+ windows-cygwin-2.png \
+ windows-cygwin-3.png
+
gif = \
Libxml2-Logo-90x34.gif \
architecture.gif \
node.gif \
redhat.gif
-dot_html = \
- FAQ.html \
- architecture.html \
- bugs.html \
- downloads.html \
- errors.html \
- format.html \
- hvsupport.html \
- index.html \
- intro.html \
- libvir.html \
- news.html \
- python.html \
- remote.html \
- uri.html
+dot_html_in = $(wildcard *.html.in)
+dot_html = $(dot_html_in:%.html.in=%.html)
xml = \
libvirt-api.xml \
libvirt.rng \
network.rng
+fig = \
+ libvirt-net-logical.fig \
+ libvirt-net-physical.fig
+
EXTRA_DIST= \
libvirt-api.xml libvirt-refs.xml apibuild.py \
- site.xsl newapi.xsl news.xsl \
- $(dot_html) $(gif) html \
- $(xml) $(rng) \
- virsh.pod
+ site.xsl newapi.xsl news.xsl page.xsl ChangeLog.xsl \
+ $(dot_html) $(dot_html_in) $(gif) html/*.html html/*.png \
+ $(xml) $(rng) $(fig) $(png) \
+ virsh.pod ChangeLog.awk
all: web $(top_builddir)/NEWS $(man_MANS)
api: libvirt-api.xml libvirt-refs.xml $(srcdir)/html/index.html
-web: $(PAGES)
+web: $(dot_html)
-$(PAGES): libvir.html site.xsl
- -@(if [ -x $(XSLTPROC) ] ; then \
- echo "Rebuilding the HTML Web pages from libvir.html" ; \
- $(XSLTPROC) --nonet --html $(top_srcdir)/docs/site.xsl $(top_srcdir)/docs/libvir.html > index.html ; fi );
- -@(if [ -x $(XMLLINT) ] ; then \
- echo "Validating the HTML Web pages" ; \
- $(XMLLINT) --nonet --valid --noout $(PAGES) ; fi );
+ChangeLog.xml: ../ChangeLog ChangeLog.awk
+ awk -f ChangeLog.awk < $< > $@
+
+ChangeLog.html.in: ChangeLog.xml ChangeLog.xsl
+ @(if [ -x $(XSLTPROC) ] ; then \
+ echo "Generating $@"; \
+ name=`echo $@ | sed -e 's/.tmp//'`; \
+ $(XSLTPROC) --nonet $(top_srcdir)/docs/ChangeLog.xsl $< > $@ || (rm $@ && exit 1) ; fi )
+
+%.html.tmp: %.html.in site.xsl page.xsl sitemap.html.in
+ @(if [ -x $(XSLTPROC) ] ; then \
+ echo "Generating $@"; \
+ name=`echo $@ | sed -e 's/.tmp//'`; \
+ $(XSLTPROC) --stringparam pagename $$name --nonet --html $(top_srcdir)/docs/site.xsl $< > $@ || (rm $@ && exit 1) ; fi )
+
+%.html: %.html.tmp
+ @(if [ -x $(XMLLINT) ] ; then \
+ echo "Validating $@" ; \
+ $(XMLLINT) --nonet --format --valid $< > $@ || : ; fi );
-$(srcdir)/html/index.html: libvirt-api.xml $(srcdir)/newapi.xsl
+$(srcdir)/html/index.html: libvirt-api.xml newapi.xsl page.xsl sitemap.html.in
-@(if [ -x $(XSLTPROC) ] ; then \
echo "Rebuilding the HTML pages from the XML API" ; \
$(XSLTPROC) --nonet $(srcdir)/newapi.xsl libvirt-api.xml ; fi )
$(srcdir)/redhat.gif $(srcdir)/Libxml2-Logo-90x34.gif \
$(DESTDIR)$(HTML_DIR)
$(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/html
- for h in $(html); do \
+ for h in $(apihtml); do \
$(INSTALL) -m 0644 $(srcdir)/html/$$h $(DESTDIR)$(HTML_DIR)/html; done
- for p in $(png); do \
+ for p in $(apipng); do \
$(INSTALL) -m 0644 $(srcdir)/html/$$p $(DESTDIR)$(HTML_DIR)/html; done
uninstall-local:
- for h in $(html); do rm $(DESTDIR)$(HTML_DIR)/html/$$h; done
- for p in $(png); do rm $(DESTDIR)$(HTML_DIR)/html/$$p; done
+ for h in $(apihtml); do rm $(DESTDIR)$(HTML_DIR)/html/$$h; done
+ for p in $(apipng); do rm $(DESTDIR)$(HTML_DIR)/html/$$p; done
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from apps.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Applications using libvirt</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Applications using <strong>libvirt</strong></h1>
+ <p>
+ This page provides an illustration of the wide variety of
+ applications using the libvirt management API. If you know
+ of interesting applications not listed on this page, send
+ a message to the <a href="contact.html">mailing list</a>
+ to request that it be added here. If your application uses
+ libvirt as its API, the following graphic is available for
+ your website to advertise support for libvirt:
+ </p>
+ <p class="image">
+ <img src="madeWith.png" alt="Made with libvirt" /></p>
+ <h2>Command line tools</h2>
+ <dl><dt>virsh</dt><dd>
+ An interactive shell, and batch scriptable tool for performing
+ management tasks on all libvirt managed domains, networks and
+ storage. This is part of the libvirt core distribution.
+ </dd><dt><a href="http://virt-manager.org/">virt-install</a></dt><dd>
+ Provides a way to provision new virtual machines from a
+ OS distribution install tree. It supports provisioning from
+ local CD images, and the network over NFS, HTTP and FTP.
+ </dd><dt><a href="http://virt-manager.org/">virt-clone</a></dt><dd>
+ Allows the disk image(s) and configuration for an existing
+ virtual machine to be cloned to form a new virtual machine.
+ It automates copying of data across to new disk images, and
+ updates the UUID, Mac address and name in the configuration
+ </dd><dt><a href="http://virt-manager.org/">virt-image</a></dt><dd>
+ Provides a way to deploy virtual appliances. It defines a
+ simplified portable XML format describing the pre-requisites
+ of a virtual machine. At time of deployment this is translated
+ into the domain XML format for execution under any libvirt
+ hypervisor meeting the pre-requisites.
+ </dd><dt><a href="http://et.redhat.com/~rjones/virt-df/">virt-df</a></dt><dd>
+ Examine the utilization of each filesystem in a virtual machine
+ from the comfort of the host machine. This tool peeks into the
+ guest disks and determines how much space is used. It can cope
+ with common Linux filesystems and LVM volumes.
+ </dd><dt><a href="http://et.redhat.com/~rjones/virt-top/">virt-top</a></dt><dd>
+ Watch the CPU, memory, network and disk utilization of all
+ virtual machines running on a host.
+ </dd></dl>
+ <h2>Desktop applications</h2>
+ <dl><dt><a href="http://virt-manager.org/">virt-manager</a></dt><dd>
+ A general purpose desktop management tool, able to manage
+ virtual machines across both local and remotely accessed
+ hypervisors. It is targetted at home and small office usage
+ upto managing 10-20 hosts and their VMs.
+ </dd><dt><a href="http://virt-manager.org/">virt-viewer</a></dt><dd>
+ A lightweight tool for accessing the graphical console
+ associated with a virtual machine. It can securely connect
+ to remote consoles supporting the VNC protocol. Also provides
+ an optional mozilla browser plugin.
+ </dd></dl>
+ <h2>Web applications</h2>
+ <dl><dt><a href="http://ovirt.org/">oVirt</a></dt><dd>
+ oVirt provides the ability to manage large numbers of virtual
+ machines across an entire data center of hosts. It integrates
+ with FreeIPA for Kerberos authentication, and in the future,
+ certificate management.
+ </dd></dl>
+ <h2>LiveCD / Appliances</h2>
+ <dl><dt><a href="http://et.redhat.com/~rjones/virt-p2v/">virt-p2v</a></dt><dd>
+ A tool for converting a physical machine into a virtual machine. It
+ is a LiveCD which is booted on the machine to be converted. It collects
+ a little information from the user and then copies the disks over to
+ a remote machine and defines the XML for a domain to run the guest.
+ </dd></dl>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="active" href="relatedlinks.html">Related Links</a>
+ <ul class="l1"><li>
+ <span class="active">Applications</span>
+ </li></ul>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Applications using <strong>libvirt</strong></h1>
+
+ <p>
+ This page provides an illustration of the wide variety of
+ applications using the libvirt management API. If you know
+ of interesting applications not listed on this page, send
+ a message to the <a href="contact.html">mailing list</a>
+ to request that it be added here. If your application uses
+ libvirt as its API, the following graphic is available for
+ your website to advertise support for libvirt:
+ </p>
+
+ <p class="image">
+ <img src="madeWith.png" alt="Made with libvirt"/>
+ </p>
+
+ <h2>Command line tools</h2>
+
+ <dl>
+ <dt>virsh</dt>
+ <dd>
+ An interactive shell, and batch scriptable tool for performing
+ management tasks on all libvirt managed domains, networks and
+ storage. This is part of the libvirt core distribution.
+ </dd>
+ <dt><a href="http://virt-manager.org/">virt-install</a></dt>
+ <dd>
+ Provides a way to provision new virtual machines from a
+ OS distribution install tree. It supports provisioning from
+ local CD images, and the network over NFS, HTTP and FTP.
+ </dd>
+ <dt><a href="http://virt-manager.org/">virt-clone</a></dt>
+ <dd>
+ Allows the disk image(s) and configuration for an existing
+ virtual machine to be cloned to form a new virtual machine.
+ It automates copying of data across to new disk images, and
+ updates the UUID, Mac address and name in the configuration
+ </dd>
+ <dt><a href="http://virt-manager.org/">virt-image</a></dt>
+ <dd>
+ Provides a way to deploy virtual appliances. It defines a
+ simplified portable XML format describing the pre-requisites
+ of a virtual machine. At time of deployment this is translated
+ into the domain XML format for execution under any libvirt
+ hypervisor meeting the pre-requisites.
+ </dd>
+ <dt><a href="http://et.redhat.com/~rjones/virt-df/">virt-df</a></dt>
+ <dd>
+ Examine the utilization of each filesystem in a virtual machine
+ from the comfort of the host machine. This tool peeks into the
+ guest disks and determines how much space is used. It can cope
+ with common Linux filesystems and LVM volumes.
+ </dd>
+ <dt><a href="http://et.redhat.com/~rjones/virt-top/">virt-top</a></dt>
+ <dd>
+ Watch the CPU, memory, network and disk utilization of all
+ virtual machines running on a host.
+ </dd>
+ </dl>
+
+ <h2>Desktop applications</h2>
+
+ <dl>
+ <dt><a href="http://virt-manager.org/">virt-manager</a></dt>
+ <dd>
+ A general purpose desktop management tool, able to manage
+ virtual machines across both local and remotely accessed
+ hypervisors. It is targetted at home and small office usage
+ upto managing 10-20 hosts and their VMs.
+ </dd>
+ <dt><a href="http://virt-manager.org/">virt-viewer</a></dt>
+ <dd>
+ A lightweight tool for accessing the graphical console
+ associated with a virtual machine. It can securely connect
+ to remote consoles supporting the VNC protocol. Also provides
+ an optional mozilla browser plugin.
+ </dd>
+ </dl>
+
+ <h2>Web applications</h2>
+
+ <dl>
+ <dt><a href="http://ovirt.org/">oVirt</a></dt>
+ <dd>
+ oVirt provides the ability to manage large numbers of virtual
+ machines across an entire data center of hosts. It integrates
+ with FreeIPA for Kerberos authentication, and in the future,
+ certificate management.
+ </dd>
+ </dl>
+
+ <h2>LiveCD / Appliances</h2>
+
+ <dl>
+ <dt><a href="http://et.redhat.com/~rjones/virt-p2v/">virt-p2v</a></dt>
+ <dd>
+ A tool for converting a physical machine into a virtual machine. It
+ is a LiveCD which is booted on the machine to be converted. It collects
+ a little information from the user and then copies the disks over to
+ a remote machine and defines the XML for a domain to run the guest.
+ </dd>
+ </dl>
+
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from archdomain.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Domain management architecture</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Domain management architecture</h1>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="active" href="intro.html">Architecture</a>
+ <ul class="l2"><li>
+ <span class="active">Domains</span>
+ </li><li>
+ <a title="Providing isolated networks and NAT based network connectivity" class="inactive" href="archnetwork.html">Network</a>
+ </li><li>
+ <a title="Managing storage pools and volumes" class="inactive" href="archstorage.html">Storage</a>
+ </li><li>
+ <a title="Enumerating host node devices" class="inactive" href="archnode.html">Node Devices</a>
+ </li></ul>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Domain management architecture</h1>
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>libvirt architecture</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">libvirt architecture</h1><p>Currently libvirt supports 2 kind of virtualization, and its
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from architecture.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: libvirt architecture</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>libvirt architecture</h1>
+ <p>Currently libvirt supports 2 kind of virtualization, and its
internal structure is based on a driver model which simplifies adding new
-engines:</p><ul><li><a href="#Xen">Xen hypervisor</a></li>
- <li><a href="#QEmu">QEmu and KVM based virtualization</a></li>
- <li><a href="#drivers">the driver architecture</a></li>
-</ul><h3><a name="Xen" id="Xen">Libvirt Xen support</a></h3><p>When running in a Xen environment, programs using libvirt have to execute
+engines:</p>
+ <ul><li>
+ <a href="#Xen">Xen hypervisor</a>
+ </li><li>
+ <a href="#QEmu">QEmu and KVM based virtualization</a>
+ </li><li>
+ <a href="#drivers">the driver architecture</a>
+ </li></ul>
+ <h3>
+ <a name="Xen" id="Xen">Libvirt Xen support</a>
+ </h3>
+ <p>When running in a Xen environment, programs using libvirt have to execute
in "Domain 0", which is the primary Linux OS loaded on the machine. That OS
kernel provides most if not all of the actual drivers used by the set of
domains. It also runs the Xen Store, a database of information shared by the
supervise the control and execution of the sets of domains. The hypervisor,
drivers, kernels and daemons communicate though a shared system bus
implemented in the hypervisor. The figure below tries to provide a view of
-this environment:</p><img src="architecture.gif" alt="The Xen architecture" /><p>The library can be initialized in 2 ways depending on the level of
+this environment:</p>
+ <img src="architecture.gif" alt="The Xen architecture" />
+ <p>The library can be initialized in 2 ways depending on the level of
privilege of the embedding program. If it runs with root access,
virConnectOpen() can be used, it will use three different ways to connect to
-the Xen infrastructure:</p><ul><li>a connection to the Xen Daemon though an HTTP RPC layer</li>
- <li>a read/write connection to the Xen Store</li>
- <li>use Xen Hypervisor calls</li>
- <li>when used as non-root libvirt connect to a proxy daemon running
- as root and providing read-only support</li>
-</ul><p>The library will usually interact with the Xen daemon for any operation
+the Xen infrastructure:</p>
+ <ul><li>a connection to the Xen Daemon though an HTTP RPC layer</li><li>a read/write connection to the Xen Store</li><li>use Xen Hypervisor calls</li><li>when used as non-root libvirt connect to a proxy daemon running
+ as root and providing read-only support</li></ul>
+ <p>The library will usually interact with the Xen daemon for any operation
changing the state of the system, but for performance and accuracy reasons
may talk directly to the hypervisor when gathering state information at
least when possible (i.e. when the running program using libvirt has root
-privilege access).</p><p>If it runs without root access virConnectOpenReadOnly() should be used to
+privilege access).</p>
+ <p>If it runs without root access virConnectOpenReadOnly() should be used to
connect to initialize the library. It will then fork a libvirt_proxy
program running as root and providing read_only access to the API, this is
-then only useful for reporting and monitoring.</p><h3><a name="QEmu" id="QEmu">Libvirt QEmu and KVM support</a></h3><p>The model for QEmu and KVM is completely similar, basically KVM is based
+then only useful for reporting and monitoring.</p>
+ <h3>
+ <a name="QEmu" id="QEmu">Libvirt QEmu and KVM support</a>
+ </h3>
+ <p>The model for QEmu and KVM is completely similar, basically KVM is based
on QEmu for the process controlling a new domain, only small details differs
between the two. In both case the libvirt API is provided by a controlling
process forked by libvirt in the background and which launch and control the
protocol to the library, and connects to the console of the QEmu process in
order to control and report on its status. Libvirt tries to expose all the
emulations models of QEmu, the selection is done when creating the new
-domain, by specifying the architecture and machine type targeted.</p><p>The code controlling the QEmu process is available in the
-<code>qemud/</code> directory.</p><h3><a name="drivers" id="drivers">the driver based architecture</a></h3><p>As the previous section explains, libvirt can communicate using different
+domain, by specifying the architecture and machine type targeted.</p>
+ <p>The code controlling the QEmu process is available in the
+<code>qemud/</code> directory.</p>
+ <h3>
+ <a name="drivers" id="drivers">the driver based architecture</a>
+ </h3>
+ <p>As the previous section explains, libvirt can communicate using different
channels with the current hypervisor, and should also be able to use
different kind of hypervisor. To simplify the internal design, code, ease
maintenance and simplify the support of other virtualization engine the
defining a common set of routines. That way the Xen Daemon access, the Xen
Store one, the Hypervisor hypercall are all isolated in separate C modules
implementing at least a subset of the common operations defined by the
-drivers present in driver.h:</p><ul><li>xend_internal: implements the driver functions though the Xen
- Daemon</li>
- <li>xs_internal: implements the subset of the driver available though the
- Xen Store</li>
- <li>xen_internal: provide the implementation of the functions possible via
- direct hypervisor access</li>
- <li>proxy_internal: provide read-only Xen access via a proxy, the proxy code
- is in the <code>proxy/</code>directory.</li>
- <li>xm_internal: provide support for Xen defined but not running
- domains.</li>
- <li>qemu_internal: implement the driver functions for QEmu and
+drivers present in driver.h:</p>
+ <ul><li>xend_internal: implements the driver functions though the Xen
+ Daemon</li><li>xs_internal: implements the subset of the driver available though the
+ Xen Store</li><li>xen_internal: provide the implementation of the functions possible via
+ direct hypervisor access</li><li>proxy_internal: provide read-only Xen access via a proxy, the proxy code
+ is in the <code>proxy/</code>directory.</li><li>xm_internal: provide support for Xen defined but not running
+ domains.</li><li>qemu_internal: implement the driver functions for QEmu and
KVM virtualization engines. It also uses a qemud/ specific daemon
- which interacts with the QEmu process to implement libvirt API.</li>
- <li>test: this is a test driver useful for regression tests of the
- front-end part of libvirt.</li>
-</ul><p>Note that a given driver may only implement a subset of those functions,
+ which interacts with the QEmu process to implement libvirt API.</li><li>test: this is a test driver useful for regression tests of the
+ front-end part of libvirt.</li></ul>
+ <p>Note that a given driver may only implement a subset of those functions,
(for example saving a Xen domain state to disk and restoring it is only
possible though the Xen Daemon), in that case the driver entry points for
-unsupported functions are initialized to NULL.</p><p></p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+unsupported functions are initialized to NULL.</p>
+ <p></p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1 >libvirt architecture</h1>
+ <p>Currently libvirt supports 2 kind of virtualization, and its
+internal structure is based on a driver model which simplifies adding new
+engines:</p>
+ <ul>
+ <li>
+ <a href="#Xen">Xen hypervisor</a>
+ </li>
+ <li>
+ <a href="#QEmu">QEmu and KVM based virtualization</a>
+ </li>
+ <li>
+ <a href="#drivers">the driver architecture</a>
+ </li>
+ </ul>
+ <h3>
+ <a name="Xen" id="Xen">Libvirt Xen support</a>
+ </h3>
+ <p>When running in a Xen environment, programs using libvirt have to execute
+in "Domain 0", which is the primary Linux OS loaded on the machine. That OS
+kernel provides most if not all of the actual drivers used by the set of
+domains. It also runs the Xen Store, a database of information shared by the
+hypervisor, the kernels, the drivers and the xen daemon. Xend. The xen daemon
+supervise the control and execution of the sets of domains. The hypervisor,
+drivers, kernels and daemons communicate though a shared system bus
+implemented in the hypervisor. The figure below tries to provide a view of
+this environment:</p>
+ <img src="architecture.gif" alt="The Xen architecture" />
+ <p>The library can be initialized in 2 ways depending on the level of
+privilege of the embedding program. If it runs with root access,
+virConnectOpen() can be used, it will use three different ways to connect to
+the Xen infrastructure:</p>
+ <ul>
+ <li>a connection to the Xen Daemon though an HTTP RPC layer</li>
+ <li>a read/write connection to the Xen Store</li>
+ <li>use Xen Hypervisor calls</li>
+ <li>when used as non-root libvirt connect to a proxy daemon running
+ as root and providing read-only support</li>
+ </ul>
+ <p>The library will usually interact with the Xen daemon for any operation
+changing the state of the system, but for performance and accuracy reasons
+may talk directly to the hypervisor when gathering state information at
+least when possible (i.e. when the running program using libvirt has root
+privilege access).</p>
+ <p>If it runs without root access virConnectOpenReadOnly() should be used to
+connect to initialize the library. It will then fork a libvirt_proxy
+program running as root and providing read_only access to the API, this is
+then only useful for reporting and monitoring.</p>
+ <h3>
+ <a name="QEmu" id="QEmu">Libvirt QEmu and KVM support</a>
+ </h3>
+ <p>The model for QEmu and KVM is completely similar, basically KVM is based
+on QEmu for the process controlling a new domain, only small details differs
+between the two. In both case the libvirt API is provided by a controlling
+process forked by libvirt in the background and which launch and control the
+QEmu or KVM process. That program called libvirt_qemud talks though a specific
+protocol to the library, and connects to the console of the QEmu process in
+order to control and report on its status. Libvirt tries to expose all the
+emulations models of QEmu, the selection is done when creating the new
+domain, by specifying the architecture and machine type targeted.</p>
+ <p>The code controlling the QEmu process is available in the
+<code>qemud/</code> directory.</p>
+ <h3>
+ <a name="drivers" id="drivers">the driver based architecture</a>
+ </h3>
+ <p>As the previous section explains, libvirt can communicate using different
+channels with the current hypervisor, and should also be able to use
+different kind of hypervisor. To simplify the internal design, code, ease
+maintenance and simplify the support of other virtualization engine the
+internals have been structured as one core component, the libvirt.c module
+acting as a front-end for the library API and a set of hypervisor drivers
+defining a common set of routines. That way the Xen Daemon access, the Xen
+Store one, the Hypervisor hypercall are all isolated in separate C modules
+implementing at least a subset of the common operations defined by the
+drivers present in driver.h:</p>
+ <ul>
+ <li>xend_internal: implements the driver functions though the Xen
+ Daemon</li>
+ <li>xs_internal: implements the subset of the driver available though the
+ Xen Store</li>
+ <li>xen_internal: provide the implementation of the functions possible via
+ direct hypervisor access</li>
+ <li>proxy_internal: provide read-only Xen access via a proxy, the proxy code
+ is in the <code>proxy/</code>directory.</li>
+ <li>xm_internal: provide support for Xen defined but not running
+ domains.</li>
+ <li>qemu_internal: implement the driver functions for QEmu and
+ KVM virtualization engines. It also uses a qemud/ specific daemon
+ which interacts with the QEmu process to implement libvirt API.</li>
+ <li>test: this is a test driver useful for regression tests of the
+ front-end part of libvirt.</li>
+ </ul>
+ <p>Note that a given driver may only implement a subset of those functions,
+(for example saving a Xen domain state to disk and restoring it is only
+possible though the Xen Daemon), in that case the driver entry points for
+unsupported functions are initialized to NULL.</p>
+ <p></p>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from archnetwork.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Network management architecture</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Network management architecture</h1>
+ <h2>Architecture illustration</h2>
+ <p>
+ The diagrams below illustrate some of the network configurations
+ enabled by the libvirt networking APIs
+ </p>
+ <ul><li><strong>VLAN 1</strong>. This virtual network has connectivity
+ to <code>LAN 2</code> with traffic forwarded and NATed.
+ </li><li><strong>VLAN 2</strong>. This virtual network is completely
+ isolated from any physical LAN.
+ </li><li><strong>Guest A</strong>. The first network interface is bridged
+ to the physical <code>LAN 1</code>. The second interface is connected
+ to a virtual network <code>VLAN 1</code>.
+ </li><li><strong>Guest B</strong>. The first network interface is connected
+ to a virtual network <code>VLAN 1</code>, giving it limited NAT
+ based connectivity to LAN2. It has a second network interface
+ connected to <code>VLAN 2</code>. It acts a router allowing limited
+ traffic between the two VLANs, thus giving <code>Guest C</code>
+ connectivity to the physical <code>LAN 2</code>.
+ </li><li><strong>Guest C</strong>. The only network interface is connected
+ to a virtual network <code>VLAN 2</code>. It has no direct connectivity
+ to a physical LAN, relying on <code>Guest B</code> to route traffic
+ on its behalf.
+ </li></ul>
+ <h3>Logical diagram</h3>
+ <p class="image">
+ <img src="libvirt-net-logical.png" alt="Logical network architecture" /></p>
+ <h3>Physical diagram</h3>
+ <p class="image">
+ <img src="libvirt-net-physical.png" alt="Physical network architecture" /></p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="active" href="intro.html">Architecture</a>
+ <ul class="l2"><li>
+ <a title="Managing virtual machines" class="inactive" href="archdomain.html">Domains</a>
+ </li><li>
+ <span class="active">Network</span>
+ </li><li>
+ <a title="Managing storage pools and volumes" class="inactive" href="archstorage.html">Storage</a>
+ </li><li>
+ <a title="Enumerating host node devices" class="inactive" href="archnode.html">Node Devices</a>
+ </li></ul>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Network management architecture</h1>
+
+ <h2>Architecture illustration</h2>
+
+ <p>
+ The diagrams below illustrate some of the network configurations
+ enabled by the libvirt networking APIs
+ </p>
+
+ <ul>
+ <li><strong>VLAN 1</strong>. This virtual network has connectivity
+ to <code>LAN 2</code> with traffic forwarded and NATed.
+ </li>
+ <li><strong>VLAN 2</strong>. This virtual network is completely
+ isolated from any physical LAN.
+ </li>
+ <li><strong>Guest A</strong>. The first network interface is bridged
+ to the physical <code>LAN 1</code>. The second interface is connected
+ to a virtual network <code>VLAN 1</code>.
+ </li>
+ <li><strong>Guest B</strong>. The first network interface is connected
+ to a virtual network <code>VLAN 1</code>, giving it limited NAT
+ based connectivity to LAN2. It has a second network interface
+ connected to <code>VLAN 2</code>. It acts a router allowing limited
+ traffic between the two VLANs, thus giving <code>Guest C</code>
+ connectivity to the physical <code>LAN 2</code>.
+ </li>
+ <li><strong>Guest C</strong>. The only network interface is connected
+ to a virtual network <code>VLAN 2</code>. It has no direct connectivity
+ to a physical LAN, relying on <code>Guest B</codE> to route traffic
+ on its behalf.
+ </li>
+ </ul>
+
+ <h3>Logical diagram</h3>
+
+ <p class="image">
+ <img src="libvirt-net-logical.png" alt="Logical network architecture"/>
+ </p>
+
+ <h3>Physical diagram</h3>
+
+ <p class="image">
+ <img src="libvirt-net-physical.png" alt="Physical network architecture"/>
+ </p>
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from archnode.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Node device management architecture</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Node device management architecture</h1>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="active" href="intro.html">Architecture</a>
+ <ul class="l2"><li>
+ <a title="Managing virtual machines" class="inactive" href="archdomain.html">Domains</a>
+ </li><li>
+ <a title="Providing isolated networks and NAT based network connectivity" class="inactive" href="archnetwork.html">Network</a>
+ </li><li>
+ <a title="Managing storage pools and volumes" class="inactive" href="archstorage.html">Storage</a>
+ </li><li>
+ <span class="active">Node Devices</span>
+ </li></ul>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Node device management architecture</h1>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from archstorage.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Storage management architecture</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Storage management architecture</h1>
+ <p>
+ The storage management APIs are based around 2 core concepts
+ </p>
+ <ol><li>
+ <strong>Volume</strong> - a single storage volume which can
+ be assigned to a guest, or used for creating further pools. A
+ volume is either a block device, a raw file, or a special format
+ file.
+ </li><li>
+ <strong>Pool</strong> - provides a means for taking a chunk
+ of storage and carving it up into volumes. A pool can be used to
+ manage things such as a physical disk, a NFS server, a iSCSI target,
+ a host adapter, an LVM group.
+ </li></ol>
+ <p>
+ These two concepts are mapped through to two libvirt objects, a
+ <code>virStorageVolPtr</code> and a <code>virStoragePoolPtr</code>,
+ each with a collection of APIs for their management.
+ </p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="active" href="intro.html">Architecture</a>
+ <ul class="l2"><li>
+ <a title="Managing virtual machines" class="inactive" href="archdomain.html">Domains</a>
+ </li><li>
+ <a title="Providing isolated networks and NAT based network connectivity" class="inactive" href="archnetwork.html">Network</a>
+ </li><li>
+ <span class="active">Storage</span>
+ </li><li>
+ <a title="Enumerating host node devices" class="inactive" href="archnode.html">Node Devices</a>
+ </li></ul>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Storage management architecture</h1>
+
+ <p>
+ The storage management APIs are based around 2 core concepts
+ </p>
+ <ol>
+ <li>
+ <strong>Volume</strong> - a single storage volume which can
+ be assigned to a guest, or used for creating further pools. A
+ volume is either a block device, a raw file, or a special format
+ file.
+ </li>
+ <li>
+ <strong>Pool</strong> - provides a means for taking a chunk
+ of storage and carving it up into volumes. A pool can be used to
+ manage things such as a physical disk, a NFS server, a iSCSI target,
+ a host adapter, an LVM group.
+ </li>
+ </ol>
+
+ <p>
+ These two concepts are mapped through to two libvirt objects, a
+ <code>virStorageVolPtr</code> and a <code>virStoragePoolPtr</code>,
+ each with a collection of APIs for their management.
+ </p>
+
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Access control</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Access control</h1><p>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from auth.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Access control</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Access control</h1>
+ <p>
When connecting to libvirt, some connections may require client
authentication before allowing use of the APIs. The set of possible
authentication mechanisms is administrator controlled, independent
of applications using libvirt.
-</p><ul><li><a href="#ACL_server_config">Server configuration</a></li>
- <li><a href="#ACL_server_unix_perms">UNIX socket permissions/group</a></li>
- <li><a href="#ACL_server_polkit">UNIX socket PolicyKit auth</a></li>
- <li><a href="#ACL_server_username">Username/password auth</a></li>
- <li><a href="#ACL_server_kerberos">Kerberos auth</a></li>
-</ul><h3 name="ACL_server_config">Server configuration</h3><p>
+</p>
+ <ul><li>
+ <a href="#ACL_server_config">Server configuration</a>
+ </li><li>
+ <a href="#ACL_server_unix_perms">UNIX socket permissions/group</a>
+ </li><li>
+ <a href="#ACL_server_polkit">UNIX socket PolicyKit auth</a>
+ </li><li>
+ <a href="#ACL_server_username">Username/password auth</a>
+ </li><li>
+ <a href="#ACL_server_kerberos">Kerberos auth</a>
+ </li></ul>
+ <h3>
+ <a name="ACL_server_config" id="ACL_server_config">Server configuration</a>
+ </h3>
+ <p>
The libvirt daemon allows the administrator to choose the authentication
mechanisms used for client connections on each network socket independently.
This is primarily controlled via the libvirt daemon master config file in
currently a choice of <code>none</code>, <code>polkit</code>, and <code>sasl</code>.
The SASL scheme can be further configured to choose between a large
number of different mechanisms.
-</p><h3 name="ACL_server_unix_perms">UNIX socket permissions/group</h3><p>
+</p>
+ <h3>
+ <a name="ACL_server_unix_perms" id="ACL_server_unix_perms">UNIX socket permissions/group</a>
+ </h3>
+ <p>
If libvirt does not contain support for PolicyKit, then access control for
the UNIX domain socket is done using traditional file user/group ownership
and permissions. There are 2 sockets, one for full read-write access, the
other for read-only access. The RW socket will be restricted (mode 0700) to
only allow the <code>root</code> user to connect. The read-only socket will
be open access (mode 0777) to allow any user to connect.
-</p><p>
+</p>
+ <p>
To allow non-root users greater access, the <code>libvirtd.conf</code> file
can be edited to change the permissions via the <code>unix_sock_rw_perms</code>,
config parameter and to set a user group via the <code>unix_sock_group</code>
parameter. For example, setting the former to mode <code>0770</code> and the
latter <code>wheel</code> would let any user in the wheel group connect to
the libvirt daemon.
-</p><h3 name="ACL_server_polkit">UNIX socket PolicyKit auth</h3><p>
+</p>
+ <h3>
+ <a name="ACL_server_polkit" id="ACL_server_polkit">UNIX socket PolicyKit auth</a>
+ </h3>
+ <p>
If libvirt contains support for PolicyKit, then access control options are
more advanced. The <code>unix_sock_auth</code> parameter will default to
<code>polkit</code>, and the file permissions will default to <code>0777</code>
session to authenticate using the user's password. This is akin to <code>sudo</code>
auth, but does not require that the client application ultimately run as root.
Default policy will still allow any application to connect to the RO socket.
-</p><p>
+</p>
+ <p>
The default policy can be overridden by the administrator using the PolicyKit
master configuration file in <code>/etc/PolicyKit/PolicyKit.conf</code>. The
<code>PolicyKit.conf(5)</code> manual page provides details on the syntax
available. The two libvirt daemon actions available are named <code>org.libvirt.unix.monitor</code>
for the RO socket, and <code>org.libvirt.unix.manage</code> for the RW socket.
-</p><p>
+</p>
+ <p>
As an example, to allow a user <code>fred</code>full access to the RW socket,
while requiring <code>joe</code> to authenticate with the admin password,
would require adding the following snippet to <code>PolicyKit.conf</code>.
-</p><pre>
+</p>
+ <pre>
<match action="org.libvirt.unix.manage" user="fred">
<return result="yes"/>
</match>
<match action="org.libvirt.unix.manage" user="joe">
<return result="auth_admin"/>
</match>
-</pre><h3 name="ACL_server_username">Username/password auth</h3><p>
+</pre>
+ <h3>
+ <a name="ACL_server_username" id="ACL_server_username">Username/password auth</a>
+ </h3>
+ <p>
The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
username+password style authentication. It also provides for encryption of the data
socket. If desired the UNIX socket and TLS socket can also have SASL enabled by
setting the <code>auth_unix_ro</code>, <code>auth_unix_rw</code>, <code>auth_tls</code>
config params in <code>libvirt.conf</code>.
-</p><p>
+</p>
+ <p>
Out of the box, no user accounts are defined, so no clients will be able to authenticate
on the TCP socket. Adding users and setting their passwords is done with the <code>saslpasswd2</code>
command. When running this command it is important to tell it that the appname is <code>libvirt</code>.
As an example, to add a user <code>fred</code>, run
-</p><pre>
+</p>
+ <pre>
# saslpasswd2 -a libvirt fred
Password: xxxxxx
Again (for verification): xxxxxx
-</pre><p>
+</pre>
+ <p>
To see a list of all accounts the <code>sasldblistusers2</code> command can be used.
This command expects to be given the path to the libvirt user database, which is kept
in <code>/etc/libvirt/passwd.db</code>
-</p><pre>
+</p>
+ <pre>
# sasldblistusers2 -f /etc/libvirt/passwd.db
fred@t60wlan.home.berrange.com: userPassword
-</pre><p>
+</pre>
+ <p>
Finally, to disable a user's access, the <code>saslpasswd2</code> command can be used
again:
-</p><pre>
+</p>
+ <pre>
# saslpasswd2 -a libvirt -d fred
-</pre><h3 name="ACL_server_kerberos">Kerberos auth</h3><p>
+</pre>
+ <h3>
+ <a name="ACL_server_kerberos" id="ACL_server_kerberos">Kerberos auth</a>
+ </h3>
+ <p>
The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
username+password style authentication. To enable Kerberos single-sign-on instead,
instead of the default <code>digest-md5</code>. If SASL is enabled on the UNIX
and/or TLS sockets, Kerberos will also be used for them. Like DIGEST-MD5, the Kerberos
mechanism provides data encryption of the session.
-</p><p>
+</p>
+ <p>
Some operating systems do not install the SASL kerberos plugin by default. It
may be necessary to install a sub-package such as <code>cyrus-sasl-gssapi</code>.
To check whether the Kerberos plugin is installed run the <code>pluginviewer</code>
program and verify that <code>gssapi</code> is listed,eg:
-</p><pre>
+</p>
+ <pre>
# pluginviewer
...snip...
Plugin "gssapiv2" [loaded], API version: 4
SASL mechanism: GSSAPI, best SSF: 56
security flags: NO_ANONYMOUS|NO_PLAINTEXT|NO_ACTIVE|PASS_CREDENTIALS|MUTUAL_AUTH
features: WANT_CLIENT_FIRST|PROXY_AUTHENTICATION|NEED_SERVER_FQDN
-</pre><p>
+</pre>
+ <p>
Next is is necessary for the administrator of the Kerberos realm to issue a principle
for the libvirt server. There needs to be one principle per host running the libvirt
daemon. The principle should be named <code>libvirt/full.hostname@KERBEROS.REALM</code>.
server, though some Kerberos servers have alternate ways of setting up service principles.
Once created, the principle should be exported to a keytab, copied to the host running
the libvirt daemon and placed in <code>/etc/libvirt/krb5.tab</code>
-</p><pre>
+</p>
+ <pre>
# kadmin.local
kadmin.local: add_principal libvirt/foo.example.com
Enter password for principal "libvirt/foo.example.com@EXAMPLE.COM":
# scp /root/libvirt-foo-example.tab root@foo.example.com:/etc/libvirt/krb5.tab
# rm /root/libvirt-foo-example.tab
-</pre><p>
+</pre>
+ <p>
Any client application wishing to connect to a Kerberos enabled libvirt server
merely needs to run <code>kinit</code> to gain a user principle. This may well
be done automatically when a user logs into a desktop session, if PAM is setup
to authenticate against Kerberos.
-</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+</p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="active" href="deployment.html">Deployment</a>
+ <ul class="l2"><li>
+ <a title="The URI formats used for connecting to libvirt" class="inactive" href="uri.html">URI format</a>
+ </li><li>
+ <a title="Enable remote access over TCP" class="inactive" href="remote.html">Remote access</a>
+ </li><li>
+ <span class="active">Authentication</span>
+ </li><li>
+ <a title="Access the libvirt daemon from a native Windows client" class="inactive" href="windows.html">Windows port</a>
+ </li></ul>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1 >Access control</h1>
+ <p>
+When connecting to libvirt, some connections may require client
+authentication before allowing use of the APIs. The set of possible
+authentication mechanisms is administrator controlled, independent
+of applications using libvirt.
+</p>
+ <ul>
+ <li>
+ <a href="#ACL_server_config">Server configuration</a>
+ </li>
+ <li>
+ <a href="#ACL_server_unix_perms">UNIX socket permissions/group</a>
+ </li>
+ <li>
+ <a href="#ACL_server_polkit">UNIX socket PolicyKit auth</a>
+ </li>
+ <li>
+ <a href="#ACL_server_username">Username/password auth</a>
+ </li>
+ <li>
+ <a href="#ACL_server_kerberos">Kerberos auth</a>
+ </li>
+ </ul>
+ <h3><a name="ACL_server_config">Server configuration</a></h3>
+ <p>
+The libvirt daemon allows the administrator to choose the authentication
+mechanisms used for client connections on each network socket independently.
+This is primarily controlled via the libvirt daemon master config file in
+<code>/etc/libvirt/libvirtd.conf</code>. Each of the libvirt sockets can
+have its authentication mechanism configured independently. There is
+currently a choice of <code>none</code>, <code>polkit</code>, and <code>sasl</code>.
+The SASL scheme can be further configured to choose between a large
+number of different mechanisms.
+</p>
+ <h3><a name="ACL_server_unix_perms">UNIX socket permissions/group</a></h3>
+ <p>
+If libvirt does not contain support for PolicyKit, then access control for
+the UNIX domain socket is done using traditional file user/group ownership
+and permissions. There are 2 sockets, one for full read-write access, the
+other for read-only access. The RW socket will be restricted (mode 0700) to
+only allow the <code>root</code> user to connect. The read-only socket will
+be open access (mode 0777) to allow any user to connect.
+</p>
+ <p>
+To allow non-root users greater access, the <code>libvirtd.conf</code> file
+can be edited to change the permissions via the <code>unix_sock_rw_perms</code>,
+config parameter and to set a user group via the <code>unix_sock_group</code>
+parameter. For example, setting the former to mode <code>0770</code> and the
+latter <code>wheel</code> would let any user in the wheel group connect to
+the libvirt daemon.
+</p>
+ <h3><a name="ACL_server_polkit">UNIX socket PolicyKit auth</a></h3>
+ <p>
+If libvirt contains support for PolicyKit, then access control options are
+more advanced. The <code>unix_sock_auth</code> parameter will default to
+<code>polkit</code>, and the file permissions will default to <code>0777</code>
+even on the RW socket. Upon connecting to the socket, the client application
+will be required to identify itself with PolicyKit. The default policy for the
+RW daemon socket will require any application running in the current desktop
+session to authenticate using the user's password. This is akin to <code>sudo</code>
+auth, but does not require that the client application ultimately run as root.
+Default policy will still allow any application to connect to the RO socket.
+</p>
+ <p>
+The default policy can be overridden by the administrator using the PolicyKit
+master configuration file in <code>/etc/PolicyKit/PolicyKit.conf</code>. The
+<code>PolicyKit.conf(5)</code> manual page provides details on the syntax
+available. The two libvirt daemon actions available are named <code>org.libvirt.unix.monitor</code>
+for the RO socket, and <code>org.libvirt.unix.manage</code> for the RW socket.
+</p>
+ <p>
+As an example, to allow a user <code>fred</code>full access to the RW socket,
+while requiring <code>joe</code> to authenticate with the admin password,
+would require adding the following snippet to <code>PolicyKit.conf</code>.
+</p>
+ <pre>
+ <match action="org.libvirt.unix.manage" user="fred">
+ <return result="yes"/>
+ </match>
+ <match action="org.libvirt.unix.manage" user="joe">
+ <return result="auth_admin"/>
+ </match>
+</pre>
+ <h3><a name="ACL_server_username">Username/password auth</a></h3>
+ <p>
+The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
+The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
+username+password style authentication. It also provides for encryption of the data
+stream, so the security of the plain TCP socket is on a par with that of the TLS
+socket. If desired the UNIX socket and TLS socket can also have SASL enabled by
+setting the <code>auth_unix_ro</code>, <code>auth_unix_rw</code>, <code>auth_tls</code>
+config params in <code>libvirt.conf</code>.
+</p>
+ <p>
+Out of the box, no user accounts are defined, so no clients will be able to authenticate
+on the TCP socket. Adding users and setting their passwords is done with the <code>saslpasswd2</code>
+command. When running this command it is important to tell it that the appname is <code>libvirt</code>.
+As an example, to add a user <code>fred</code>, run
+</p>
+ <pre>
+# saslpasswd2 -a libvirt fred
+Password: xxxxxx
+Again (for verification): xxxxxx
+</pre>
+ <p>
+To see a list of all accounts the <code>sasldblistusers2</code> command can be used.
+This command expects to be given the path to the libvirt user database, which is kept
+in <code>/etc/libvirt/passwd.db</code>
+</p>
+ <pre>
+# sasldblistusers2 -f /etc/libvirt/passwd.db
+fred@t60wlan.home.berrange.com: userPassword
+</pre>
+ <p>
+Finally, to disable a user's access, the <code>saslpasswd2</code> command can be used
+again:
+</p>
+ <pre>
+# saslpasswd2 -a libvirt -d fred
+</pre>
+ <h3><a name="ACL_server_kerberos">Kerberos auth</a></h3>
+ <p>
+The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
+The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
+username+password style authentication. To enable Kerberos single-sign-on instead,
+the libvirt SASL configuration file must be changed. This is <code>/etc/sasl2/libvirt.conf</code>.
+The <code>mech_list</code> parameter must first be changed to <code>gssapi</code>
+instead of the default <code>digest-md5</code>. If SASL is enabled on the UNIX
+and/or TLS sockets, Kerberos will also be used for them. Like DIGEST-MD5, the Kerberos
+mechanism provides data encryption of the session.
+</p>
+ <p>
+Some operating systems do not install the SASL kerberos plugin by default. It
+may be necessary to install a sub-package such as <code>cyrus-sasl-gssapi</code>.
+To check whether the Kerberos plugin is installed run the <code>pluginviewer</code>
+program and verify that <code>gssapi</code> is listed,eg:
+</p>
+ <pre>
+# pluginviewer
+...snip...
+Plugin "gssapiv2" [loaded], API version: 4
+ SASL mechanism: GSSAPI, best SSF: 56
+ security flags: NO_ANONYMOUS|NO_PLAINTEXT|NO_ACTIVE|PASS_CREDENTIALS|MUTUAL_AUTH
+ features: WANT_CLIENT_FIRST|PROXY_AUTHENTICATION|NEED_SERVER_FQDN
+</pre>
+ <p>
+Next is is necessary for the administrator of the Kerberos realm to issue a principle
+for the libvirt server. There needs to be one principle per host running the libvirt
+daemon. The principle should be named <code>libvirt/full.hostname@KERBEROS.REALM</code>.
+This is typically done by running the <code>kadmin.local</code> command on the Kerberos
+server, though some Kerberos servers have alternate ways of setting up service principles.
+Once created, the principle should be exported to a keytab, copied to the host running
+the libvirt daemon and placed in <code>/etc/libvirt/krb5.tab</code>
+</p>
+ <pre>
+# kadmin.local
+kadmin.local: add_principal libvirt/foo.example.com
+Enter password for principal "libvirt/foo.example.com@EXAMPLE.COM":
+Re-enter password for principal "libvirt/foo.example.com@EXAMPLE.COM":
+Principal "libvirt/foo.example.com@EXAMPLE.COM" created.
+
+kadmin.local: ktadd -k /root/libvirt-foo-example.tab libvirt/foo.example.com@EXAMPLE.COM
+Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type Triple DES cbc mode with HMAC/sha1 added to keytab WRFILE:/root/libvirt-foo-example.tab.
+Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type ArcFour with HMAC/md5 added to keytab WRFILE:/root/libvirt-foo-example.tab.
+Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type DES with HMAC/sha1 added to keytab WRFILE:/root/libvirt-foo-example.tab.
+Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type DES cbc mode with RSA-MD5 added to keytab WRFILE:/root/libvirt-foo-example.tab.
+
+kadmin.local: quit
+
+# scp /root/libvirt-foo-example.tab root@foo.example.com:/etc/libvirt/krb5.tab
+# rm /root/libvirt-foo-example.tab
+</pre>
+ <p>
+Any client application wishing to connect to a Kerberos enabled libvirt server
+merely needs to run <code>kinit</code> to gain a user principle. This may well
+be done automatically when a user logs into a desktop session, if PAM is setup
+to authenticate against Kerberos.
+</p>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from bindings.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Bindings for other languages</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Bindings for other languages</h1>
+ <p>Libvirt comes with bindings to support other languages than
+pure C. First the headers embeds the necessary declarations to
+allow direct acces from C++ code, but also we have bindings for
+higher level kind of languages:</p>
+ <ul><li>Python: Libvirt comes with direct support for the Python language
+ (just make sure you installed the libvirt-python package if not
+ compiling from sources). See below for more information about
+ using libvirt with python</li><li>Perl: Daniel Berrange provides <a href="http://search.cpan.org/dist/Sys-Virt/">bindings for
+ Perl</a>.</li><li>OCaml: Richard Jones supplies <a href="http://libvirt.org/ocaml/">bindings for OCaml</a>.</li><li>Ruby: David Lutterkort provides <a href="http://libvirt.org/ruby/">bindings for Ruby</a>.</li></ul>
+ <p>Support, requests or help for libvirt bindings are welcome on
+the <a href="https://www.redhat.com/mailman/listinfo/libvir-list/">mailing
+list</a>, as usual try to provide enough background information
+and make sure you use recent version, see the <a href="bugs.html">help
+page</a>.</p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <span class="active">Language bindings</span>
+ <ul class="l2"><li>
+ <a title="overview of the python API bindings" class="inactive" href="python.html">Python</a>
+ </li></ul>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1 >Bindings for other languages</h1>
+ <p>Libvirt comes with bindings to support other languages than
+pure C. First the headers embeds the necessary declarations to
+allow direct acces from C++ code, but also we have bindings for
+higher level kind of languages:</p>
+ <ul>
+ <li>Python: Libvirt comes with direct support for the Python language
+ (just make sure you installed the libvirt-python package if not
+ compiling from sources). See below for more information about
+ using libvirt with python</li>
+ <li>Perl: Daniel Berrange provides <a href="http://search.cpan.org/dist/Sys-Virt/">bindings for
+ Perl</a>.</li>
+ <li>OCaml: Richard Jones supplies <a href="http://libvirt.org/ocaml/">bindings for OCaml</a>.</li>
+ <li>Ruby: David Lutterkort provides <a href="http://libvirt.org/ruby/">bindings for Ruby</a>.</li>
+ </ul>
+ <p>Support, requests or help for libvirt bindings are welcome on
+the <a href="https://www.redhat.com/mailman/listinfo/libvir-list/">mailing
+list</a>, as usual try to provide enough background information
+and make sure you use recent version, see the <a href="bugs.html">help
+page</a>.</p>
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reporting bugs and getting help</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reporting bugs and getting help</h1><p>There is a mailing-list <a href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a> for libvirt,
-with an <a href="https://www.redhat.com/archives/libvir-list/">on-line
-archive</a>. Please subscribe to this list before posting by visiting the <a href="https://www.redhat.com/mailman/listinfo/libvir-list">associated Web</a>
-page and follow the instructions. Patches with explanations and provided as
-attachments are really appreciated and will be discussed on the mailing list.
-If possible generate the patches by using cvs diff -u in a CVS checkout.</p><p>We use Red Hat Bugzilla to track bugs and new feature requests to libvirt.
-If you want to report a bug or ask for a feature, please check <a href="http://bugzilla.redhat.com/bugzilla/buglist.cgi?component=libvirt&component=libvirt-devel&component=libvirt-python&bug_status=ASSIGNED&bug_status=INVESTIGATE&bug_status=NEW&bug_status=REOPENED&bug_status=VERIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr&long_desc=&Search=Search">the existing open bugs</a>, then if yours isn't a duplicate of
-an existing bug:</p><ul><li>If you are using official binaries from Fedora: <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&component=libvirt">log a new bug for Fedora</a></li>
-<li>If you are using official binaries from Red Hat Enterprise Linux 5: <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&component=Red%20Hat%20Enterprise%20Linux%205">log a new bug for RHEL</a></li>
-<li>Otherwise: <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&component=Virtualization%20Tools">log a new bug here</a></li>
-</ul><p> Don't forget to attach any patch or extra data that you may have available. It is always a good idea to also
-to post to the <a href="mailto:libvir-list@redhat.com">mailing-list</a>
-too, so that everybody working on the project can see it, thanks !</p><p>Some of the libvirt developers may be found on IRC on the OFTC
-network. Use the settings:</p><ul><li>server: irc.oftc.net</li>
- <li>port: 6667 (the usual IRC port)</li>
- <li>channel: #virt</li>
-</ul><p> But there is no guarantee that someone will be watching or able to reply,
-use the mailing-list if you don't get an answer there.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from bugs.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Bug reporting</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Bug reporting</h1>
+ <p>
+ The <a href="http://bugzilla.redhat.com">Red Hat Bugzilla Server</a>
+ should be used to report bugs and request features against libvirt.
+ Before submitting a ticket, check the existing tickets to see if
+ the bug/feature is already tracked.
+ </p>
+ <h2>General libvirt bug reports</h2>
+ <p>
+ If you are using official libvirt binaries from a Linux distribution
+ check below for distribution specific bug reporting policies first.
+ For general libvirt bug reports, from self-built releases, CVS snapshots
+ and any other non-distribution supported builds, enter tickets under
+ the <code>Virtualization Tools</code> product and the <code>libvirt</code>
+ component.
+ </p>
+ <ul><li><a href="">View libvirt tickets</a></li><li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Virtualization%20Tools&component=libvirt">New libvirt ticket</a></li></ul>
+ <h2>Linux Distribution specific bug reports</h2>
+ <ul><li>
+ If you are using official binaries from a <strong>Fedora distribution</strong>, enter
+ tickets against the <code>Fedora</code> product and the <code>libvirt</code>
+ component.
+ <ul><li><a href="">View Fedora libvirt tickets</a></li><li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&component=libvirt">New Fedora libvirt ticket</a></li></ul></li><li>
+ If you are using official binaries from <strong>Red Hat Enterprise Linux distribution</strong>,
+ tickets against the <code>Red Hat Enterprise Linux 5</code> product and
+ the <code>libvirt</code> component.
+ <ul><li><a href="">View Red Hat Enterprise Linux libvirt tickets</a></li><li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Red%20Hat%20Enterprise%20Linux%205&component=libvirt">New Red Hat Enterprise Linux libvirt ticket</a></li></ul></li><li>
+ If you are using official binaries from another Linux distribution first
+ follow their own bug reporting guidelines.
+ </li></ul>
+ <h2>How to file high quality bug reports</h2>
+ <p>
+ To increase the likelihood of your bug report being addressed it is
+ important to provide as much information as possible. When filing
+ libvirt bugs use this checklist to see if you are providing enough
+ information:
+ </p>
+ <ul><li>The version number of the libvirt build, or date of the CVS
+ checkout</li><li>The hardware architecture being used</li><li>The name of the hypervisor (Xen, QEMU, KVM)</li><li>The XML config of the guest domain if relevant</li><li>For Xen hypervisor, the XenD logfile from /var/log/xen</li><li>For QEMU/KVM, the domain logfile from /var/log/libvirt/qemu</li></ul>
+ <p>
+ If requesting a new feature attach any available patch to the ticket
+ and also email the patch to the libvirt mailing list for discussion
+ </p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <span class="active">Bug reports</span>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+
+ <h1>Bug reporting</h1>
+
+ <p>
+ The <a href="http://bugzilla.redhat.com">Red Hat Bugzilla Server</a>
+ should be used to report bugs and request features against libvirt.
+ Before submitting a ticket, check the existing tickets to see if
+ the bug/feature is already tracked.
+ </p>
+
+ <h2>General libvirt bug reports</h2>
+
+ <p>
+ If you are using official libvirt binaries from a Linux distribution
+ check below for distribution specific bug reporting policies first.
+ For general libvirt bug reports, from self-built releases, CVS snapshots
+ and any other non-distribution supported builds, enter tickets under
+ the <code>Virtualization Tools</code> product and the <code>libvirt</code>
+ component.
+ </p>
+
+ <ul>
+ <li><a href="">View libvirt tickets</a></li>
+ <li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Virtualization%20Tools&component=libvirt">New libvirt ticket</a></li>
+ </ul>
+
+ <h2>Linux Distribution specific bug reports</h2>
+ <ul>
+ <li>
+ If you are using official binaries from a <strong>Fedora distribution</strong>, enter
+ tickets against the <code>Fedora</code> product and the <code>libvirt</code>
+ component.
+ <ul>
+ <li><a href="">View Fedora libvirt tickets</a></li>
+ <li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&component=libvirt">New Fedora libvirt ticket</a></li>
+ </ul>
+ </li>
+ <li>
+ If you are using official binaries from <strong>Red Hat Enterprise Linux distribution</strong>,
+ tickets against the <code>Red Hat Enterprise Linux 5</code> product and
+ the <code>libvirt</code> component.
+ <ul>
+ <li><a href="">View Red Hat Enterprise Linux libvirt tickets</a></li>
+ <li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Red%20Hat%20Enterprise%20Linux%205&component=libvirt">New Red Hat Enterprise Linux libvirt ticket</a></li>
+ </ul>
+ </li>
+ <li>
+ If you are using official binaries from another Linux distribution first
+ follow their own bug reporting guidelines.
+ </li>
+ </ul>
+
+
+ <h2>How to file high quality bug reports</h2>
+
+ <p>
+ To increase the likelihood of your bug report being addressed it is
+ important to provide as much information as possible. When filing
+ libvirt bugs use this checklist to see if you are providing enough
+ information:
+ </p>
+
+ <ul>
+ <li>The version number of the libvirt build, or date of the CVS
+ checkout</li>
+ <li>The hardware architecture being used</li>
+ <li>The name of the hypervisor (Xen, QEMU, KVM)</li>
+ <li>The XML config of the guest domain if relevant</li>
+ <li>For Xen hypervisor, the XenD logfile from /var/log/xen</li>
+ <li>For QEMU/KVM, the domain logfile from /var/log/libvirt/qemu</li>
+ </ul>
+
+ <p>
+ If requesting a new feature attach any available patch to the ticket
+ and also email the patch to the libvirt mailing list for discussion
+ </p>
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from contact.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Contacting the development team</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Contacting the development team</h1>
+ <h2>Mailing list</h2>
+ <p>
+ There is a mailing-list <a href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a> for libvirt,
+ with an <a href="https://www.redhat.com/archives/libvir-list/">on-line archive</a>.
+ Please subscribe to this list before posting by visiting the
+ <a href="https://www.redhat.com/mailman/listinfo/libvir-list">associated Web</a>
+ page and follow the instructions. Patches with explanations and provided as
+ attachments are really appreciated and will be discussed on the mailing list.
+ If possible generate the patches by using <code>cvs diff -up</code> in a CVS
+ checkout.
+ </p>
+ <h2>IRC discussion</h2>
+ <p>
+ Some of the libvirt developers may be found on IRC on the <a href="http://oftc.net">OFTC IRC</a>
+ network. Use the settings:
+ </p>
+ <ul><li>server: irc.oftc.net</li><li>port: 6667 (the usual IRC port)</li><li>channel: #virt</li></ul>
+ <p>
+ NB There is no guarantee that someone will be watching or able to reply
+ promptly, so use the mailing-list if you don't get an answer on the IRC
+ channel.
+ </p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <span class="active">Contact</span>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1>Contacting the development team</h1>
+
+ <h2>Mailing list</h2>
+
+ <p>
+ There is a mailing-list <a href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a> for libvirt,
+ with an <a href="https://www.redhat.com/archives/libvir-list/">on-line archive</a>.
+ Please subscribe to this list before posting by visiting the
+ <a href="https://www.redhat.com/mailman/listinfo/libvir-list">associated Web</a>
+ page and follow the instructions. Patches with explanations and provided as
+ attachments are really appreciated and will be discussed on the mailing list.
+ If possible generate the patches by using <code>cvs diff -up</code> in a CVS
+ checkout.
+ </p>
+
+ <h2>IRC discussion</h2>
+
+ <p>
+ Some of the libvirt developers may be found on IRC on the <a href="http://oftc.net">OFTC IRC</a>
+ network. Use the settings:
+ </p>
+ <ul>
+ <li>server: irc.oftc.net</li>
+ <li>port: 6667 (the usual IRC port)</li>
+ <li>channel: #virt</li>
+ </ul>
+ <p>
+ NB There is no guarantee that someone will be watching or able to reply
+ promptly, so use the mailing-list if you don't get an answer on the IRC
+ channel.
+ </p>
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from deployment.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Deployment</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Deployment</h1>
+ <h2>Pre-packaged releases</h2>
+ <p>
+ The libvirt API is now available in all major Linux distributions
+ so the simplest deployment approach is to use your distributions'
+ package management software to install the <code>libvirt</code>
+ module.
+ </p>
+ <h2>Self-built releases</h2>
+ <p>
+ libvirt uses GNU autotools for its build system, so deployment
+ follows the usual process of <code>configure; make ; make install</code>
+ </p>
+ <pre>
+
+ # ./configure --prefix=$HOME/usr
+ # make
+ # make install
+ </pre>
+ <h2>Built from CVS / GIT</h2>
+ <p>
+ When building from CVS it is neccessary to generate the autotools
+ support files. This requires having <code>autoconf</code>,
+ <code>automake</code>, <code>libtool</code> and <code>intltool</code>
+ installed. The process can be automated with the <code>autogen.sh</code>
+ script.
+ </p>
+ <pre>
+
+ # ./autogen.sh --prefix=$HOME/usr
+ # make
+ # make install
+ </pre>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <span class="active">Deployment</span>
+ <ul class="l2"><li>
+ <a title="The URI formats used for connecting to libvirt" class="inactive" href="uri.html">URI format</a>
+ </li><li>
+ <a title="Enable remote access over TCP" class="inactive" href="remote.html">Remote access</a>
+ </li><li>
+ <a title="Configure authentication for the libvirt daemon" class="inactive" href="auth.html">Authentication</a>
+ </li><li>
+ <a title="Access the libvirt daemon from a native Windows client" class="inactive" href="windows.html">Windows port</a>
+ </li></ul>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Deployment</h1>
+
+ <h2>Pre-packaged releases</h2>
+
+ <p>
+ The libvirt API is now available in all major Linux distributions
+ so the simplest deployment approach is to use your distributions'
+ package management software to install the <code>libvirt</code>
+ module.
+ </p>
+
+ <h2>Self-built releases</h2>
+
+ <p>
+ libvirt uses GNU autotools for its build system, so deployment
+ follows the usual process of <code>configure; make ; make install</code>
+ </p>
+
+ <pre>
+
+ # ./configure --prefix=$HOME/usr
+ # make
+ # make install
+ </pre>
+
+ <h2>Built from CVS / GIT</h2>
+
+ <p>
+ When building from CVS it is neccessary to generate the autotools
+ support files. This requires having <code>autoconf</code>,
+ <code>automake</code>, <code>libtool</code> and <code>intltool</code>
+ installed. The process can be automated with the <code>autogen.sh</code>
+ script.
+ </p>
+
+ <pre>
+
+ # ./autogen.sh --prefix=$HOME/usr
+ # make
+ # make install
+ </pre>
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from docs.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Documentation</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Documentation</h1>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <span class="active">Documentation</span>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Documentation</h1>
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Downloads</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Downloads</h1><p>The latest versions of libvirt can be found on the <a href="ftp://libvirt.org/libvirt/">libvirt.org</a> server ( <a href="http://libvirt.org/sources/">HTTP</a>, <a href="ftp://libvirt.org/libvirt/">FTP</a>). You will find there the released
-versions as well as <a href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">snapshot
-tarballs</a> updated from CVS head every hour</p><p>Anonymous <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a> is also
-available, first register onto the server:</p><p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login</code></p><p>it will request a password, enter <strong>anoncvs</strong>. Then you can
-checkout the development tree with:</p><p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co
-libvirt</code></p><p>Use ./autogen.sh to configure the local checkout, then <code>make</code>
-and <code>make install</code>, as usual. All normal cvs commands are now
-available except commiting to the base.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from downloads.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Downloads</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Downloads</h1>
+ <h2>Official Releases</h2>
+ <p>
+ The latest versions of the libvirt C library can be downloaded from:
+ </p>
+ <ul><li><a href="ftp://libvirt.org/libvirt/">libvirt.org FTP server</a></li><li><a href="http://libvirt.org/sources/">libvirt.org HTTP server</a></li></ul>
+ <h2>Hourly development snapshots</h2>
+ <p>
+ Once an hour, an automated snapshot is made from the latest CVS server
+ source tree. These snapshots should be usable, but we make no guarentees
+ about their stability:
+ </p>
+ <ul><li><a href="ftp://libvirt.org/libvirt/libvirt-cvs-snapshot.tar.gz">libvirt.org FTP server</a></li><li><a href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">libvirt.org HTTP server</a></li></ul>
+ <h2>CVS repository access</h2>
+ <p>
+ The master source repository uses <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a>
+ and anonymous access is provided. Prior to accessing the server is it neccessary
+ to authenticate using the password <code>anoncvs</code>. This can be accomplished with the
+ <code>cvs login</code> command:
+ </p>
+ <pre>
+
+ # cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login
+ </pre>
+ <p>
+ Once authenticated, a checkout can be obtained using
+ </p>
+ <pre>
+
+ # cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co libvirt
+ </pre>
+ <p>
+ The libvirt build process uses GNU autotools, so after obtaining a checkout
+ it is neccessary to generate the configure script and Makefile.in templates
+ using the <code>autogen.sh</code> command. As an example, to do a complete
+ build and install it into your home directory run:
+ </p>
+ <pre>
+
+ ./autogen.sh --prefix=$HOME/usr
+ make
+ make install
+ </pre>
+ <h2>GIT repository mirror</h2>
+ <p>
+ The CVS source repository is also mirrored using GIT, and is available
+ for anonymous access via:
+ </p>
+ <pre>
+
+ git clone git://git.et.redhat.com/libvirt.git
+ </pre>
+ <p>
+ It can also be browsed at
+ </p>
+ <pre>
+
+ <a href="http://git.et.redhat.com/?p=libvirt.git;a=summary">http://git.et.redhat.com/?p=libvirt.git;a=summary</a>
+ </pre>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <span class="active">Downloads</span>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1 >Downloads</h1>
+
+ <h2>Official Releases</h2>
+
+ <p>
+ The latest versions of the libvirt C library can be downloaded from:
+ </p>
+
+ <ul>
+ <li><a href="ftp://libvirt.org/libvirt/">libvirt.org FTP server</a></li>
+ <li><a href="http://libvirt.org/sources/">libvirt.org HTTP server</a></li>
+ </ul>
+
+ <h2>Hourly development snapshots</h2>
+
+ <p>
+ Once an hour, an automated snapshot is made from the latest CVS server
+ source tree. These snapshots should be usable, but we make no guarentees
+ about their stability:
+ </p>
+
+ <ul>
+ <li><a href="ftp://libvirt.org/libvirt/libvirt-cvs-snapshot.tar.gz">libvirt.org FTP server</a></li>
+ <li><a href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">libvirt.org HTTP server</a></li>
+ </ul>
+
+ <h2>CVS repository access</h2>
+
+ <p>
+ The master source repository uses <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a>
+ and anonymous access is provided. Prior to accessing the server is it neccessary
+ to authenticate using the password <code>anoncvs</code>. This can be accomplished with the
+ <code>cvs login</code> command:
+ </p>
+
+ <pre>
+
+ # cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login
+ </pre>
+
+ <p>
+ Once authenticated, a checkout can be obtained using
+ </p>
+
+ <pre>
+
+ # cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co libvirt
+ </pre>
+
+ <p>
+ The libvirt build process uses GNU autotools, so after obtaining a checkout
+ it is neccessary to generate the configure script and Makefile.in templates
+ using the <code>autogen.sh</code> command. As an example, to do a complete
+ build and install it into your home directory run:
+ </p>
+
+ <pre>
+
+ ./autogen.sh --prefix=$HOME/usr
+ make
+ make install
+ </pre>
+
+ <h2>GIT repository mirror</h2>
+
+ <p>
+ The CVS source repository is also mirrored using GIT, and is available
+ for anonymous access via:
+ </p>
+
+ <pre>
+
+ git clone git://git.et.redhat.com/libvirt.git
+ </pre>
+
+ <p>
+ It can also be browsed at
+ </p>
+
+ <pre>
+
+ <a href="http://git.et.redhat.com/?p=libvirt.git;a=summary">http://git.et.redhat.com/?p=libvirt.git;a=summary</a>
+ </pre>
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from drivers.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Internal drivers</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Internal drivers</h1>
+ <p>
+ The libvirt public API delegates its implementation to one or
+ more internal drivers, depending on the <a href="uri.html">connection URI</a>
+ passed when initializing the library. There is always a hypervisor driver
+ active, and if the libvirt daemon is available there will usually be a
+ network and storage driver active.
+ </p>
+ <h2>Hypervisor drivers</h2>
+ <p>
+ The hypervisor drivers currently supported by livirt are:
+ </p>
+ <ul><li><strong><a href="drvxen.html">Xen</a></strong></li><li><strong><a href="drvqemu.html">QEMU</a></strong></li><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></ul>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <span class="active">Drivers</span>
+ <ul class="l2"><li>
+ <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+ </li><li>
+ <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+ </li><li>
+ <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+ </li><li>
+ <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+ </li><li>
+ <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+ </li><li>
+ <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+ </li><li>
+ <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+ </li></ul>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Internal drivers</h1>
+
+ <p>
+ The libvirt public API delegates its implementation to one or
+ more internal drivers, depending on the <a href="uri.html">connection URI</a>
+ passed when initializing the library. There is always a hypervisor driver
+ active, and if the libvirt daemon is available there will usually be a
+ network and storage driver active.
+ </p>
+
+ <h2>Hypervisor drivers</h2>
+
+ <p>
+ The hypervisor drivers currently supported by livirt are:
+ </p>
+
+ <ul>
+ <li><strong><a href="drvxen.html">Xen</a></strong></li>
+ <li><strong><a href="drvqemu.html">QEMU</a></strong></li>
+ <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>
+ </ul>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from drvlxc.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: LXC container driver</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>LXC container driver</h1>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+ <ul class="l2"><li>
+ <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+ </li><li>
+ <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+ </li><li>
+ <span class="active">Linux Container</span>
+ </li><li>
+ <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+ </li><li>
+ <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+ </li><li>
+ <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+ </li><li>
+ <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+ </li></ul>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>LXC container driver</h1>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from drvopenvz.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: OpenVZ container driver</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>OpenVZ container driver</h1>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+ <ul class="l2"><li>
+ <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+ </li><li>
+ <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+ </li><li>
+ <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+ </li><li>
+ <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+ </li><li>
+ <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+ </li><li>
+ <span class="active">OpenVZ</span>
+ </li><li>
+ <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+ </li></ul>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>OpenVZ container driver</h1>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from drvqemu.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: QEMU/KVM hypervisor driver</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>QEMU/KVM hypervisor driver</h1>
+ <p>
+ The libvirt QEMU driver can manage any QEMU emulator from version 0.8.1
+ or later. It can also manage anything that provides the same QEMU command
+ line syntax and monitor interaction. This includes KVM, and Xenner.
+ </p>
+ <h2>Deployment pre-requisites</h2>
+ <ul><li>
+ <strong>QEMU emulators</strong>: The driver will probe <code>/usr/bin</code>
+ for the presence of <code>qemu</code>, <code>qemu-system-x86_64</code>,
+ <code>qemu-system-mips</code>,<code>qemu-system-mipsel</code>,
+ <code>qemu-system-sparc</code>,<code>qemu-system-ppc</code>. The results
+ of this can be seen from the capabilities XML output.
+ </li><li>
+ <strong>KVM hypervisor</strong>: The driver will probe <code>/usr/bin</code>
+ for the presence of <code>qemu-kvm</code> and <code>/dev/kvm</code> device
+ node. If both are found, then KVM fullyvirtualized, hardware accelerated
+ guests will be available.
+ </li><li>
+ <strong>Xenner hypervisor</strong>: The driver will probe <code>/usr/bin</code>
+ for the presence of <code>xenner</code> and <code>/dev/kvm</code> device
+ node. If both are found, then Xen paravirtualized guests can be run using
+ the KVM hardware acceleration.
+ </li></ul>
+ <h2>
+ <a name="xmlconfig" id="xmlconfig">Example domain XML config</a>
+ </h2>
+ <h3>QEMU emulated guest on x86_64</h3>
+ <pre><domain type='qemu'>
+ <name>QEmu-fedora-i686</name>
+ <uuid>c7a5fdbd-cdaf-9455-926a-d65c16db1809</uuid>
+ <memory>219200</memory>
+ <currentMemory>219200</currentMemory>
+ <vcpu>2</vcpu>
+ <os>
+ <type arch='i686' machine='pc'>hvm</type>
+ <boot dev='cdrom'/>
+ </os>
+ <devices>
+ <emulator>/usr/bin/qemu-system-x86_64</emulator>
+ <disk type='file' device='cdrom'>
+ <source file='/home/user/boot.iso'/>
+ <target dev='hdc'/>
+ <readonly/>
+ </disk>
+ <disk type='file' device='disk'>
+ <source file='/home/user/fedora.img'/>
+ <target dev='hda'/>
+ </disk>
+ <interface type='network'>
+ <source name='default'/>
+ </interface>
+ <graphics type='vnc' port='-1'/>
+ </devices>
+</domain></pre>
+ <h3>KVM hardware accelerated guest on i686</h3>
+ <pre><domain type='kvm'>
+ <name>demo2</name>
+ <uuid>4dea24b3-1d52-d8f3-2516-782e98a23fa0</uuid>
+ <memory>131072</memory>
+ <vcpu>1</vcpu>
+ <os>
+ <type arch="i686">hvm</type>
+ </os>
+ <clock sync="localtime"/>
+ <devices>
+ <emulator>/usr/bin/qemu-kvm</emulator>
+ <disk type='file' device='disk'>
+ <source file='/var/lib/libvirt/images/demo2.img'/>
+ <target dev='hda'/>
+ </disk>
+ <interface type='network'>
+ <source network='default'/>
+ <mac address='24:42:53:21:52:45'/>
+ </interface>
+ <graphics type='vnc' port='-1'/>
+ </devices>
+</domain></pre>
+ <h3>Xen paravirtualized guests with hardware acceleration</h3>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+ <ul class="l2"><li>
+ <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+ </li><li>
+ <span class="active">QEMU / KVM</span>
+ </li><li>
+ <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+ </li><li>
+ <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+ </li><li>
+ <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+ </li><li>
+ <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+ </li><li>
+ <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+ </li></ul>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>QEMU/KVM hypervisor driver</h1>
+
+ <p>
+ The libvirt QEMU driver can manage any QEMU emulator from version 0.8.1
+ or later. It can also manage anything that provides the same QEMU command
+ line syntax and monitor interaction. This includes KVM, and Xenner.
+ </p>
+
+ <h2>Deployment pre-requisites</h2>
+
+ <ul>
+ <li>
+ <strong>QEMU emulators</strong>: The driver will probe <code>/usr/bin</code>
+ for the presence of <code>qemu</code>, <code>qemu-system-x86_64</code>,
+ <code>qemu-system-mips</code>,<code>qemu-system-mipsel</code>,
+ <code>qemu-system-sparc</code>,<code>qemu-system-ppc</code>. The results
+ of this can be seen from the capabilities XML output.
+ </li>
+ <li>
+ <strong>KVM hypervisor</strong>: The driver will probe <code>/usr/bin</code>
+ for the presence of <code>qemu-kvm</code> and <code>/dev/kvm</code> device
+ node. If both are found, then KVM fullyvirtualized, hardware accelerated
+ guests will be available.
+ </li>
+ <li>
+ <strong>Xenner hypervisor</strong>: The driver will probe <code>/usr/bin</code>
+ for the presence of <code>xenner</code> and <code>/dev/kvm</code> device
+ node. If both are found, then Xen paravirtualized guests can be run using
+ the KVM hardware acceleration.
+ </li>
+ </ul>
+
+ <h2><a name="xmlconfig">Example domain XML config</a></h2>
+
+ <h3>QEMU emulated guest on x86_64</h3>
+
+ <pre><domain type='qemu'>
+ <name>QEmu-fedora-i686</name>
+ <uuid>c7a5fdbd-cdaf-9455-926a-d65c16db1809</uuid>
+ <memory>219200</memory>
+ <currentMemory>219200</currentMemory>
+ <vcpu>2</vcpu>
+ <os>
+ <type arch='i686' machine='pc'>hvm</type>
+ <boot dev='cdrom'/>
+ </os>
+ <devices>
+ <emulator>/usr/bin/qemu-system-x86_64</emulator>
+ <disk type='file' device='cdrom'>
+ <source file='/home/user/boot.iso'/>
+ <target dev='hdc'/>
+ <readonly/>
+ </disk>
+ <disk type='file' device='disk'>
+ <source file='/home/user/fedora.img'/>
+ <target dev='hda'/>
+ </disk>
+ <interface type='network'>
+ <source name='default'/>
+ </interface>
+ <graphics type='vnc' port='-1'/>
+ </devices>
+</domain></pre>
+
+ <h3>KVM hardware accelerated guest on i686</h3>
+
+ <pre><domain type='kvm'>
+ <name>demo2</name>
+ <uuid>4dea24b3-1d52-d8f3-2516-782e98a23fa0</uuid>
+ <memory>131072</memory>
+ <vcpu>1</vcpu>
+ <os>
+ <type arch="i686">hvm</type>
+ </os>
+ <clock sync="localtime"/>
+ <devices>
+ <emulator>/usr/bin/qemu-kvm</emulator>
+ <disk type='file' device='disk'>
+ <source file='/var/lib/libvirt/images/demo2.img'/>
+ <target dev='hda'/>
+ </disk>
+ <interface type='network'>
+ <source network='default'/>
+ <mac address='24:42:53:21:52:45'/>
+ </interface>
+ <graphics type='vnc' port='-1'/>
+ </devices>
+</domain></pre>
+
+ <h3>Xen paravirtualized guests with hardware acceleration</h3>
+
+
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from drvremote.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Remote management driver</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Remote management driver</h1>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+ <ul class="l2"><li>
+ <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+ </li><li>
+ <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+ </li><li>
+ <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+ </li><li>
+ <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+ </li><li>
+ <span class="active">Remote</span>
+ </li><li>
+ <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+ </li><li>
+ <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+ </li></ul>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Remote management driver</h1>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from drvtest.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Test "mock" driver</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Test "mock" driver</h1>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+ <ul class="l2"><li>
+ <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+ </li><li>
+ <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+ </li><li>
+ <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+ </li><li>
+ <span class="active">Test</span>
+ </li><li>
+ <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+ </li><li>
+ <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+ </li><li>
+ <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+ </li></ul>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Test "mock" driver</h1>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from drvxen.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Xen hypervisor driver</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Xen hypervisor driver</h1>
+ <p>
+ The libvirt Xen driver provides the ability to manage virtual machines
+ on any Xen release from 3.0.1 onwards.
+ </p>
+ <h2>Deployment pre-requisites</h2>
+ <p>
+ The libvirt Xen driver uses a combination of channels to manage Xen
+ virtual machines.
+ </p>
+ <ul><li>
+ <strong>XenD</strong>: Access to the Xen daemon is a mandatory
+ requirement for the libvirt Xen driver. It requires that the UNIX
+ socket interface be enabled in the <code>/etc/xen/xend-config.sxp</code>
+ configuration file. Specifically the config settings
+ <code>(xend-unix-server yes)</code>. This path is usually restricted
+ to only allow the <code>root</code> user access. As an alternative,
+ the HTTP interface can be used, however, this has significant security
+ implications.
+ </li><li>
+ <strong>XenStoreD</strong>: Access to the Xenstore daemon enables
+ more efficient codepaths for looking up domain information which
+ lowers the CPU overhead of management.
+ </li><li>
+ <strong>Hypercalls</strong>: The ability to make direct hypercalls
+ allows the most efficient codepaths in the driver to be used for
+ monitoring domain status.
+ </li><li>
+ <strong>XM config</strong>: When using Xen releases prior to 3.0.4,
+ there is no inactive domain management in XenD. For such releases,
+ libvirt will automatically process XM configuration files kept in
+ the <code>/etc/xen</code> directory. It is important not to place
+ any other non-config files in this directory.
+ </li></ul>
+ <h2>
+ <a name="xmlconfig" id="xmlconfig">Example domain XML config</a>
+ </h2>
+ <p>
+ Below are some example XML configurations for Xen guest domains.
+ For full details of the available options, consult the <a href="formatdomain.html">domain XML format</a>
+ guide.
+ </p>
+ <h3>Paravirtualized guest bootloader</h3>
+ <p>
+ Using a bootloader allows a paravirtualized guest to be booted using
+ a kernel stored inside its virtual disk image
+ </p>
+ <pre><domain type='xen' >
+ <name>fc8</name>
+ <bootloader>/usr/bin/pygrub</bootloader>
+ <os>
+ <type>linux</type>
+ </os>
+ <memory>131072</memory>
+ <vcpu>1</vcpu>
+ <devices>
+ <disk type='file'>
+ <source file='/var/lib/xen/images/fc4.img'/>
+ <target dev='sda1'/>
+ </disk>
+ <interface type='bridge'>
+ <source bridge='xenbr0'/>
+ <mac address='aa:00:00:00:00:11'/>
+ <script path='/etc/xen/scripts/vif-bridge'/>
+ </interface>
+ <console tty='/dev/pts/5'/>
+ </devices>
+</domain></pre>
+ <h3>Paravirtualized guest direct kernel boot</h3>
+ <p>
+ For installation of paravirtualized guests it is typical to boot the
+ domain using a kernel and initrd stored in the host OS
+ </p>
+ <pre><domain type='xen' >
+ <name>fc8</name>
+ <os>
+ <type>linux</type>
+ <kernel>/var/lib/xen/install/vmlinuz-fedora8-x86_64</kernel>
+ <initrd>/var/lib/xen/install/initrd-vmlinuz-fedora8-x86_64</initrd>
+ <cmdline> kickstart=http://example.com/myguest.ks </cmdline>
+ </os>
+ <memory>131072</memory>
+ <vcpu>1</vcpu>
+ <devices>
+ <disk type='file'>
+ <source file='/var/lib/xen/images/fc4.img'/>
+ <target dev='sda1'/>
+ </disk>
+ <interface type='bridge'>
+ <source bridge='xenbr0'/>
+ <mac address='aa:00:00:00:00:11'/>
+ <script path='/etc/xen/scripts/vif-bridge'/>
+ </interface>
+ <graphics type='vnc' port='-1'/>
+ <console tty='/dev/pts/5'/>
+ </devices>
+</domain></pre>
+ <h3>Fullyvirtualized guest BIOS boot</h3>
+ <p>
+ Fullyvirtualized guests use the emulated BIOS to boot off the primary
+ harddisk, CDROM or Network PXE ROM.
+ </p>
+ <pre><domain type='xen' id='3'>
+ <name>fv0</name>
+ <uuid>4dea22b31d52d8f32516782e98ab3fa0</uuid>
+ <os>
+ <type>hvm</type>
+ <loader>/usr/lib/xen/boot/hvmloader</loader>
+ <boot dev='hd'/>
+ </os>
+ <memory>524288</memory>
+ <vcpu>1</vcpu>
+ <on_poweroff>destroy</on_poweroff>
+ <on_reboot>restart</on_reboot>
+ <on_crash>restart</on_crash>
+ <features>
+ <pae/>
+ <acpi/>
+ <apic/>
+ </features>
+ <clock sync="localtime"/>
+ <devices>
+ <emulator>/usr/lib/xen/bin/qemu-dm</emulator>
+ <interface type='bridge'>
+ <source bridge='xenbr0'/>
+ <mac address='00:16:3e:5d:c7:9e'/>
+ <script path='vif-bridge'/>
+ </interface>
+ <disk type='file'>
+ <source file='/var/lib/xen/images/fv0'/>
+ <target dev='hda'/>
+ </disk>
+ <disk type='file' device='cdrom'>
+ <source file='/var/lib/xen/images/fc5-x86_64-boot.iso'/>
+ <target dev='hdc'/>
+ <readonly/>
+ </disk>
+ <disk type='file' device='floppy'>
+ <source file='/root/fd.img'/>
+ <target dev='fda'/>
+ </disk>
+ <graphics type='vnc' port='5904'/>
+ </devices>
+</domain></pre>
+ <h3>Fullyvirtualized guest direct kernel boot</h3>
+ <p>
+ With Xen 3.2.0 or later it is possible to bypass the BIOS and directly
+ boot a Linux kernel and initrd as a fullyvirtualized domain. This allows
+ for complete automation of OS installation, for example using the Anaconda
+ kickstart support.
+ </p>
+ <pre><domain type='xen' id='3'>
+ <name>fv0</name>
+ <uuid>4dea22b31d52d8f32516782e98ab3fa0</uuid>
+ <os>
+ <type>hvm</type>
+ <loader>/usr/lib/xen/boot/hvmloader</loader>
+ <kernel>/var/lib/xen/install/vmlinuz-fedora8-x86_64</kernel>
+ <initrd>/var/lib/xen/install/initrd-vmlinuz-fedora8-x86_64</initrd>
+ <cmdline> kickstart=http://example.com/myguest.ks </cmdline>
+ </os>
+ <memory>524288</memory>
+ <vcpu>1</vcpu>
+ <on_poweroff>destroy</on_poweroff>
+ <on_reboot>restart</on_reboot>
+ <on_crash>restart</on_crash>
+ <features>
+ <pae/>
+ <acpi/>
+ <apic/>
+ </features>
+ <clock sync="localtime"/>
+ <devices>
+ <emulator>/usr/lib/xen/bin/qemu-dm</emulator>
+ <interface type='bridge'>
+ <source bridge='xenbr0'/>
+ <mac address='00:16:3e:5d:c7:9e'/>
+ <script path='vif-bridge'/>
+ </interface>
+ <disk type='file'>
+ <source file='/var/lib/xen/images/fv0'/>
+ <target dev='hda'/>
+ </disk>
+ <disk type='file' device='cdrom'>
+ <source file='/var/lib/xen/images/fc5-x86_64-boot.iso'/>
+ <target dev='hdc'/>
+ <readonly/>
+ </disk>
+ <disk type='file' device='floppy'>
+ <source file='/root/fd.img'/>
+ <target dev='fda'/>
+ </disk>
+ <graphics type='vnc' port='5904'/>
+ </devices>
+</domain></pre>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+ <ul class="l2"><li>
+ <span class="active">Xen</span>
+ </li><li>
+ <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+ </li><li>
+ <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+ </li><li>
+ <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+ </li><li>
+ <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+ </li><li>
+ <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+ </li><li>
+ <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+ </li></ul>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Xen hypervisor driver</h1>
+
+ <p>
+ The libvirt Xen driver provides the ability to manage virtual machines
+ on any Xen release from 3.0.1 onwards.
+ </p>
+
+ <h2>Deployment pre-requisites</h2>
+
+ <p>
+ The libvirt Xen driver uses a combination of channels to manage Xen
+ virtual machines.
+ </p>
+
+ <ul>
+ <li>
+ <strong>XenD</strong>: Access to the Xen daemon is a mandatory
+ requirement for the libvirt Xen driver. It requires that the UNIX
+ socket interface be enabled in the <code>/etc/xen/xend-config.sxp</code>
+ configuration file. Specifically the config settings
+ <code>(xend-unix-server yes)</code>. This path is usually restricted
+ to only allow the <code>root</code> user access. As an alternative,
+ the HTTP interface can be used, however, this has significant security
+ implications.
+ </li>
+ <li>
+ <strong>XenStoreD</strong>: Access to the Xenstore daemon enables
+ more efficient codepaths for looking up domain information which
+ lowers the CPU overhead of management.
+ </li>
+ <li>
+ <strong>Hypercalls</strong>: The ability to make direct hypercalls
+ allows the most efficient codepaths in the driver to be used for
+ monitoring domain status.
+ </li>
+ <li>
+ <strong>XM config</strong>: When using Xen releases prior to 3.0.4,
+ there is no inactive domain management in XenD. For such releases,
+ libvirt will automatically process XM configuration files kept in
+ the <code>/etc/xen</code> directory. It is important not to place
+ any other non-config files in this directory.
+ </li>
+ </ul>
+
+ <h2><a name="xmlconfig">Example domain XML config</a></h2>
+
+ <p>
+ Below are some example XML configurations for Xen guest domains.
+ For full details of the available options, consult the <a href="formatdomain.html">domain XML format</a>
+ guide.
+ </p>
+
+ <h3>Paravirtualized guest bootloader</h3>
+
+ <p>
+ Using a bootloader allows a paravirtualized guest to be booted using
+ a kernel stored inside its virtual disk image
+ </p>
+
+ <pre><domain type='xen' >
+ <name>fc8</name>
+ <bootloader>/usr/bin/pygrub</bootloader>
+ <os>
+ <type>linux</type>
+ </os>
+ <memory>131072</memory>
+ <vcpu>1</vcpu>
+ <devices>
+ <disk type='file'>
+ <source file='/var/lib/xen/images/fc4.img'/>
+ <target dev='sda1'/>
+ </disk>
+ <interface type='bridge'>
+ <source bridge='xenbr0'/>
+ <mac address='aa:00:00:00:00:11'/>
+ <script path='/etc/xen/scripts/vif-bridge'/>
+ </interface>
+ <console tty='/dev/pts/5'/>
+ </devices>
+</domain></pre>
+
+ <h3>Paravirtualized guest direct kernel boot</h3>
+
+ <p>
+ For installation of paravirtualized guests it is typical to boot the
+ domain using a kernel and initrd stored in the host OS
+ </p>
+
+ <pre><domain type='xen' >
+ <name>fc8</name>
+ <os>
+ <type>linux</type>
+ <kernel>/var/lib/xen/install/vmlinuz-fedora8-x86_64</kernel>
+ <initrd>/var/lib/xen/install/initrd-vmlinuz-fedora8-x86_64</initrd>
+ <cmdline> kickstart=http://example.com/myguest.ks </cmdline>
+ </os>
+ <memory>131072</memory>
+ <vcpu>1</vcpu>
+ <devices>
+ <disk type='file'>
+ <source file='/var/lib/xen/images/fc4.img'/>
+ <target dev='sda1'/>
+ </disk>
+ <interface type='bridge'>
+ <source bridge='xenbr0'/>
+ <mac address='aa:00:00:00:00:11'/>
+ <script path='/etc/xen/scripts/vif-bridge'/>
+ </interface>
+ <graphics type='vnc' port='-1'/>
+ <console tty='/dev/pts/5'/>
+ </devices>
+</domain></pre>
+
+ <h3>Fullyvirtualized guest BIOS boot</h3>
+
+ <p>
+ Fullyvirtualized guests use the emulated BIOS to boot off the primary
+ harddisk, CDROM or Network PXE ROM.
+ </p>
+
+ <pre><domain type='xen' id='3'>
+ <name>fv0</name>
+ <uuid>4dea22b31d52d8f32516782e98ab3fa0</uuid>
+ <os>
+ <type>hvm</type>
+ <loader>/usr/lib/xen/boot/hvmloader</loader>
+ <boot dev='hd'/>
+ </os>
+ <memory>524288</memory>
+ <vcpu>1</vcpu>
+ <on_poweroff>destroy</on_poweroff>
+ <on_reboot>restart</on_reboot>
+ <on_crash>restart</on_crash>
+ <features>
+ <pae/>
+ <acpi/>
+ <apic/>
+ </features>
+ <clock sync="localtime"/>
+ <devices>
+ <emulator>/usr/lib/xen/bin/qemu-dm</emulator>
+ <interface type='bridge'>
+ <source bridge='xenbr0'/>
+ <mac address='00:16:3e:5d:c7:9e'/>
+ <script path='vif-bridge'/>
+ </interface>
+ <disk type='file'>
+ <source file='/var/lib/xen/images/fv0'/>
+ <target dev='hda'/>
+ </disk>
+ <disk type='file' device='cdrom'>
+ <source file='/var/lib/xen/images/fc5-x86_64-boot.iso'/>
+ <target dev='hdc'/>
+ <readonly/>
+ </disk>
+ <disk type='file' device='floppy'>
+ <source file='/root/fd.img'/>
+ <target dev='fda'/>
+ </disk>
+ <graphics type='vnc' port='5904'/>
+ </devices>
+</domain></pre>
+
+ <h3>Fullyvirtualized guest direct kernel boot</h3>
+
+ <p>
+ With Xen 3.2.0 or later it is possible to bypass the BIOS and directly
+ boot a Linux kernel and initrd as a fullyvirtualized domain. This allows
+ for complete automation of OS installation, for example using the Anaconda
+ kickstart support.
+ </p>
+
+ <pre><domain type='xen' id='3'>
+ <name>fv0</name>
+ <uuid>4dea22b31d52d8f32516782e98ab3fa0</uuid>
+ <os>
+ <type>hvm</type>
+ <loader>/usr/lib/xen/boot/hvmloader</loader>
+ <kernel>/var/lib/xen/install/vmlinuz-fedora8-x86_64</kernel>
+ <initrd>/var/lib/xen/install/initrd-vmlinuz-fedora8-x86_64</initrd>
+ <cmdline> kickstart=http://example.com/myguest.ks </cmdline>
+ </os>
+ <memory>524288</memory>
+ <vcpu>1</vcpu>
+ <on_poweroff>destroy</on_poweroff>
+ <on_reboot>restart</on_reboot>
+ <on_crash>restart</on_crash>
+ <features>
+ <pae/>
+ <acpi/>
+ <apic/>
+ </features>
+ <clock sync="localtime"/>
+ <devices>
+ <emulator>/usr/lib/xen/bin/qemu-dm</emulator>
+ <interface type='bridge'>
+ <source bridge='xenbr0'/>
+ <mac address='00:16:3e:5d:c7:9e'/>
+ <script path='vif-bridge'/>
+ </interface>
+ <disk type='file'>
+ <source file='/var/lib/xen/images/fv0'/>
+ <target dev='hda'/>
+ </disk>
+ <disk type='file' device='cdrom'>
+ <source file='/var/lib/xen/images/fc5-x86_64-boot.iso'/>
+ <target dev='hdc'/>
+ <readonly/>
+ </disk>
+ <disk type='file' device='floppy'>
+ <source file='/root/fd.img'/>
+ <target dev='fda'/>
+ </disk>
+ <graphics type='vnc' port='5904'/>
+ </devices>
+</domain></pre>
+
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Handling of errors</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Handling of errors</h1><p>The main goals of libvirt when it comes to error handling are:</p><ul><li>provide as much detail as possible</li>
- <li>provide the information as soon as possible</li>
- <li>dont force the library user into one style of error handling</li>
-</ul><p>As result the library provide both synchronous, callback based and
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from errors.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Handling of errors</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Handling of errors</h1>
+ <p>The main goals of libvirt when it comes to error handling are:</p>
+ <ul><li>provide as much detail as possible</li><li>provide the information as soon as possible</li><li>dont force the library user into one style of error handling</li></ul>
+ <p>As result the library provide both synchronous, callback based and
asynchronous error reporting. When an error happens in the library code the
error is logged, allowing to retrieve it later and if the user registered an
error callback it will be called synchronously. Once the call to libvirt ends
the error can be detected by the return value and the full information for
-the last logged error can be retrieved.</p><p>To avoid as much as possible troubles with a global variable in a
+the last logged error can be retrieved.</p>
+ <p>To avoid as much as possible troubles with a global variable in a
multithreaded environment, libvirt will associate when possible the errors to
the current connection they are related to, that way the error is stored in a
dynamic structure which can be made thread specific. Error callback can be
-set specifically to a connection with</p><p>So error handling in the code is the following:</p><ol><li>if the error can be associated to a connection for example when failing
+set specifically to a connection with</p>
+ <p>So error handling in the code is the following:</p>
+ <ol><li>if the error can be associated to a connection for example when failing
to look up a domain
<ol><li>if there is a callback associated to the connection set with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
- call it with the error information</li>
- <li>otherwise if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
- call it with the error information</li>
- <li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
+ call it with the error information</li><li>otherwise if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
+ call it with the error information</li><li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
which is the default error function of the library issuing the error
- on stderr</li>
- <li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li>
- </ol></li>
- <li>otherwise like when failing to create an hypervisor connection:
+ on stderr</li><li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li></ol></li><li>otherwise like when failing to create an hypervisor connection:
<ol><li>if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
- call it with the error information</li>
- <li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
+ call it with the error information</li><li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
which is the default error function of the library issuing the error
- on stderr</li>
- <li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li>
- </ol></li>
-</ol><p>In all cases the error information is provided as a <a href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a> pointer to
+ on stderr</li><li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li></ol></li></ol>
+ <p>In all cases the error information is provided as a <a href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a> pointer to
read-only structure <a href="html/libvirt-virterror.html#virError">virError</a> containing the
-following fields:</p><ul><li>code: an error number from the <a href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>
- enum</li>
- <li>domain: an enum indicating which part of libvirt raised the error see
- <a href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li>
- <li>level: the error level, usually VIR_ERR_ERROR, though there is room for
- warnings like VIR_ERR_WARNING</li>
- <li>message: the full human-readable formatted string of the error</li>
- <li>conn: if available a pointer to the <a href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>
- connection to the hypervisor where this happened</li>
- <li>dom: if available a pointer to the <a href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain
- targeted in the operation</li>
-</ul><p>and then extra raw information about the error which may be initialized
-to 0 or NULL if unused</p><ul><li>str1, str2, str3: string information, usually str1 is the error
- message format</li>
- <li>int1, int2: integer information</li>
-</ul><p>So usually, setting up specific error handling with libvirt consist of
+following fields:</p>
+ <ul><li>code: an error number from the <a href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>
+ enum</li><li>domain: an enum indicating which part of libvirt raised the error see
+ <a href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li><li>level: the error level, usually VIR_ERR_ERROR, though there is room for
+ warnings like VIR_ERR_WARNING</li><li>message: the full human-readable formatted string of the error</li><li>conn: if available a pointer to the <a href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>
+ connection to the hypervisor where this happened</li><li>dom: if available a pointer to the <a href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain
+ targeted in the operation</li></ul>
+ <p>and then extra raw information about the error which may be initialized
+to 0 or NULL if unused</p>
+ <ul><li>str1, str2, str3: string information, usually str1 is the error
+ message format</li><li>int1, int2: integer information</li></ul>
+ <p>So usually, setting up specific error handling with libvirt consist of
registering an handler with with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a> or
with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
check the value of the code value, take appropriate action, if needed let
the error being reported on stderr, and call virConnGetLastError or
virGetLastError when an API call returned an error value. It can be a good
idea to use <a href="html/libvirt-virterror.html#virResetLastError">virResetError</a> or <a href="html/libvirt-virterror.html#virConnResetLastError">virConnResetLastError</a>
-once an error has been processed fully.</p><p>At the python level, there only a global reporting callback function at
-this point, see the error.py example about it:</p><pre>def handler(ctxt, err):
+once an error has been processed fully.</p>
+ <p>At the python level, there only a global reporting callback function at
+this point, see the error.py example about it:</p>
+ <pre>def handler(ctxt, err):
global errno
#print "handler(%s, %s)" % (ctxt, err)
errno = err
-libvirt.registerErrorHandler(handler, 'context') </pre><p>the second argument to the registerErrorHandler function is passed as the
+libvirt.registerErrorHandler(handler, 'context') </pre>
+ <p>the second argument to the registerErrorHandler function is passed as the
first argument of the callback like in the C version. The error is a tuple
-containing the same field as a virError in C, but cast to Python.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+containing the same field as a virError in C, but cast to Python.</p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1 >Handling of errors</h1>
+ <p>The main goals of libvirt when it comes to error handling are:</p>
+ <ul>
+ <li>provide as much detail as possible</li>
+ <li>provide the information as soon as possible</li>
+ <li>dont force the library user into one style of error handling</li>
+ </ul>
+ <p>As result the library provide both synchronous, callback based and
+asynchronous error reporting. When an error happens in the library code the
+error is logged, allowing to retrieve it later and if the user registered an
+error callback it will be called synchronously. Once the call to libvirt ends
+the error can be detected by the return value and the full information for
+the last logged error can be retrieved.</p>
+ <p>To avoid as much as possible troubles with a global variable in a
+multithreaded environment, libvirt will associate when possible the errors to
+the current connection they are related to, that way the error is stored in a
+dynamic structure which can be made thread specific. Error callback can be
+set specifically to a connection with</p>
+ <p>So error handling in the code is the following:</p>
+ <ol>
+ <li>if the error can be associated to a connection for example when failing
+ to look up a domain
+ <ol><li>if there is a callback associated to the connection set with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
+ call it with the error information</li><li>otherwise if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
+ call it with the error information</li><li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
+ which is the default error function of the library issuing the error
+ on stderr</li><li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li></ol></li>
+ <li>otherwise like when failing to create an hypervisor connection:
+ <ol><li>if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
+ call it with the error information</li><li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
+ which is the default error function of the library issuing the error
+ on stderr</li><li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li></ol></li>
+ </ol>
+ <p>In all cases the error information is provided as a <a href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a> pointer to
+read-only structure <a href="html/libvirt-virterror.html#virError">virError</a> containing the
+following fields:</p>
+ <ul>
+ <li>code: an error number from the <a href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>
+ enum</li>
+ <li>domain: an enum indicating which part of libvirt raised the error see
+ <a href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li>
+ <li>level: the error level, usually VIR_ERR_ERROR, though there is room for
+ warnings like VIR_ERR_WARNING</li>
+ <li>message: the full human-readable formatted string of the error</li>
+ <li>conn: if available a pointer to the <a href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>
+ connection to the hypervisor where this happened</li>
+ <li>dom: if available a pointer to the <a href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain
+ targeted in the operation</li>
+ </ul>
+ <p>and then extra raw information about the error which may be initialized
+to 0 or NULL if unused</p>
+ <ul>
+ <li>str1, str2, str3: string information, usually str1 is the error
+ message format</li>
+ <li>int1, int2: integer information</li>
+ </ul>
+ <p>So usually, setting up specific error handling with libvirt consist of
+registering an handler with with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a> or
+with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
+check the value of the code value, take appropriate action, if needed let
+libvirt print the error on stderr by calling <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>.
+For asynchronous error handing, set such a function doing nothing to avoid
+the error being reported on stderr, and call virConnGetLastError or
+virGetLastError when an API call returned an error value. It can be a good
+idea to use <a href="html/libvirt-virterror.html#virResetLastError">virResetError</a> or <a href="html/libvirt-virterror.html#virConnResetLastError">virConnResetLastError</a>
+once an error has been processed fully.</p>
+ <p>At the python level, there only a global reporting callback function at
+this point, see the error.py example about it:</p>
+ <pre>def handler(ctxt, err):
+ global errno
+
+ #print "handler(%s, %s)" % (ctxt, err)
+ errno = err
+
+libvirt.registerErrorHandler(handler, 'context') </pre>
+ <p>the second argument to the registerErrorHandler function is passed as the
+first argument of the callback like in the C version. The error is a tuple
+containing the same field as a virError in C, but cast to Python.</p>
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>XML Format</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">XML Format</h1><p>This section describes the XML format used to represent domains, there are
-variations on the format based on the kind of domains run and the options
-used to launch them:</p><ul><li><a href="#Normal1">Normal paravirtualized Xen domains</a></li>
- <li><a href="#Fully1">Fully virtualized Xen domains</a></li>
- <li><a href="#KVM1">KVM domains</a></li>
- <li><a href="#Net1">Networking options for QEmu and KVM</a></li>
- <li><a href="#QEmu1">QEmu domains</a></li>
- <li><a href="#Capa1">Discovering virtualization capabilities</a></li>
-</ul><p>The formats try as much as possible to follow the same structure and reuse
-elements and attributes where it makes sense.</p><h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized Xen
-guests</a>:</h3><p>The library use an XML format to describe domains, as input to <a href="html/libvirt-libvirt.html#virDomainCreateLinux">virDomainCreateLinux()</a>
-and as the output of <a href="html/libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc()</a>,
-the following is an example of the format as returned by the shell command
-<code>virsh xmldump fc4</code> , where fc4 was one of the running domains:</p><pre><domain type='xen' <span style="color: #0071FF; background-color: #FFFFFF">id='18'</span>>
- <name>fc4</name>
- <span style="color: #00B200; background-color: #FFFFFF"><os>
- <type>linux</type>
- <kernel>/boot/vmlinuz-2.6.15-1.43_FC5guest</kernel>
- <initrd>/boot/initrd-2.6.15-1.43_FC5guest.img</initrd>
- <root>/dev/sda1</root>
- <cmdline> ro selinux=0 3</cmdline>
- </os></span>
- <memory>131072</memory>
- <vcpu>1</vcpu>
- <devices>
- <span style="color: #FF0080; background-color: #FFFFFF"><disk type='file'>
- <source file='/u/fc4.img'/>
- <target dev='sda1'/>
- </disk></span>
- <span style="color: #0000FF; background-color: #FFFFFF"><interface type='bridge'>
- <source bridge='xenbr0'/>
- <mac address='</span><span style="color: #0000FF; background-color: #FFFFFF"></span><span style="color: #0000FF; background-color: #FFFFFF">aa:00:00:00:00:11'/>
- <script path='/etc/xen/scripts/vif-bridge'/>
- </interface></span>
- <span style="color: #FF8000; background-color: #FFFFFF"><console tty='/dev/pts/5'/></span>
- </devices>
-</domain></pre><p>The root element must be called <code>domain</code> with no namespace, the
-<code>type</code> attribute indicates the kind of hypervisor used, 'xen' is
-the default value. The <code>id</code> attribute gives the domain id at
-runtime (not however that this may change, for example if the domain is saved
-to disk and restored). The domain has a few children whose order is not
-significant:</p><ul><li>name: the domain name, preferably ASCII based</li>
- <li>memory: the maximum memory allocated to the domain in kilobytes</li>
- <li>vcpu: the number of virtual cpu configured for the domain</li>
- <li>os: a block describing the Operating System, its content will be
- dependent on the OS type
- <ul><li>type: indicate the OS type, always linux at this point</li>
- <li>kernel: path to the kernel on the Domain 0 filesystem</li>
- <li>initrd: an optional path for the init ramdisk on the Domain 0
- filesystem</li>
- <li>cmdline: optional command line to the kernel</li>
- <li>root: the root filesystem from the guest viewpoint, it may be
- passed as part of the cmdline content too</li>
- </ul></li>
- <li>devices: a list of <code>disk</code>, <code>interface</code> and
- <code>console</code> descriptions in no special order</li>
-</ul><p>The format of the devices and their type may grow over time, but the
-following should be sufficient for basic use:</p><p>A <code>disk</code> device indicates a block device, it can have two
-values for the type attribute either 'file' or 'block' corresponding to the 2
-options available at the Xen layer. It has two mandatory children, and one
-optional one in no specific order:</p><ul><li>source with a file attribute containing the path in Domain 0 to the
- file or a dev attribute if using a block device, containing the device
- name ('hda5' or '/dev/hda5')</li>
- <li>target indicates in a dev attribute the device where it is mapped in
- the guest</li>
- <li>readonly an optional empty element indicating the device is
- read-only</li>
- <li>shareable an optional empty element indicating the device
- can be used read/write with other domains</li>
-</ul><p>An <code>interface</code> element describes a network device mapped on the
-guest, it also has a type whose value is currently 'bridge', it also have a
-number of children in no specific order:</p><ul><li>source: indicating the bridge name</li>
- <li>mac: the optional mac address provided in the address attribute</li>
- <li>ip: the optional IP address provided in the address attribute</li>
- <li>script: the script used to bridge the interface in the Domain 0</li>
- <li>target: and optional target indicating the device name.</li>
-</ul><p>A <code>console</code> element describes a serial console connection to
-the guest. It has no children, and a single attribute <code>tty</code> which
-provides the path to the Pseudo TTY on which the guest console can be
-accessed</p><p>Life cycle actions for the domain can also be expressed in the XML format,
-they drive what should be happening if the domain crashes, is rebooted or is
-poweroff. There is various actions possible when this happen:</p><ul><li>destroy: The domain is cleaned up (that's the default normal processing
- in Xen)</li>
- <li>restart: A new domain is started in place of the old one with the same
- configuration parameters</li>
- <li>preserve: The domain will remain in memory until it is destroyed
- manually, it won't be running but allows for post-mortem debugging</li>
- <li>rename-restart: a variant of the previous one but where the old domain
- is renamed before being saved to allow a restart</li>
-</ul><p>The following could be used for a Xen production system:</p><pre><domain>
- ...
- <on_reboot>restart</on_reboot>
- <on_poweroff>destroy</on_poweroff>
- <on_crash>rename-restart</on_crash>
- ...
-</domain></pre><p>While the format may be extended in various ways as support for more
-hypervisor types and features are added, it is expected that this core subset
-will remain functional in spite of the evolution of the library.</p><h3 id="Fully"><a name="Fully1" id="Fully1">Fully virtualized guests</a>
-(added in 0.1.3):</h3><p>Here is an example of a domain description used to start a fully
-virtualized (a.k.a. HVM) Xen domain. This requires hardware virtualization
-support at the processor level but allows to run unmodified operating
-systems:</p><pre><domain type='xen' id='3'>
- <name>fv0</name>
- <uuid>4dea22b31d52d8f32516782e98ab3fa0</uuid>
- <os>
- <span style="color: #0000E5; background-color: #FFFFFF"><type>hvm</type></span>
- <span style="color: #0000E5; background-color: #FFFFFF"><loader>/usr/lib/xen/boot/hvmloader</loader></span>
- <span style="color: #0000E5; background-color: #FFFFFF"><boot dev='hd'/></span>
- </os>
- <memory>524288</memory>
- <vcpu>1</vcpu>
- <on_poweroff>destroy</on_poweroff>
- <on_reboot>restart</on_reboot>
- <on_crash>restart</on_crash>
- <features>
- <span style="color: #E50000; background-color: #FFFFFF"><pae/>
- <acpi/>
- <apic/></span>
- </features>
- <span style="color: #0000E5; background-color: #FFFFFF"><clock sync="localtime"/></span>
- <devices>
- <span style="color: #0000E5; background-color: #FFFFFF"><emulator>/usr/lib/xen/bin/qemu-dm</emulator></span>
- <interface type='bridge'>
- <source bridge='xenbr0'/>
- <mac address='00:16:3e:5d:c7:9e'/>
- <script path='vif-bridge'/>
- </interface>
- <disk type='file'>
- <source file='/root/fv0'/>
- <target <span style="color: #0000E5; background-color: #FFFFFF">dev='hda'</span>/>
- </disk>
- <disk type='file' <span style="color: #0000E5; background-color: #FFFFFF">device='cdrom'</span>>
- <source file='/root/fc5-x86_64-boot.iso'/>
- <target <span style="color: #0000E5; background-color: #FFFFFF">dev='hdc'</span>/>
- <readonly/>
- </disk>
- <disk type='file' <span style="color: #0000E5; background-color: #FFFFFF">device='floppy'</span>>
- <source file='/root/fd.img'/>
- <target <span style="color: #0000E5; background-color: #FFFFFF">dev='fda'</span>/>
- </disk>
- <span style="color: #0000E5; background-color: #FFFFFF"><graphics type='vnc' port='5904'/></span>
- </devices>
-</domain></pre><p>There is a few things to notice specifically for HVM domains:</p><ul><li>the optional <code><features></code> block is used to enable
- certain guest CPU / system features. For HVM guests the following
- features are defined:
- <ul><li><code>pae</code> - enable PAE memory addressing</li>
- <li><code>apic</code> - enable IO APIC</li>
- <li><code>acpi</code> - enable ACPI bios</li>
- </ul></li>
- <li>the optional <code><clock></code> element is used to specify
- whether the emulated BIOS clock in the guest is synced to either
- <code>localtime</code> or <code>utc</code>. In general Windows will
- want <code>localtime</code> while all other operating systems will
- want <code>utc</code>. The default is thus <code>utc</code></li>
- <li>the <code><os></code> block description is very different, first
- it indicates that the type is 'hvm' for hardware virtualization, then
- instead of a kernel, boot and command line arguments, it points to an os
- boot loader which will extract the boot information from the boot device
- specified in a separate boot element. The <code>dev</code> attribute on
- the <code>boot</code> tag can be one of:
- <ul><li><code>fd</code> - boot from first floppy device</li>
- <li><code>hd</code> - boot from first harddisk device</li>
- <li><code>cdrom</code> - boot from first cdrom device</li>
- </ul></li>
- <li>the <code><devices></code> section includes an emulator entry
- pointing to an additional program in charge of emulating the devices</li>
- <li>the disk entry indicates in the dev target section that the emulation
- for the drive is the first IDE disk device hda. The list of device names
- supported is dependent on the Hypervisor, but for Xen it can be any IDE
- device <code>hda</code>-<code>hdd</code>, or a floppy device
- <code>fda</code>, <code>fdb</code>. The <code><disk></code> element
- also supports a 'device' attribute to indicate what kinda of hardware to
- emulate. The following values are supported:
- <ul><li><code>floppy</code> - a floppy disk controller</li>
- <li><code>disk</code> - a generic hard drive (the default it
- omitted)</li>
- <li><code>cdrom</code> - a CDROM device</li>
- </ul>
- For Xen 3.0.2 and earlier a CDROM device can only be emulated on the
- <code>hdc</code> channel, while for 3.0.3 and later, it can be emulated
- on any IDE channel.</li>
- <li>the <code><devices></code> section also include at least one
- entry for the graphic device used to render the os. Currently there is
- just 2 types possible 'vnc' or 'sdl'. If the type is 'vnc', then an
- additional <code>port</code> attribute will be present indicating the TCP
- port on which the VNC server is accepting client connections.</li>
-</ul><p>It is likely that the HVM description gets additional optional elements
-and attributes as the support for fully virtualized domain expands,
-especially for the variety of devices emulated and the graphic support
-options offered.</p><h3><a name="KVM1" id="KVM1">KVM domain (added in 0.2.0)</a></h3><p>Support for the <a href="http://kvm.qumranet.com/">KVM virtualization</a>
-is provided in recent Linux kernels (2.6.20 and onward). This requires
-specific hardware with acceleration support and the availability of the
-special version of the <a href="http://fabrice.bellard.free.fr/qemu/">QEmu</a> binary. Since this
-relies on QEmu for the machine emulation like fully virtualized guests the
-XML description is quite similar, here is a simple example:</p><pre><domain <span style="color: #FF0000; background-color: #FFFFFF">type='kvm'</span>>
- <name>demo2</name>
- <uuid>4dea24b3-1d52-d8f3-2516-782e98a23fa0</uuid>
- <memory>131072</memory>
- <vcpu>1</vcpu>
- <os>
- <type>hvm</type>
- </os>
- <span style="color: #0000E5; background-color: #FFFFFF"><clock sync="localtime"/></span>
- <devices>
- <span style="color: #FF0000; background-color: #FFFFFF"><emulator>/home/user/usr/kvm-devel/bin/qemu-system-x86_64</emulator></span>
- <disk type='file' device='disk'>
- <source file='/home/user/fedora/diskboot.img'/>
- <target dev='hda'/>
- </disk>
- <interface <span style="color: #FF0000; background-color: #FFFFFF">type='user'</span>>
- <mac address='24:42:53:21:52:45'/>
- </interface>
- <graphics type='vnc' port='-1'/>
- </devices>
-</domain></pre><p>The specific points to note if using KVM are:</p><ul><li>the top level domain element carries a type of 'kvm'</li>
- <li>the <clock> optional is supported as with Xen HVM</li>
- <li>the <devices> emulator points to the special qemu binary required
- for KVM</li>
- <li>networking interface definitions definitions are somewhat different due
- to a different model from Xen see below</li>
-</ul><p>except those points the options should be quite similar to Xen HVM
-ones.</p><h3><a name="Net1" id="Net1">Networking options for QEmu and KVM (added in 0.2.0)</a></h3><p>The networking support in the QEmu and KVM case is more flexible, and
-support a variety of options:</p><ol><li>Userspace SLIRP stack
- <p>Provides a virtual LAN with NAT to the outside world. The virtual
- network has DHCP & DNS services and will give the guest VM addresses
- starting from <code>10.0.2.15</code>. The default router will be
- <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
- This networking is the only option for unprivileged users who need their
- VMs to have outgoing access. Example configs are:</p>
- <pre><interface type='user'/></pre>
- <pre>
-<interface type='user'>
- <mac address="11:22:33:44:55:66"/>
-</interface>
- </pre>
- </li>
- <li>Virtual network
- <p>Provides a virtual network using a bridge device in the host.
- Depending on the virtual network configuration, the network may be
- totally isolated, NAT'ing to an explicit network device, or NAT'ing to
- the default route. DHCP and DNS are provided on the virtual network in
- all cases and the IP range can be determined by examining the virtual
- network config with '<code>virsh net-dumpxml <network
- name></code>'. There is one virtual network called 'default' setup out
- of the box which does NAT'ing to the default route and has an IP range of
- <code>192.168.22.0/255.255.255.0</code>. Each guest will have an
- associated tun device created with a name of vnetN, which can also be
- overridden with the <target> element. Example configs are:</p>
- <pre><interface type='network'>
- <source network='default'/>
-</interface>
-
-<interface type='network'>
- <source network='default'/>
- <target dev='vnet7'/>
- <mac address="11:22:33:44:55:66"/>
-</interface>
- </pre>
- </li>
- <li>Bridge to to LAN
- <p>Provides a bridge from the VM directly onto the LAN. This assumes
- there is a bridge device on the host which has one or more of the hosts
- physical NICs enslaved. The guest VM will have an associated tun device
- created with a name of vnetN, which can also be overridden with the
- <target> element. The tun device will be enslaved to the bridge.
- The IP range / network configuration is whatever is used on the LAN. This
- provides the guest VM full incoming & outgoing net access just like a
- physical machine. Examples include:</p>
- <pre><interface type='bridge'>
- <source bridge='br0'/>
-</interface>
-
-<interface type='bridge'>
- <source bridge='br0'/>
- <target dev='vnet7'/>
- <mac address="11:22:33:44:55:66"/>
-</interface></pre>
- </li>
- <li>Generic connection to LAN
- <p>Provides a means for the administrator to execute an arbitrary script
- to connect the guest's network to the LAN. The guest will have a tun
- device created with a name of vnetN, which can also be overridden with the
- <target> element. After creating the tun device a shell script will
- be run which is expected to do whatever host network integration is
- required. By default this script is called /etc/qemu-ifup but can be
- overridden.</p>
- <pre><interface type='ethernet'/>
-
-<interface type='ethernet'>
- <target dev='vnet7'/>
- <script path='/etc/qemu-ifup-mynet'/>
-</interface></pre>
- </li>
- <li>Multicast tunnel
- <p>A multicast group is setup to represent a virtual network. Any VMs
- whose network devices are in the same multicast group can talk to each
- other even across hosts. This mode is also available to unprivileged
- users. There is no default DNS or DHCP support and no outgoing network
- access. To provide outgoing network access, one of the VMs should have a
- 2nd NIC which is connected to one of the first 4 network types and do the
- appropriate routing. The multicast protocol is compatible with that used
- by user mode linux guests too. The source address used must be from the
- multicast address block.</p>
- <pre><interface type='mcast'>
- <source address='230.0.0.1' port='5558'/>
-</interface></pre>
- </li>
- <li>TCP tunnel
- <p>A TCP client/server architecture provides a virtual network. One VM
- provides the server end of the network, all other VMS are configured as
- clients. All network traffic is routed between the VMs via the server.
- This mode is also available to unprivileged users. There is no default
- DNS or DHCP support and no outgoing network access. To provide outgoing
- network access, one of the VMs should have a 2nd NIC which is connected
- to one of the first 4 network types and do the appropriate routing.</p>
- <p>Example server config:</p>
- <pre><interface type='server'>
- <source address='192.168.0.1' port='5558'/>
-</interface></pre>
- <p>Example client config:</p>
- <pre><interface type='client'>
- <source address='192.168.0.1' port='5558'/>
-</interface></pre>
- </li>
-</ol><p>To be noted, options 2, 3, 4 are also supported by Xen VMs, so it is
-possible to use these configs to have networking with both Xen &
-QEMU/KVMs connected to each other.</p><h3>Q<a name="QEmu1" id="QEmu1">Emu domain (added in 0.2.0)</a></h3><p>Libvirt support for KVM and QEmu is the same code base with only minor
-changes. The configuration is as a result nearly identical, the only changes
-are related to QEmu ability to emulate <a href="http://www.qemu.org/status.html">various CPU type and hardware
-platforms</a>, and kqemu support (QEmu own kernel accelerator when the
-emulated CPU is i686 as well as the target machine):</p><pre><domain <span style="color: #FF0000; background-color: #FFFFFF">type='qemu'</span>>
- <name>QEmu-fedora-i686</name>
- <uuid>c7a5fdbd-cdaf-9455-926a-d65c16db1809</uuid>
- <memory>219200</memory>
- <currentMemory>219200</currentMemory>
- <vcpu>2</vcpu>
- <os>
- <span style="color: #FF0000; background-color: #FFFFFF"><type arch='i686' machine='pc'>hvm</type></span>
- <boot dev='cdrom'/>
- </os>
- <devices>
- <span style="color: #FF0000; background-color: #FFFFFF"><emulator>/usr/bin/qemu</emulator></span>
- <disk type='file' device='cdrom'>
- <source file='/home/user/boot.iso'/>
- <target dev='hdc'/>
- <readonly/>
- </disk>
- <disk type='file' device='disk'>
- <source file='/home/user/fedora.img'/>
- <target dev='hda'/>
- </disk>
- <interface type='network'>
- <source name='default'/>
- </interface>
- <graphics type='vnc' port='-1'/>
- </devices>
-</domain></pre><p>The difference here are:</p><ul><li>the value of type on top-level domain, it's 'qemu' or kqemu if asking
- for <a href="http://www.qemu.org/kqemu-tech.html">kernel assisted
- acceleration</a></li>
- <li>the os type block defines the architecture to be emulated, and
- optionally the machine type, see the discovery API below</li>
- <li>the emulator string must point to the right emulator for that
- architecture</li>
-</ul><h3><a name="Capa1" id="Capa1">Discovering virtualization capabilities (Added in 0.2.1)</a></h3><p>As new virtualization engine support gets added to libvirt, and to handle
-cases like QEmu supporting a variety of emulations, a query interface has
-been added in 0.2.1 allowing to list the set of supported virtualization
-capabilities on the host:</p><pre> char * virConnectGetCapabilities (virConnectPtr conn);</pre><p>The value returned is an XML document listing the virtualization
-capabilities of the host and virtualization engine to which
-<code>@conn</code> is connected. One can test it using <code>virsh</code>
-command line tool command '<code>capabilities</code>', it dumps the XML
-associated to the current connection. For example in the case of a 64 bits
-machine with hardware virtualization capabilities enabled in the chip and
-BIOS you will see</p><pre><capabilities>
- <span style="color: #E50000; background-color: #FFFFFF"><host>
- <cpu>
- <arch>x86_64</arch>
- <features>
- <vmx/>
- </features>
- </cpu>
- </host></span>
-
- <!-- xen-3.0-x86_64 -->
- <span style="color: #0000E5; background-color: #FFFFFF"><guest>
- <os_type>xen</os_type>
- <arch name="x86_64">
- <wordsize>64</wordsize>
- <domain type="xen"></domain>
- <emulator>/usr/lib64/xen/bin/qemu-dm</emulator>
- </arch>
- <features>
- </features>
- </guest></span>
-
- <!-- hvm-3.0-x86_32 -->
- <span style="color: #00B200; background-color: #FFFFFF"><guest>
- <os_type>hvm</os_type>
- <arch name="i686">
- <wordsize>32</wordsize>
- <domain type="xen"></domain>
- <emulator>/usr/lib/xen/bin/qemu-dm</emulator>
- <machine>pc</machine>
- <machine>isapc</machine>
- <loader>/usr/lib/xen/boot/hvmloader</loader>
- </arch>
- <features>
- </features>
- </guest></span>
- ...
-</capabilities></pre><p>The first block (in red) indicates the host hardware capabilities, currently
-it is limited to the CPU properties but other information may be available,
-it shows the CPU architecture, and the features of the chip (the feature
-block is similar to what you will find in a Xen fully virtualized domain
-description).</p><p>The second block (in blue) indicates the paravirtualization support of the
-Xen support, you will see the os_type of xen to indicate a paravirtual
-kernel, then architecture information and potential features.</p><p>The third block (in green) gives similar information but when running a
-32 bit OS fully virtualized with Xen using the hvm support.</p><p>This section is likely to be updated and augmented in the future, see <a href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the
-discussion</a> which led to the capabilities format in the mailing-list
-archives.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from format.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: XML Format</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>XML Format</h1>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <span class="active">XML format</span>
+ <ul class="l2"><li>
+ <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a>
+ </li><li>
+ <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a>
+ </li><li>
+ <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a>
+ </li><li>
+ <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a>
+ </li><li>
+ <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a>
+ </li></ul>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <body>
+ <h1 >XML Format</h1>
+
+
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from formatcaps.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Driver capabilities XML format</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Driver capabilities XML format</h1>
+ <p>As new virtualization engine support gets added to libvirt, and to handle
+cases like QEmu supporting a variety of emulations, a query interface has
+been added in 0.2.1 allowing to list the set of supported virtualization
+capabilities on the host:</p>
+ <pre> char * virConnectGetCapabilities (virConnectPtr conn);</pre>
+ <p>The value returned is an XML document listing the virtualization
+capabilities of the host and virtualization engine to which
+<code>@conn</code> is connected. One can test it using <code>virsh</code>
+command line tool command '<code>capabilities</code>', it dumps the XML
+associated to the current connection. For example in the case of a 64 bits
+machine with hardware virtualization capabilities enabled in the chip and
+BIOS you will see</p>
+ <pre><capabilities>
+ <span style="color: #E50000"><host>
+ <cpu>
+ <arch>x86_64</arch>
+ <features>
+ <vmx/>
+ </features>
+ </cpu>
+ </host></span>
+
+ <!-- xen-3.0-x86_64 -->
+ <span style="color: #0000E5"><guest>
+ <os_type>xen</os_type>
+ <arch name="x86_64">
+ <wordsize>64</wordsize>
+ <domain type="xen"></domain>
+ <emulator>/usr/lib64/xen/bin/qemu-dm</emulator>
+ </arch>
+ <features>
+ </features>
+ </guest></span>
+
+ <!-- hvm-3.0-x86_32 -->
+ <span style="color: #00B200"><guest>
+ <os_type>hvm</os_type>
+ <arch name="i686">
+ <wordsize>32</wordsize>
+ <domain type="xen"></domain>
+ <emulator>/usr/lib/xen/bin/qemu-dm</emulator>
+ <machine>pc</machine>
+ <machine>isapc</machine>
+ <loader>/usr/lib/xen/boot/hvmloader</loader>
+ </arch>
+ <features>
+ </features>
+ </guest></span>
+ ...
+</capabilities></pre>
+ <p>The first block (in red) indicates the host hardware capabilities, currently
+it is limited to the CPU properties but other information may be available,
+it shows the CPU architecture, and the features of the chip (the feature
+block is similar to what you will find in a Xen fully virtualized domain
+description).</p>
+ <p>The second block (in blue) indicates the paravirtualization support of the
+Xen support, you will see the os_type of xen to indicate a paravirtual
+kernel, then architecture information and potential features.</p>
+ <p>The third block (in green) gives similar information but when running a
+32 bit OS fully virtualized with Xen using the hvm support.</p>
+ <p>This section is likely to be updated and augmented in the future, see <a href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the
+discussion</a> which led to the capabilities format in the mailing-list
+archives.</p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="active" href="format.html">XML format</a>
+ <ul class="l2"><li>
+ <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a>
+ </li><li>
+ <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a>
+ </li><li>
+ <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a>
+ </li><li>
+ <span class="active">Capabilities</span>
+ </li><li>
+ <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a>
+ </li></ul>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Driver capabilities XML format</h1>
+
+ <p>As new virtualization engine support gets added to libvirt, and to handle
+cases like QEmu supporting a variety of emulations, a query interface has
+been added in 0.2.1 allowing to list the set of supported virtualization
+capabilities on the host:</p>
+ <pre> char * virConnectGetCapabilities (virConnectPtr conn);</pre>
+ <p>The value returned is an XML document listing the virtualization
+capabilities of the host and virtualization engine to which
+<code>@conn</code> is connected. One can test it using <code>virsh</code>
+command line tool command '<code>capabilities</code>', it dumps the XML
+associated to the current connection. For example in the case of a 64 bits
+machine with hardware virtualization capabilities enabled in the chip and
+BIOS you will see</p>
+ <pre><capabilities>
+ <span style="color: #E50000"><host>
+ <cpu>
+ <arch>x86_64</arch>
+ <features>
+ <vmx/>
+ </features>
+ </cpu>
+ </host></span>
+
+ <!-- xen-3.0-x86_64 -->
+ <span style="color: #0000E5"><guest>
+ <os_type>xen</os_type>
+ <arch name="x86_64">
+ <wordsize>64</wordsize>
+ <domain type="xen"></domain>
+ <emulator>/usr/lib64/xen/bin/qemu-dm</emulator>
+ </arch>
+ <features>
+ </features>
+ </guest></span>
+
+ <!-- hvm-3.0-x86_32 -->
+ <span style="color: #00B200"><guest>
+ <os_type>hvm</os_type>
+ <arch name="i686">
+ <wordsize>32</wordsize>
+ <domain type="xen"></domain>
+ <emulator>/usr/lib/xen/bin/qemu-dm</emulator>
+ <machine>pc</machine>
+ <machine>isapc</machine>
+ <loader>/usr/lib/xen/boot/hvmloader</loader>
+ </arch>
+ <features>
+ </features>
+ </guest></span>
+ ...
+</capabilities></pre>
+ <p>The first block (in red) indicates the host hardware capabilities, currently
+it is limited to the CPU properties but other information may be available,
+it shows the CPU architecture, and the features of the chip (the feature
+block is similar to what you will find in a Xen fully virtualized domain
+description).</p>
+ <p>The second block (in blue) indicates the paravirtualization support of the
+Xen support, you will see the os_type of xen to indicate a paravirtual
+kernel, then architecture information and potential features.</p>
+ <p>The third block (in green) gives similar information but when running a
+32 bit OS fully virtualized with Xen using the hvm support.</p>
+ <p>This section is likely to be updated and augmented in the future, see <a href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the
+discussion</a> which led to the capabilities format in the mailing-list
+archives.</p>
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from formatdomain.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Domain XML format</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Domain XML format</h1>
+ <p>This section describes the XML format used to represent domains, there are
+variations on the format based on the kind of domains run and the options
+used to launch them:</p>
+ <h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized Xen
+guests</a>:</h3>
+ <p>The root element must be called <code>domain</code> with no namespace, the
+<code>type</code> attribute indicates the kind of hypervisor used, 'xen' is
+the default value. The <code>id</code> attribute gives the domain id at
+runtime (not however that this may change, for example if the domain is saved
+to disk and restored). The domain has a few children whose order is not
+significant:</p>
+ <ul><li>name: the domain name, preferably ASCII based</li><li>memory: the maximum memory allocated to the domain in kilobytes</li><li>vcpu: the number of virtual cpu configured for the domain</li><li>os: a block describing the Operating System, its content will be
+ dependent on the OS type
+ <ul><li>type: indicate the OS type, always linux at this point</li><li>kernel: path to the kernel on the Domain 0 filesystem</li><li>initrd: an optional path for the init ramdisk on the Domain 0
+ filesystem</li><li>cmdline: optional command line to the kernel</li><li>root: the root filesystem from the guest viewpoint, it may be
+ passed as part of the cmdline content too</li></ul></li><li>devices: a list of <code>disk</code>, <code>interface</code> and
+ <code>console</code> descriptions in no special order</li></ul>
+ <p>The format of the devices and their type may grow over time, but the
+following should be sufficient for basic use:</p>
+ <p>A <code>disk</code> device indicates a block device, it can have two
+values for the type attribute either 'file' or 'block' corresponding to the 2
+options available at the Xen layer. It has two mandatory children, and one
+optional one in no specific order:</p>
+ <ul><li>source with a file attribute containing the path in Domain 0 to the
+ file or a dev attribute if using a block device, containing the device
+ name ('hda5' or '/dev/hda5')</li><li>target indicates in a dev attribute the device where it is mapped in
+ the guest</li><li>readonly an optional empty element indicating the device is
+ read-only</li><li>shareable an optional empty element indicating the device
+ can be used read/write with other domains</li></ul>
+ <p>An <code>interface</code> element describes a network device mapped on the
+guest, it also has a type whose value is currently 'bridge', it also have a
+number of children in no specific order:</p>
+ <ul><li>source: indicating the bridge name</li><li>mac: the optional mac address provided in the address attribute</li><li>ip: the optional IP address provided in the address attribute</li><li>script: the script used to bridge the interface in the Domain 0</li><li>target: and optional target indicating the device name.</li></ul>
+ <p>A <code>console</code> element describes a serial console connection to
+the guest. It has no children, and a single attribute <code>tty</code> which
+provides the path to the Pseudo TTY on which the guest console can be
+accessed</p>
+ <p>Life cycle actions for the domain can also be expressed in the XML format,
+they drive what should be happening if the domain crashes, is rebooted or is
+poweroff. There is various actions possible when this happen:</p>
+ <ul><li>destroy: The domain is cleaned up (that's the default normal processing
+ in Xen)</li><li>restart: A new domain is started in place of the old one with the same
+ configuration parameters</li><li>preserve: The domain will remain in memory until it is destroyed
+ manually, it won't be running but allows for post-mortem debugging</li><li>rename-restart: a variant of the previous one but where the old domain
+ is renamed before being saved to allow a restart</li></ul>
+ <p>The following could be used for a Xen production system:</p>
+ <pre><domain>
+ ...
+ <on_reboot>restart</on_reboot>
+ <on_poweroff>destroy</on_poweroff>
+ <on_crash>rename-restart</on_crash>
+ ...
+</domain></pre>
+ <p>While the format may be extended in various ways as support for more
+hypervisor types and features are added, it is expected that this core subset
+will remain functional in spite of the evolution of the library.</p>
+ <h3 id="Fully">
+ <a name="Fully1" id="Fully1">Fully virtualized guests</a>
+ </h3>
+ <p>There is a few things to notice specifically for HVM domains:</p>
+ <ul><li>the optional <code><features></code> block is used to enable
+ certain guest CPU / system features. For HVM guests the following
+ features are defined:
+ <ul><li><code>pae</code> - enable PAE memory addressing</li><li><code>apic</code> - enable IO APIC</li><li><code>acpi</code> - enable ACPI bios</li></ul></li><li>the optional <code><clock></code> element is used to specify
+ whether the emulated BIOS clock in the guest is synced to either
+ <code>localtime</code> or <code>utc</code>. In general Windows will
+ want <code>localtime</code> while all other operating systems will
+ want <code>utc</code>. The default is thus <code>utc</code></li><li>the <code><os></code> block description is very different, first
+ it indicates that the type is 'hvm' for hardware virtualization, then
+ instead of a kernel, boot and command line arguments, it points to an os
+ boot loader which will extract the boot information from the boot device
+ specified in a separate boot element. The <code>dev</code> attribute on
+ the <code>boot</code> tag can be one of:
+ <ul><li><code>fd</code> - boot from first floppy device</li><li><code>hd</code> - boot from first harddisk device</li><li><code>cdrom</code> - boot from first cdrom device</li></ul></li><li>the <code><devices></code> section includes an emulator entry
+ pointing to an additional program in charge of emulating the devices</li><li>the disk entry indicates in the dev target section that the emulation
+ for the drive is the first IDE disk device hda. The list of device names
+ supported is dependent on the Hypervisor, but for Xen it can be any IDE
+ device <code>hda</code>-<code>hdd</code>, or a floppy device
+ <code>fda</code>, <code>fdb</code>. The <code><disk></code> element
+ also supports a 'device' attribute to indicate what kinda of hardware to
+ emulate. The following values are supported:
+ <ul><li><code>floppy</code> - a floppy disk controller</li><li><code>disk</code> - a generic hard drive (the default it
+ omitted)</li><li><code>cdrom</code> - a CDROM device</li></ul>
+ For Xen 3.0.2 and earlier a CDROM device can only be emulated on the
+ <code>hdc</code> channel, while for 3.0.3 and later, it can be emulated
+ on any IDE channel.</li><li>the <code><devices></code> section also include at least one
+ entry for the graphic device used to render the os. Currently there is
+ just 2 types possible 'vnc' or 'sdl'. If the type is 'vnc', then an
+ additional <code>port</code> attribute will be present indicating the TCP
+ port on which the VNC server is accepting client connections.</li></ul>
+ <p>It is likely that the HVM description gets additional optional elements
+and attributes as the support for fully virtualized domain expands,
+especially for the variety of devices emulated and the graphic support
+options offered.</p>
+ <h3>
+ <a name="Net1" id="Net1">Networking interface options</a>
+ </h3>
+ <p>The networking support in the QEmu and KVM case is more flexible, and
+support a variety of options:</p>
+ <ol><li>Userspace SLIRP stack
+ <p>Provides a virtual LAN with NAT to the outside world. The virtual
+ network has DHCP & DNS services and will give the guest VM addresses
+ starting from <code>10.0.2.15</code>. The default router will be
+ <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
+ This networking is the only option for unprivileged users who need their
+ VMs to have outgoing access. Example configs are:</p>
+ <pre><interface type='user'/></pre>
+ <pre>
+<interface type='user'>
+ <mac address="11:22:33:44:55:66"/>
+</interface>
+ </pre>
+ </li><li>Virtual network
+ <p>Provides a virtual network using a bridge device in the host.
+ Depending on the virtual network configuration, the network may be
+ totally isolated, NAT'ing to an explicit network device, or NAT'ing to
+ the default route. DHCP and DNS are provided on the virtual network in
+ all cases and the IP range can be determined by examining the virtual
+ network config with '<code>virsh net-dumpxml <network
+ name></code>'. There is one virtual network called 'default' setup out
+ of the box which does NAT'ing to the default route and has an IP range of
+ <code>192.168.22.0/255.255.255.0</code>. Each guest will have an
+ associated tun device created with a name of vnetN, which can also be
+ overridden with the <target> element. Example configs are:</p>
+ <pre><interface type='network'>
+ <source network='default'/>
+</interface>
+
+<interface type='network'>
+ <source network='default'/>
+ <target dev='vnet7'/>
+ <mac address="11:22:33:44:55:66"/>
+</interface>
+ </pre>
+ </li><li>Bridge to to LAN
+ <p>Provides a bridge from the VM directly onto the LAN. This assumes
+ there is a bridge device on the host which has one or more of the hosts
+ physical NICs enslaved. The guest VM will have an associated tun device
+ created with a name of vnetN, which can also be overridden with the
+ <target> element. The tun device will be enslaved to the bridge.
+ The IP range / network configuration is whatever is used on the LAN. This
+ provides the guest VM full incoming & outgoing net access just like a
+ physical machine. Examples include:</p>
+ <pre><interface type='bridge'>
+ <source bridge='br0'/>
+</interface>
+
+<interface type='bridge'>
+ <source bridge='br0'/>
+ <target dev='vnet7'/>
+ <mac address="11:22:33:44:55:66"/>
+</interface></pre>
+ </li><li>Generic connection to LAN
+ <p>Provides a means for the administrator to execute an arbitrary script
+ to connect the guest's network to the LAN. The guest will have a tun
+ device created with a name of vnetN, which can also be overridden with the
+ <target> element. After creating the tun device a shell script will
+ be run which is expected to do whatever host network integration is
+ required. By default this script is called /etc/qemu-ifup but can be
+ overridden.</p>
+ <pre><interface type='ethernet'/>
+
+<interface type='ethernet'>
+ <target dev='vnet7'/>
+ <script path='/etc/qemu-ifup-mynet'/>
+</interface></pre>
+ </li><li>Multicast tunnel
+ <p>A multicast group is setup to represent a virtual network. Any VMs
+ whose network devices are in the same multicast group can talk to each
+ other even across hosts. This mode is also available to unprivileged
+ users. There is no default DNS or DHCP support and no outgoing network
+ access. To provide outgoing network access, one of the VMs should have a
+ 2nd NIC which is connected to one of the first 4 network types and do the
+ appropriate routing. The multicast protocol is compatible with that used
+ by user mode linux guests too. The source address used must be from the
+ multicast address block.</p>
+ <pre><interface type='mcast'>
+ <source address='230.0.0.1' port='5558'/>
+</interface></pre>
+ </li><li>TCP tunnel
+ <p>A TCP client/server architecture provides a virtual network. One VM
+ provides the server end of the network, all other VMS are configured as
+ clients. All network traffic is routed between the VMs via the server.
+ This mode is also available to unprivileged users. There is no default
+ DNS or DHCP support and no outgoing network access. To provide outgoing
+ network access, one of the VMs should have a 2nd NIC which is connected
+ to one of the first 4 network types and do the appropriate routing.</p>
+ <p>Example server config:</p>
+ <pre><interface type='server'>
+ <source address='192.168.0.1' port='5558'/>
+</interface></pre>
+ <p>Example client config:</p>
+ <pre><interface type='client'>
+ <source address='192.168.0.1' port='5558'/>
+</interface></pre>
+ </li></ol>
+ <p>To be noted, options 2, 3, 4 are also supported by Xen VMs, so it is
+possible to use these configs to have networking with both Xen &
+QEMU/KVMs connected to each other.</p>
+ <h2>Example configs</h2>
+ <p>
+ Example configurations for each driver are provide on the
+ driver specific pages listed below
+ </p>
+ <ul><li><a href="drvxen.html#xmlconfig">Xen examples</a></li><li><a href="drvqemu.html#xmlconfig">QEMU/KVM examples</a></li></ul>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="active" href="format.html">XML format</a>
+ <ul class="l2"><li>
+ <span class="active">Domains</span>
+ </li><li>
+ <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a>
+ </li><li>
+ <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a>
+ </li><li>
+ <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a>
+ </li><li>
+ <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a>
+ </li></ul>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Domain XML format</h1>
+
+ <p>This section describes the XML format used to represent domains, there are
+variations on the format based on the kind of domains run and the options
+used to launch them:</p>
+
+ <h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized Xen
+guests</a>:</h3>
+
+ <p>The root element must be called <code>domain</code> with no namespace, the
+<code>type</code> attribute indicates the kind of hypervisor used, 'xen' is
+the default value. The <code>id</code> attribute gives the domain id at
+runtime (not however that this may change, for example if the domain is saved
+to disk and restored). The domain has a few children whose order is not
+significant:</p>
+ <ul>
+ <li>name: the domain name, preferably ASCII based</li>
+ <li>memory: the maximum memory allocated to the domain in kilobytes</li>
+ <li>vcpu: the number of virtual cpu configured for the domain</li>
+ <li>os: a block describing the Operating System, its content will be
+ dependent on the OS type
+ <ul><li>type: indicate the OS type, always linux at this point</li><li>kernel: path to the kernel on the Domain 0 filesystem</li><li>initrd: an optional path for the init ramdisk on the Domain 0
+ filesystem</li><li>cmdline: optional command line to the kernel</li><li>root: the root filesystem from the guest viewpoint, it may be
+ passed as part of the cmdline content too</li></ul></li>
+ <li>devices: a list of <code>disk</code>, <code>interface</code> and
+ <code>console</code> descriptions in no special order</li>
+ </ul>
+ <p>The format of the devices and their type may grow over time, but the
+following should be sufficient for basic use:</p>
+ <p>A <code>disk</code> device indicates a block device, it can have two
+values for the type attribute either 'file' or 'block' corresponding to the 2
+options available at the Xen layer. It has two mandatory children, and one
+optional one in no specific order:</p>
+ <ul>
+ <li>source with a file attribute containing the path in Domain 0 to the
+ file or a dev attribute if using a block device, containing the device
+ name ('hda5' or '/dev/hda5')</li>
+ <li>target indicates in a dev attribute the device where it is mapped in
+ the guest</li>
+ <li>readonly an optional empty element indicating the device is
+ read-only</li>
+ <li>shareable an optional empty element indicating the device
+ can be used read/write with other domains</li>
+ </ul>
+ <p>An <code>interface</code> element describes a network device mapped on the
+guest, it also has a type whose value is currently 'bridge', it also have a
+number of children in no specific order:</p>
+ <ul>
+ <li>source: indicating the bridge name</li>
+ <li>mac: the optional mac address provided in the address attribute</li>
+ <li>ip: the optional IP address provided in the address attribute</li>
+ <li>script: the script used to bridge the interface in the Domain 0</li>
+ <li>target: and optional target indicating the device name.</li>
+ </ul>
+ <p>A <code>console</code> element describes a serial console connection to
+the guest. It has no children, and a single attribute <code>tty</code> which
+provides the path to the Pseudo TTY on which the guest console can be
+accessed</p>
+ <p>Life cycle actions for the domain can also be expressed in the XML format,
+they drive what should be happening if the domain crashes, is rebooted or is
+poweroff. There is various actions possible when this happen:</p>
+ <ul>
+ <li>destroy: The domain is cleaned up (that's the default normal processing
+ in Xen)</li>
+ <li>restart: A new domain is started in place of the old one with the same
+ configuration parameters</li>
+ <li>preserve: The domain will remain in memory until it is destroyed
+ manually, it won't be running but allows for post-mortem debugging</li>
+ <li>rename-restart: a variant of the previous one but where the old domain
+ is renamed before being saved to allow a restart</li>
+ </ul>
+ <p>The following could be used for a Xen production system:</p>
+ <pre><domain>
+ ...
+ <on_reboot>restart</on_reboot>
+ <on_poweroff>destroy</on_poweroff>
+ <on_crash>rename-restart</on_crash>
+ ...
+</domain></pre>
+ <p>While the format may be extended in various ways as support for more
+hypervisor types and features are added, it is expected that this core subset
+will remain functional in spite of the evolution of the library.</p>
+
+ <h3 id="Fully"><a name="Fully1" id="Fully1">Fully virtualized guests</a></h3>
+ <p>There is a few things to notice specifically for HVM domains:</p>
+ <ul>
+ <li>the optional <code><features></code> block is used to enable
+ certain guest CPU / system features. For HVM guests the following
+ features are defined:
+ <ul><li><code>pae</code> - enable PAE memory addressing</li><li><code>apic</code> - enable IO APIC</li><li><code>acpi</code> - enable ACPI bios</li></ul></li>
+ <li>the optional <code><clock></code> element is used to specify
+ whether the emulated BIOS clock in the guest is synced to either
+ <code>localtime</code> or <code>utc</code>. In general Windows will
+ want <code>localtime</code> while all other operating systems will
+ want <code>utc</code>. The default is thus <code>utc</code></li>
+ <li>the <code><os></code> block description is very different, first
+ it indicates that the type is 'hvm' for hardware virtualization, then
+ instead of a kernel, boot and command line arguments, it points to an os
+ boot loader which will extract the boot information from the boot device
+ specified in a separate boot element. The <code>dev</code> attribute on
+ the <code>boot</code> tag can be one of:
+ <ul><li><code>fd</code> - boot from first floppy device</li><li><code>hd</code> - boot from first harddisk device</li><li><code>cdrom</code> - boot from first cdrom device</li></ul></li>
+ <li>the <code><devices></code> section includes an emulator entry
+ pointing to an additional program in charge of emulating the devices</li>
+ <li>the disk entry indicates in the dev target section that the emulation
+ for the drive is the first IDE disk device hda. The list of device names
+ supported is dependent on the Hypervisor, but for Xen it can be any IDE
+ device <code>hda</code>-<code>hdd</code>, or a floppy device
+ <code>fda</code>, <code>fdb</code>. The <code><disk></code> element
+ also supports a 'device' attribute to indicate what kinda of hardware to
+ emulate. The following values are supported:
+ <ul><li><code>floppy</code> - a floppy disk controller</li><li><code>disk</code> - a generic hard drive (the default it
+ omitted)</li><li><code>cdrom</code> - a CDROM device</li></ul>
+ For Xen 3.0.2 and earlier a CDROM device can only be emulated on the
+ <code>hdc</code> channel, while for 3.0.3 and later, it can be emulated
+ on any IDE channel.</li>
+ <li>the <code><devices></code> section also include at least one
+ entry for the graphic device used to render the os. Currently there is
+ just 2 types possible 'vnc' or 'sdl'. If the type is 'vnc', then an
+ additional <code>port</code> attribute will be present indicating the TCP
+ port on which the VNC server is accepting client connections.</li>
+ </ul>
+ <p>It is likely that the HVM description gets additional optional elements
+and attributes as the support for fully virtualized domain expands,
+especially for the variety of devices emulated and the graphic support
+options offered.</p>
+
+ <h3>
+ <a name="Net1" id="Net1">Networking interface options</a>
+ </h3>
+ <p>The networking support in the QEmu and KVM case is more flexible, and
+support a variety of options:</p>
+ <ol>
+ <li>Userspace SLIRP stack
+ <p>Provides a virtual LAN with NAT to the outside world. The virtual
+ network has DHCP & DNS services and will give the guest VM addresses
+ starting from <code>10.0.2.15</code>. The default router will be
+ <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
+ This networking is the only option for unprivileged users who need their
+ VMs to have outgoing access. Example configs are:</p>
+ <pre><interface type='user'/></pre>
+ <pre>
+<interface type='user'>
+ <mac address="11:22:33:44:55:66"/>
+</interface>
+ </pre>
+ </li>
+ <li>Virtual network
+ <p>Provides a virtual network using a bridge device in the host.
+ Depending on the virtual network configuration, the network may be
+ totally isolated, NAT'ing to an explicit network device, or NAT'ing to
+ the default route. DHCP and DNS are provided on the virtual network in
+ all cases and the IP range can be determined by examining the virtual
+ network config with '<code>virsh net-dumpxml <network
+ name></code>'. There is one virtual network called 'default' setup out
+ of the box which does NAT'ing to the default route and has an IP range of
+ <code>192.168.22.0/255.255.255.0</code>. Each guest will have an
+ associated tun device created with a name of vnetN, which can also be
+ overridden with the <target> element. Example configs are:</p>
+ <pre><interface type='network'>
+ <source network='default'/>
+</interface>
+
+<interface type='network'>
+ <source network='default'/>
+ <target dev='vnet7'/>
+ <mac address="11:22:33:44:55:66"/>
+</interface>
+ </pre>
+ </li>
+ <li>Bridge to to LAN
+ <p>Provides a bridge from the VM directly onto the LAN. This assumes
+ there is a bridge device on the host which has one or more of the hosts
+ physical NICs enslaved. The guest VM will have an associated tun device
+ created with a name of vnetN, which can also be overridden with the
+ <target> element. The tun device will be enslaved to the bridge.
+ The IP range / network configuration is whatever is used on the LAN. This
+ provides the guest VM full incoming & outgoing net access just like a
+ physical machine. Examples include:</p>
+ <pre><interface type='bridge'>
+ <source bridge='br0'/>
+</interface>
+
+<interface type='bridge'>
+ <source bridge='br0'/>
+ <target dev='vnet7'/>
+ <mac address="11:22:33:44:55:66"/>
+</interface></pre>
+ </li>
+ <li>Generic connection to LAN
+ <p>Provides a means for the administrator to execute an arbitrary script
+ to connect the guest's network to the LAN. The guest will have a tun
+ device created with a name of vnetN, which can also be overridden with the
+ <target> element. After creating the tun device a shell script will
+ be run which is expected to do whatever host network integration is
+ required. By default this script is called /etc/qemu-ifup but can be
+ overridden.</p>
+ <pre><interface type='ethernet'/>
+
+<interface type='ethernet'>
+ <target dev='vnet7'/>
+ <script path='/etc/qemu-ifup-mynet'/>
+</interface></pre>
+ </li>
+ <li>Multicast tunnel
+ <p>A multicast group is setup to represent a virtual network. Any VMs
+ whose network devices are in the same multicast group can talk to each
+ other even across hosts. This mode is also available to unprivileged
+ users. There is no default DNS or DHCP support and no outgoing network
+ access. To provide outgoing network access, one of the VMs should have a
+ 2nd NIC which is connected to one of the first 4 network types and do the
+ appropriate routing. The multicast protocol is compatible with that used
+ by user mode linux guests too. The source address used must be from the
+ multicast address block.</p>
+ <pre><interface type='mcast'>
+ <source address='230.0.0.1' port='5558'/>
+</interface></pre>
+ </li>
+ <li>TCP tunnel
+ <p>A TCP client/server architecture provides a virtual network. One VM
+ provides the server end of the network, all other VMS are configured as
+ clients. All network traffic is routed between the VMs via the server.
+ This mode is also available to unprivileged users. There is no default
+ DNS or DHCP support and no outgoing network access. To provide outgoing
+ network access, one of the VMs should have a 2nd NIC which is connected
+ to one of the first 4 network types and do the appropriate routing.</p>
+ <p>Example server config:</p>
+ <pre><interface type='server'>
+ <source address='192.168.0.1' port='5558'/>
+</interface></pre>
+ <p>Example client config:</p>
+ <pre><interface type='client'>
+ <source address='192.168.0.1' port='5558'/>
+</interface></pre>
+ </li>
+ </ol>
+ <p>To be noted, options 2, 3, 4 are also supported by Xen VMs, so it is
+possible to use these configs to have networking with both Xen &
+QEMU/KVMs connected to each other.</p>
+
+ <h2>Example configs</h2>
+
+ <p>
+ Example configurations for each driver are provide on the
+ driver specific pages listed below
+ </p>
+
+ <ul>
+ <li><a href="drvxen.html#xmlconfig">Xen examples</a></li>
+ <li><a href="drvqemu.html#xmlconfig">QEMU/KVM examples</a></li>
+ </ul>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from formatnetwork.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Network XML format</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Network XML format</h1>
+ <h2>Example configuration</h2>
+ <h3>NAT based network</h3>
+ <pre>
+ <network>
+ <name>default</name>
+ <bridge name="virbr0" />
+ <forward type="nat"/>
+ <ip address="192.168.122.1" netmask="255.255.255.0">
+ <dhcp>
+ <range start="192.168.122.2" end="192.168.122.254" />
+ </dhcp>
+ </ip>
+ </network></pre>
+ <h3>Routed network config</h3>
+ <pre>
+ <network>
+ <name>local</name>
+ <bridge name="virbr1" />
+ <forward type="route" dev="eth1"/>
+ <ip address="192.168.122.1" netmask="255.255.255.0">
+ <dhcp>
+ <range start="192.168.122.2" end="192.168.122.254" />
+ </dhcp>
+ </ip>
+ </network></pre>
+ <h3>Isolated network config</h3>
+ <pre>
+ <network>
+ <name>private</name>
+ <bridge name="virbr2" />
+ <ip address="192.168.152.1" netmask="255.255.255.0">
+ <dhcp>
+ <range start="192.168.152.2" end="192.168.152.254" />
+ </dhcp>
+ </ip>
+ </network></pre>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="active" href="format.html">XML format</a>
+ <ul class="l2"><li>
+ <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a>
+ </li><li>
+ <span class="active">Networks</span>
+ </li><li>
+ <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a>
+ </li><li>
+ <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a>
+ </li><li>
+ <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a>
+ </li></ul>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Network XML format</h1>
+
+
+ <h2>Example configuration</h2>
+
+ <h3>NAT based network</h3>
+
+ <pre>
+ <network>
+ <name>default</name>
+ <bridge name="virbr0" />
+ <forward type="nat"/>
+ <ip address="192.168.122.1" netmask="255.255.255.0">
+ <dhcp>
+ <range start="192.168.122.2" end="192.168.122.254" />
+ </dhcp>
+ </ip>
+ </network></pre>
+
+ <h3>Routed network config</h3>
+
+ <pre>
+ <network>
+ <name>local</name>
+ <bridge name="virbr1" />
+ <forward type="route" dev="eth1"/>
+ <ip address="192.168.122.1" netmask="255.255.255.0">
+ <dhcp>
+ <range start="192.168.122.2" end="192.168.122.254" />
+ </dhcp>
+ </ip>
+ </network></pre>
+
+ <h3>Isolated network config</h3>
+
+ <pre>
+ <network>
+ <name>private</name>
+ <bridge name="virbr2" />
+ <ip address="192.168.152.1" netmask="255.255.255.0">
+ <dhcp>
+ <range start="192.168.152.2" end="192.168.152.254" />
+ </dhcp>
+ </ip>
+ </network></pre>
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from formatnode.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Node devices XML format</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Node devices XML format</h1>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="active" href="format.html">XML format</a>
+ <ul class="l2"><li>
+ <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a>
+ </li><li>
+ <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a>
+ </li><li>
+ <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a>
+ </li><li>
+ <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a>
+ </li><li>
+ <span class="active">Node Devices</span>
+ </li></ul>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Node devices XML format</h1>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from formatstorage.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Storage pool and volume XML format</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Storage pool and volume XML format</h1>
+ <ul><li>
+ <a href="#StoragePool">Storage pool XML</a>
+ <ul><li>
+ <a href="#StoragePoolFirst">First level elements</a>
+ </li><li>
+ <a href="#StoragePoolSource">Source elements</a>
+ </li><li>
+ <a href="#StoragePoolTarget">Target elements</a>
+ </li><li>
+ <a href="#StoragePoolExtents">Device extents</a>
+ </li></ul></li><li>
+ <a href="#StorageVol">Storage volume XML</a>
+ <ul><li>
+ <a href="#StorageVolFirst">First level elements</a>
+ </li><li>
+ <a href="#StorageVolSource">Source elements</a>
+ </li><li>
+ <a href="#StorageVolTarget">Target elements</a>
+ </li></ul></li></ul>
+ <h3>
+ <a name="StoragePool" id="StoragePool">Storage pool XML</a>
+ </h3>
+ <p>
+Although all storage pool backends share the same public APIs and
+XML format, they have varying levels of capabilities. Some may
+allow creation of volumes, others may only allow use of pre-existing
+volumes. Some may have constraints on volume size, or placement.
+</p>
+ <p>The is the top level tag for a storage pool document is 'pool'. It has
+a single attribute <code>type</code>, which is one of <code>dir</code>,
+<code>fs</code>,<code>netfs</code>,<code>disk</code>,<code>iscsi</code>,
+<code>logical</code>. This corresponds to the storage backend drivers
+listed further along in this document.
+</p>
+ <h4>
+ <a name="StoragePoolFirst" id="StoragePoolFirst">First level elements</a>
+ </h4>
+ <dl><dt>name</dt><dd>Providing a name for the pool which is unique to the host.
+This is mandatory when defining a pool</dd><dt>uuid</dt><dd>Providing an identifier for the pool which is globally unique.
+This is optional when defining a pool, a UUID will be generated if
+omitted</dd><dt>allocation</dt><dd>Providing the total storage allocation for the pool. This may
+be larger than the sum of the allocation of all volumes due to
+metadata overhead. This value is in bytes. This is not applicable
+when creating a pool.</dd><dt>capacity</dt><dd>Providing the total storage capacity for the pool. Due to
+underlying device constraints it may not be possible to use the
+full capacity for storage volumes. This value is in bytes. This
+is not applicable when creating a pool.</dd><dt>available</dt><dd>Providing the free space available for allocating new volumes
+in the pool. Due to underlying device constraints it may not be
+possible to allocate the entire free space to a single volume.
+This value is in bytes. This is not applicable when creating a
+pool.</dd><dt>source</dt><dd>Provides information about the source of the pool, such as
+the underlying host devices, or remote server</dd><dt>target</dt><dd>Provides information about the representation of the pool
+on the local host.</dd></dl>
+ <h4>
+ <a name="StoragePoolSource" id="StoragePoolSource">Source elements</a>
+ </h4>
+ <dl><dt>device</dt><dd>Provides the source for pools backed by physical devices.
+May be repeated multiple times depending on backend driver. Contains
+a single attribute <code>path</code> which is the fully qualified
+path to the block device node.</dd><dt>directory</dt><dd>Provides the source for pools backed by directories. May
+only occur once. Contains a single attribute <code>path</code>
+which is the fully qualified path to the block device node.</dd><dt>host</dt><dd>Provides the source for pools backed by storage from a
+remote server. Will be used in combination with a <code>directory</code>
+or <code>device</code> element. Contains an attribute <code>name<code>
+which is the hostname or IP address of the server. May optionally
+contain a <code>port</code> attribute for the protocol specific
+port number.</code></code></dd><dt>format</dt><dd>Provides information about the format of the pool. This
+contains a single attribute <code>type</code> whose value is
+backend specific. This is typically used to indicate filesystem
+type, or network filesystem type, or partition table type, or
+LVM metadata type. All drivers are required to have a default
+value for this, so it is optional.</dd></dl>
+ <h4>
+ <a name="StoragePoolTarget" id="StoragePoolTarget">Target elements</a>
+ </h4>
+ <dl><dt>path</dt><dd>Provides the location at which the pool will be mapped into
+the local filesystem namespace. For a filesystem/directory based
+pool it will be the name of the directory in which volumes will
+be created. For device based pools it will be the name of the directory in which
+devices nodes exist. For the latter <code>/dev/</code> may seem
+like the logical choice, however, devices nodes there are not
+guaranteed stable across reboots, since they are allocated on
+demand. It is preferable to use a stable location such as one
+of the <code>/dev/disk/by-{path,id,uuid,label</code> locations.
+</dd><dt>permissions</dt><dd>Provides information about the default permissions to use
+when creating volumes. This is currently only useful for directory
+or filesystem based pools, where the volumes allocated are simple
+files. For pools where the volumes are device nodes, the hotplug
+scripts determine permissions. It contains 4 child elements. The
+<code>mode</code> element contains the octal permission set. The
+<code>owner</code> element contains the numeric user ID. The <code>group</code>
+element contains the numeric group ID. The <code>label</code> element
+contains the MAC (eg SELinux) label string.
+</dd></dl>
+ <h4>
+ <a name="StoragePoolExtents" id="StoragePoolExtents">Device extents</a>
+ </h4>
+ <p>
+If a storage pool exposes information about its underlying
+placement / allocation scheme, the <code>device</code> element
+within the <code>source</code> element may contain information
+about its available extents. Some pools have a constraint that
+a volume must be allocated entirely within a single constraint
+(eg disk partition pools). Thus the extent information allows an
+application to determine the maximum possible size for a new
+volume
+</p>
+ <p>
+For storage pools supporting extent information, within each
+<code>device</code> element there will be zero or more <code>freeExtent</code>
+elements. Each of these elements contains two attributes, <code>start</code>
+and <code>end</code> which provide the boundaries of the extent on the
+device, measured in bytes.
+</p>
+ <h3>
+ <a name="StorageVol" id="StorageVol">Storage volume XML</a>
+ </h3>
+ <p>
+A storage volume will be either a file or a device node.
+</p>
+ <h4>
+ <a name="StorageVolFirst" id="StorageVolFirst">First level elements</a>
+ </h4>
+ <dl><dt>name</dt><dd>Providing a name for the pool which is unique to the host.
+This is mandatory when defining a pool</dd><dt>uuid</dt><dd>Providing an identifier for the pool which is globally unique.
+This is optional when defining a pool, a UUID will be generated if
+omitted</dd><dt>allocation</dt><dd>Providing the total storage allocation for the volume. This
+may be smaller than the logical capacity if the volume is sparsely
+allocated. It may also be larger than the logical capacity if the
+volume has substantial metadata overhead. This value is in bytes.
+If omitted when creating a volume, the volume will be fully
+allocated at time of creation. If set to a value smaller than the
+capacity, the pool has the <strong>option</strong> of deciding
+to sparsely allocate a volume. It does not have to honour requests
+for sparse allocation though.</dd><dt>capacity</dt><dd>Providing the logical capacity for the volume. This value is
+in bytes. This is compulsory when creating a volume</dd><dt>source</dt><dd>Provides information about the underlying storage allocation
+of the volume. This may not be available for some pool types.</dd><dt>target</dt><dd>Provides information about the representation of the volume
+on the local host.</dd></dl>
+ <h4>
+ <a name="StorageVolTarget" id="StorageVolTarget">Target elements</a>
+ </h4>
+ <dl><dt>path</dt><dd>Provides the location at which the pool will be mapped into
+the local filesystem namespace. For a filesystem/directory based
+pool it will be the name of the directory in which volumes will
+be created. For device based pools it will be the name of the directory in which
+devices nodes exist. For the latter <code>/dev/</code> may seem
+like the logical choice, however, devices nodes there are not
+guaranteed stable across reboots, since they are allocated on
+demand. It is preferrable to use a stable location such as one
+of the <code>/dev/disk/by-{path,id,uuid,label</code> locations.
+</dd><dt>format</dt><dd>Provides information about the pool specific volume format.
+For disk pools it will provide the partition type. For filesystem
+or directory pools it will provide the file format type, eg cow,
+qcow, vmdk, raw. If omitted when creating a volume, the pool's
+default format will be used. The actual format is specified via
+the <code>type</code>. Consult the pool-specific docs for the
+list of valid values.</dd><dt>permissions</dt><dd>Provides information about the default permissions to use
+when creating volumes. This is currently only useful for directory
+or filesystem based pools, where the volumes allocated are simple
+files. For pools where the volumes are device nodes, the hotplug
+scripts determine permissions. It contains 4 child elements. The
+<code>mode</code> element contains the octal permission set. The
+<code>owner</code> element contains the numeric user ID. The <code>group</code>
+element contains the numeric group ID. The <code>label</code> element
+contains the MAC (eg SELinux) label string.
+</dd></dl>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="active" href="format.html">XML format</a>
+ <ul class="l2"><li>
+ <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a>
+ </li><li>
+ <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a>
+ </li><li>
+ <span class="active">Storage</span>
+ </li><li>
+ <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a>
+ </li><li>
+ <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a>
+ </li></ul>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Storage pool and volume XML format</h1>
+
+ <ul>
+ <li>
+ <a href="#StoragePool">Storage pool XML</a>
+ <ul>
+ <li>
+ <a href="#StoragePoolFirst">First level elements</a>
+ </li>
+ <li>
+ <a href="#StoragePoolSource">Source elements</a>
+ </li>
+ <li>
+ <a href="#StoragePoolTarget">Target elements</a>
+ </li>
+ <li>
+ <a href="#StoragePoolExtents">Device extents</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="#StorageVol">Storage volume XML</a>
+ <ul>
+ <li>
+ <a href="#StorageVolFirst">First level elements</a>
+ </li>
+ <li>
+ <a href="#StorageVolSource">Source elements</a>
+ </li>
+ <li>
+ <a href="#StorageVolTarget">Target elements</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+
+ <h3>
+ <a name="StoragePool" id="StoragePool">Storage pool XML</a>
+ </h3>
+ <p>
+Although all storage pool backends share the same public APIs and
+XML format, they have varying levels of capabilities. Some may
+allow creation of volumes, others may only allow use of pre-existing
+volumes. Some may have constraints on volume size, or placement.
+</p>
+ <p>The is the top level tag for a storage pool document is 'pool'. It has
+a single attribute <code>type</code>, which is one of <code>dir</code>,
+<code>fs</code>,<code>netfs</code>,<code>disk</code>,<code>iscsi</code>,
+<code>logical</code>. This corresponds to the storage backend drivers
+listed further along in this document.
+</p>
+ <h4>
+ <a name="StoragePoolFirst" id="StoragePoolFirst">First level elements</a>
+ </h4>
+ <dl>
+ <dt>name</dt>
+ <dd>Providing a name for the pool which is unique to the host.
+This is mandatory when defining a pool</dd>
+ <dt>uuid</dt>
+ <dd>Providing an identifier for the pool which is globally unique.
+This is optional when defining a pool, a UUID will be generated if
+omitted</dd>
+ <dt>allocation</dt>
+ <dd>Providing the total storage allocation for the pool. This may
+be larger than the sum of the allocation of all volumes due to
+metadata overhead. This value is in bytes. This is not applicable
+when creating a pool.</dd>
+ <dt>capacity</dt>
+ <dd>Providing the total storage capacity for the pool. Due to
+underlying device constraints it may not be possible to use the
+full capacity for storage volumes. This value is in bytes. This
+is not applicable when creating a pool.</dd>
+ <dt>available</dt>
+ <dd>Providing the free space available for allocating new volumes
+in the pool. Due to underlying device constraints it may not be
+possible to allocate the entire free space to a single volume.
+This value is in bytes. This is not applicable when creating a
+pool.</dd>
+ <dt>source</dt>
+ <dd>Provides information about the source of the pool, such as
+the underlying host devices, or remote server</dd>
+ <dt>target</dt>
+ <dd>Provides information about the representation of the pool
+on the local host.</dd>
+ </dl>
+ <h4>
+ <a name="StoragePoolSource" id="StoragePoolSource">Source elements</a>
+ </h4>
+ <dl>
+ <dt>device</dt>
+ <dd>Provides the source for pools backed by physical devices.
+May be repeated multiple times depending on backend driver. Contains
+a single attribute <code>path</code> which is the fully qualified
+path to the block device node.</dd>
+ <dt>directory</dt>
+ <dd>Provides the source for pools backed by directories. May
+only occur once. Contains a single attribute <code>path</code>
+which is the fully qualified path to the block device node.</dd>
+ <dt>host</dt>
+ <dd>Provides the source for pools backed by storage from a
+remote server. Will be used in combination with a <code>directory</code>
+or <code>device</code> element. Contains an attribute <code>name<code>
+which is the hostname or IP address of the server. May optionally
+contain a <code>port</code> attribute for the protocol specific
+port number.</code></code></dd>
+ <dt>format</dt>
+ <dd>Provides information about the format of the pool. This
+contains a single attribute <code>type</code> whose value is
+backend specific. This is typically used to indicate filesystem
+type, or network filesystem type, or partition table type, or
+LVM metadata type. All drivers are required to have a default
+value for this, so it is optional.</dd>
+ </dl>
+ <h4>
+ <a name="StoragePoolTarget" id="StoragePoolTarget">Target elements</a>
+ </h4>
+ <dl>
+ <dt>path</dt>
+ <dd>Provides the location at which the pool will be mapped into
+the local filesystem namespace. For a filesystem/directory based
+pool it will be the name of the directory in which volumes will
+be created. For device based pools it will be the name of the directory in which
+devices nodes exist. For the latter <code>/dev/</code> may seem
+like the logical choice, however, devices nodes there are not
+guaranteed stable across reboots, since they are allocated on
+demand. It is preferable to use a stable location such as one
+of the <code>/dev/disk/by-{path,id,uuid,label</code> locations.
+</dd>
+ <dt>permissions</dt>
+ <dd>Provides information about the default permissions to use
+when creating volumes. This is currently only useful for directory
+or filesystem based pools, where the volumes allocated are simple
+files. For pools where the volumes are device nodes, the hotplug
+scripts determine permissions. It contains 4 child elements. The
+<code>mode</code> element contains the octal permission set. The
+<code>owner</code> element contains the numeric user ID. The <code>group</code>
+element contains the numeric group ID. The <code>label</code> element
+contains the MAC (eg SELinux) label string.
+</dd>
+ </dl>
+ <h4>
+ <a name="StoragePoolExtents" id="StoragePoolExtents">Device extents</a>
+ </h4>
+ <p>
+If a storage pool exposes information about its underlying
+placement / allocation scheme, the <code>device</code> element
+within the <code>source</code> element may contain information
+about its available extents. Some pools have a constraint that
+a volume must be allocated entirely within a single constraint
+(eg disk partition pools). Thus the extent information allows an
+application to determine the maximum possible size for a new
+volume
+</p>
+ <p>
+For storage pools supporting extent information, within each
+<code>device</code> element there will be zero or more <code>freeExtent</code>
+elements. Each of these elements contains two attributes, <code>start</code>
+and <code>end</code> which provide the boundaries of the extent on the
+device, measured in bytes.
+</p>
+ <h3>
+ <a name="StorageVol" id="StorageVol">Storage volume XML</a>
+ </h3>
+ <p>
+A storage volume will be either a file or a device node.
+</p>
+ <h4>
+ <a name="StorageVolFirst" id="StorageVolFirst">First level elements</a>
+ </h4>
+ <dl>
+ <dt>name</dt>
+ <dd>Providing a name for the pool which is unique to the host.
+This is mandatory when defining a pool</dd>
+ <dt>uuid</dt>
+ <dd>Providing an identifier for the pool which is globally unique.
+This is optional when defining a pool, a UUID will be generated if
+omitted</dd>
+ <dt>allocation</dt>
+ <dd>Providing the total storage allocation for the volume. This
+may be smaller than the logical capacity if the volume is sparsely
+allocated. It may also be larger than the logical capacity if the
+volume has substantial metadata overhead. This value is in bytes.
+If omitted when creating a volume, the volume will be fully
+allocated at time of creation. If set to a value smaller than the
+capacity, the pool has the <strong>option</strong> of deciding
+to sparsely allocate a volume. It does not have to honour requests
+for sparse allocation though.</dd>
+ <dt>capacity</dt>
+ <dd>Providing the logical capacity for the volume. This value is
+in bytes. This is compulsory when creating a volume</dd>
+ <dt>source</dt>
+ <dd>Provides information about the underlying storage allocation
+of the volume. This may not be available for some pool types.</dd>
+ <dt>target</dt>
+ <dd>Provides information about the representation of the volume
+on the local host.</dd>
+ </dl>
+ <h4>
+ <a name="StorageVolTarget" id="StorageVolTarget">Target elements</a>
+ </h4>
+ <dl>
+ <dt>path</dt>
+ <dd>Provides the location at which the pool will be mapped into
+the local filesystem namespace. For a filesystem/directory based
+pool it will be the name of the directory in which volumes will
+be created. For device based pools it will be the name of the directory in which
+devices nodes exist. For the latter <code>/dev/</code> may seem
+like the logical choice, however, devices nodes there are not
+guaranteed stable across reboots, since they are allocated on
+demand. It is preferrable to use a stable location such as one
+of the <code>/dev/disk/by-{path,id,uuid,label</code> locations.
+</dd>
+ <dt>format</dt>
+ <dd>Provides information about the pool specific volume format.
+For disk pools it will provide the partition type. For filesystem
+or directory pools it will provide the file format type, eg cow,
+qcow, vmdk, raw. If omitted when creating a volume, the pool's
+default format will be used. The actual format is specified via
+the <code>type</code>. Consult the pool-specific docs for the
+list of valid values.</dd>
+ <dt>permissions</dt>
+ <dd>Provides information about the default permissions to use
+when creating volumes. This is currently only useful for directory
+or filesystem based pools, where the volumes allocated are simple
+files. For pools where the volumes are device nodes, the hotplug
+scripts determine permissions. It contains 4 child elements. The
+<code>mode</code> element contains the octal permission set. The
+<code>owner</code> element contains the numeric user ID. The <code>group</code>
+element contains the numeric group ID. The <code>label</code> element
+contains the MAC (eg SELinux) label string.
+</dd>
+ </dl>
+
+ </body>
+</html>
--- /dev/null
+
+body {
+ margin: 0em;
+ padding: 0px;
+ color: rgb(0,0,0);
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ font-size: 80%;
+// font-size: 83%;
+}
+
+p, ul, ol, dl {
+ padding: 0px;
+ margin: 0px;
+}
+
+ol,ul {
+ margin-left: 3em;
+}
+
+ol,ul,dl,p {
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+p:first-line {
+ margin-right: 1em;
+}
+
+div.body p:first-letter {
+ font-size: 1.2em;
+ font-weight: bold;
+}
+
+h1,h2,h3,h4,h5,h6 {
+ font-weight: bold;
+ margin: 0px;
+ padding: 0px;
+ margin-top: 0.5em;
+}
+
+div.footer {
+ margin-top: 1em;
+}
+
+h1 {
+ font-size: 2em;
+}
+h2 {
+ font-size: 1.6em;
+}
+h3 {
+ font-size: 1.4em;
+}
+h4 {
+ font-size: 1.2em;
+}
+h5 {
+ font-size: 1em;
+}
+h6 {
+ font-size: 0.8em;
+}
+
+dl dt {
+ margin-left: 1em;
+ margin-right: 2em;
+ font-weight: bold;
+ font-size: larger;
+}
+
+dl dd {
+ margin-left: 2em;
+ margin-right: 2em;
+ margin-bottom: 0.5em;
+}
+++ /dev/null
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reference Manual for libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reference Manual for libvirt</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvirt.html">libvirt</a>: core interfaces for the libvirt library</li><li><a href="libvirt-virterror.html">virterror</a>: error handling interfaces for the libvirt library</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a href="../html/index.html">API Menu</a></li><li><a href="../examples/index.html">C code examples</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reference Manual for libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reference Manual for libvirt</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvirt.html">libvirt</a>: core interfaces for the libvirt library</li><li><a href="libvirt-virterror.html">virterror</a>: error handling interfaces for the libvirt library</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a href="../html/index.html">API Menu</a></li><li><a href="../examples/index.html">C code examples</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml"><!--
+ This file is autogenerated from html/index.html.in
+ Do not edit this file. Changes will be lost.
+ --><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../main.css" /><link rel="SHORTCUT ICON" href="../32favicon.png" /><title>libvirt: Reference Manual for libvirt</title><meta name="description" content="libvirt, virtualization, virtualization API" /></head><body><div id="header"><div id="headerLogo"></div><div id="headerSearch"><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input id="query" name="query" type="text" size="12" value="" /><input id="submit" name="submit" type="submit" value="Search" /></form></div></div><div id="body"><div id="content"><h1>Reference Manual for libvirt</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvirt.html">libvirt</a>: core interfaces for the libvirt library</li><li><a href="libvirt-virterror.html">virterror</a>: error handling interfaces for the libvirt library</li></ul></div><div id="menu"><ul class="l0"><li><a title="Front page of the libvirt website" class="inactive" href="../index.html">Home</a></li><li><a title="Details of new features and bugs fixed in each release" class="inactive" href="../news.html">News</a></li><li><a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="../downloads.html">Downloads</a></li><li><a title="Information for users, administrators and developers" class="active" href="../docs.html">Documentation</a><ul class="l1"><li><a title="Information about deploying and using libvirt" class="inactive" href="../deployment.html">Deployment</a></li><li><a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="../intro.html">Architecture</a></li><li><a title="Description of the XML formats used in libvirt" class="inactive" href="../format.html">XML format</a></li><li><a title="Hypervisor specific driver information" class="inactive" href="../drivers.html">Drivers</a></li><li><span class="active">API reference</span><ul class="l2"><li><a title="core interfaces for the libvirt library" class="inactive" href="../html/libvirt-libvirt.html">libvirt</a></li><li><a title="error handling interfaces for the libvirt library" class="inactive" href="../html/libvirt-virterror.html">virterror</a></li><li><a title="matrix of API support per hypervisor per release" class="inactive" href="../hvsupport.html">Driver support</a></li></ul></li><li><a title="Bindings of the libvirt API for other languages" class="inactive" href="../bindings.html">Language bindings</a></li></ul></li><li><a title="User contributed content" class="inactive" href="../http://wiki.libvirt.org">Wiki</a></li><li><a title="Frequently asked questions" class="inactive" href="../FAQ.html">FAQ</a></li><li><a title="How and where to report bugs and request features" class="inactive" href="../bugs.html">Bug reports</a></li><li><a title="How to contact the developers via email and IRC" class="inactive" href="../contact.html">Contact</a></li><li><a title="Miscellaneous links of interest related to libvirt" class="inactive" href="../relatedlinks.html">Related Links</a></li><li><a title="Overview of all content on the website" class="inactive" href="../sitemap.html">Sitemap</a></li></ul></div></div><div id="footer"><div id="projects"><dl id="p1"><dt><a href="http://augeas.net/">Augeas</a></dt><dd><span>A configuration editing tool and API</span></dd><dt><a href="http://libvirt.org/">libvirt</a></dt><dd><span>The open source virtualization API</span></dd></dl><dl id="p2"><dt><a href="http://cobbler.et.redhat.com/">Cobbler</a></dt><dd><span>OS provisioning and profile management</span></dd><dt><a href="http://ovirt.org/">oVirt</a></dt><dd><span>Virtualization management across the data center</span></dd></dl><dl id="p3"><dt><a href="http://freeipa.org/">FreeIPA</a></dt><dd><span>Identity, policy and audit management</span></dd><dt><a href="http://virt-manager.org/">Virtual Machine Manager</a></dt><dd><span>Virtualization management from the desktop</span></dd></dl></div></div></body></html>
+++ /dev/null
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Module conf from libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Module conf from libvirt</h1><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libvirt-virterror.html"><img src="left.png" width="24" height="24" border="0" alt="Prev" /></a></td><th align="left"><a href="libvirt-virterror.html">virterror</a></th><td><a accesskey="u" href="index.html"><img src="up.png" width="24" height="24" border="0" alt="Up" /></a></td><th align="left"><a href="index.html">API documentation</a></th><td><a accesskey="h" href="../index.html"><img src="home.png" width="24" height="24" border="0" alt="Home" /></a></td><th align="center"><a href="../index.html">The virtualization API</a></th></tr></table><h2>Table of Contents</h2><pre class="programlisting">Structure <a href="#virConf">virConf</a><br />struct _virConf
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Typedef <a href="libvirt-conf.html#virConf">virConf</a> * <a name="virConfPtr" id="virConfPtr">virConfPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virConfType">virConfType</a>
-</pre><pre class="programlisting">Structure <a href="#virConfValue">virConfValue</a><br />struct _virConfValue
-</pre><pre class="programlisting">Typedef <a href="libvirt-conf.html#virConfValue">virConfValue</a> * <a name="virConfValuePtr" id="virConfValuePtr">virConfValuePtr</a>
-</pre><pre class="programlisting">int <a href="#virConfFree">virConfFree</a> (<a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)</pre>
-<pre class="programlisting"><a href="libvirt-conf.html#virConfValuePtr">virConfValuePtr</a> <a href="#virConfGetValue">virConfGetValue</a> (<a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf, <br /> const char * setting)</pre>
-<pre class="programlisting"><a href="libvirt-conf.html#virConfPtr">virConfPtr</a> <a href="#virConfReadFile">virConfReadFile</a> (const char * filename)</pre>
-<pre class="programlisting"><a href="libvirt-conf.html#virConfPtr">virConfPtr</a> <a href="#virConfReadMem">virConfReadMem</a> (const char * memory, <br /> int len)</pre>
-<pre class="programlisting">int <a href="#virConfWriteFile">virConfWriteFile</a> (const char * filename, <br /> <a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)</pre>
-<pre class="programlisting">int <a href="#virConfWriteMem">virConfWriteMem</a> (char * memory, <br /> int * len, <br /> <a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)</pre>
-<h2>Description</h2>
-<h3><a name="virConf" id="virConf">Structure virConf</a></h3><pre class="programlisting">Structure virConf<br />struct _virConf {
-The content of this structure is not made public by the API.
-}</pre>
- a pointer to a parsed configuration file
- <h3>Enum <a name="virConfType" id="virConfType">virConfType</a></h3><pre class="programlisting">Enum virConfType {
- <a name="VIR_CONF_NONE" id="VIR_CONF_NONE">VIR_CONF_NONE</a> = 0 : undefined
- <a name="VIR_CONF_LONG" id="VIR_CONF_LONG">VIR_CONF_LONG</a> = 1 : a long int
- <a name="VIR_CONF_STRING" id="VIR_CONF_STRING">VIR_CONF_STRING</a> = 2 : a string
- <a name="VIR_CONF_LIST" id="VIR_CONF_LIST">VIR_CONF_LIST</a> = 3 : a list
-}
-</pre><h3><a name="virConfValue" id="virConfValue">Structure virConfValue</a></h3><pre class="programlisting">Structure virConfValue<br />struct _virConfValue {
- <a href="libvirt-conf.html#virConfType">virConfType</a> type : the <a href="libvirt-conf.html#virConfType">virConfType</a>
- <a href="libvirt-conf.html#virConfValuePtr">virConfValuePtr</a> next : next element if in a list
- long l : long integer
- char * str : pointer to 0 terminated string
- <a href="libvirt-conf.html#virConfValuePtr">virConfValuePtr</a> list : list of a list
-}</pre><h3><a name="virConfFree" id="virConfFree"></a>Function: virConfFree</h3><pre class="programlisting">int virConfFree (<a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)<br />
-</pre><p>Frees all data associated to the handle</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conf</tt></i>:</span></td><td>a configuration file handle</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error.</td></tr></tbody></table></div><h3><a name="virConfGetValue" id="virConfGetValue"></a>Function: virConfGetValue</h3><pre class="programlisting"><a href="libvirt-conf.html#virConfValuePtr">virConfValuePtr</a> virConfGetValue (<a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf, <br /> const char * setting)<br />
-</pre><p>Lookup the value associated to this entry in the configuration file</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conf</tt></i>:</span></td><td>a configuration file handle</td></tr><tr><td><span class="term"><i><tt>setting</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the value or NULL if the lookup failed, the data associated will be freed when virConfFree() is called</td></tr></tbody></table></div><h3><a name="virConfReadFile" id="virConfReadFile"></a>Function: virConfReadFile</h3><pre class="programlisting"><a href="libvirt-conf.html#virConfPtr">virConfPtr</a> virConfReadFile (const char * filename)<br />
-</pre><p>Reads a configuration file.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>filename</tt></i>:</span></td><td>the path to the configuration file.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>an handle to lookup settings or NULL if it failed to read or parse the file, use virConfFree() to free the data.</td></tr></tbody></table></div><h3><a name="virConfReadMem" id="virConfReadMem"></a>Function: virConfReadMem</h3><pre class="programlisting"><a href="libvirt-conf.html#virConfPtr">virConfPtr</a> virConfReadMem (const char * memory, <br /> int len)<br />
-</pre><p>Reads a configuration file loaded in memory. The string can be zero terminated in which case @len can be 0</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>pointer to the content of the configuration file</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>length in byte</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>an handle to lookup settings or NULL if it failed to parse the content, use virConfFree() to free the data.</td></tr></tbody></table></div><h3><a name="virConfWriteFile" id="virConfWriteFile"></a>Function: virConfWriteFile</h3><pre class="programlisting">int virConfWriteFile (const char * filename, <br /> <a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)<br />
-</pre><p>Writes a configuration file back to a file.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>filename</tt></i>:</span></td><td>the path to the configuration file.</td></tr><tr><td><span class="term"><i><tt>conf</tt></i>:</span></td><td>the conf</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of bytes written or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virConfWriteMem" id="virConfWriteMem"></a>Function: virConfWriteMem</h3><pre class="programlisting">int virConfWriteMem (char * memory, <br /> int * len, <br /> <a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)<br />
-</pre><p>Writes a configuration file back to a memory area. @len is an IN/OUT parameter, it indicates the size available in bytes, and on output the size required for the configuration file (even if the call fails due to insufficient space).</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>pointer to the memory to store the config file</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>pointer to the length in byte of the store, on output the size</td></tr><tr><td><span class="term"><i><tt>conf</tt></i>:</span></td><td>the conf</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of bytes written or -1 in case of error.</td></tr></tbody></table></div></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a href="../html/index.html">API Menu</a></li><li><a href="../examples/index.html">C code examples</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+++ /dev/null
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reference Manual for libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reference Manual for libvirt</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvirt.html">libvirt</a>: core interfaces for the libvirt library</li><li><a href="libvirt-virterror.html">virterror</a>: error handling interfaces for the libvirt library</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a href="../html/index.html">API Menu</a></li><li><a href="../examples/index.html">C code examples</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Module libvirt from libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Module libvirt from libvirt</h1><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="u" href="index.html"><img src="up.png" width="24" height="24" border="0" alt="Up" /></a></td><th align="left"><a href="index.html">API documentation</a></th><td><a accesskey="h" href="../index.html"><img src="home.png" width="24" height="24" border="0" alt="Home" /></a></td><th align="center"><a href="../index.html">The virtualization API</a></th><th align="right"><a href="libvirt-virterror.html">virterror</a></th><td><a accesskey="n" href="libvirt-virterror.html"><img src="right.png" width="24" height="24" border="0" alt="Next" /></a></td></tr></table><p>Provides the interfaces of the libvirt library to handle Xen domains from a process running in domain 0 </p><h2>Table of Contents</h2><pre class="programlisting">#define <a href="#LIBVIR_VERSION_NUMBER">LIBVIR_VERSION_NUMBER</a></pre><pre class="programlisting">#define <a href="#VIR_COPY_CPUMAP">VIR_COPY_CPUMAP</a></pre><pre class="programlisting">#define <a href="#VIR_CPU_MAPLEN">VIR_CPU_MAPLEN</a></pre><pre class="programlisting">#define <a href="#VIR_CPU_USABLE">VIR_CPU_USABLE</a></pre><pre class="programlisting">#define <a href="#VIR_DOMAIN_SCHED_FIELD_LENGTH">VIR_DOMAIN_SCHED_FIELD_LENGTH</a></pre><pre class="programlisting">#define <a href="#VIR_GET_CPUMAP">VIR_GET_CPUMAP</a></pre><pre class="programlisting">#define <a href="#VIR_NODEINFO_MAXCPUS">VIR_NODEINFO_MAXCPUS</a></pre><pre class="programlisting">#define <a href="#VIR_UNUSE_CPU">VIR_UNUSE_CPU</a></pre><pre class="programlisting">#define <a href="#VIR_USE_CPU">VIR_USE_CPU</a></pre><pre class="programlisting">#define <a href="#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a></pre><pre class="programlisting">#define <a href="#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a></pre><pre class="programlisting">Structure <a href="#virConnect">virConnect</a><br />struct _virConnect
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Structure <a href="#virConnectAuth">virConnectAuth</a><br />struct _virConnectAuth
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virConnectAuth">virConnectAuth</a> * <a name="virConnectAuthPtr" id="virConnectAuthPtr">virConnectAuthPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virConnectCredential">virConnectCredential</a><br />struct _virConnectCredential
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virConnectCredential">virConnectCredential</a> * <a name="virConnectCredentialPtr" id="virConnectCredentialPtr">virConnectCredentialPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virConnectCredentialType">virConnectCredentialType</a>
-</pre><pre class="programlisting">Enum <a href="#virConnectFlags">virConnectFlags</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virConnect">virConnect</a> * <a name="virConnectPtr" id="virConnectPtr">virConnectPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virDomain">virDomain</a><br />struct _virDomain
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virDomainBlockStatsStruct">virDomainBlockStatsStruct</a> * <a name="virDomainBlockStatsPtr" id="virDomainBlockStatsPtr">virDomainBlockStatsPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virDomainBlockStatsStruct">virDomainBlockStatsStruct</a><br />struct _virDomainBlockStats
-</pre><pre class="programlisting">Enum <a href="#virDomainCreateFlags">virDomainCreateFlags</a>
-</pre><pre class="programlisting">Structure <a href="#virDomainInfo">virDomainInfo</a><br />struct _virDomainInfo
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virDomainInfo">virDomainInfo</a> * <a name="virDomainInfoPtr" id="virDomainInfoPtr">virDomainInfoPtr</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virDomainInterfaceStatsStruct">virDomainInterfaceStatsStruct</a> * <a name="virDomainInterfaceStatsPtr" id="virDomainInterfaceStatsPtr">virDomainInterfaceStatsPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virDomainInterfaceStatsStruct">virDomainInterfaceStatsStruct</a><br />struct _virDomainInterfaceStats
-</pre><pre class="programlisting">Enum <a href="#virDomainMigrateFlags">virDomainMigrateFlags</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virDomain">virDomain</a> * <a name="virDomainPtr" id="virDomainPtr">virDomainPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virDomainState">virDomainState</a>
-</pre><pre class="programlisting">Enum <a href="#virDomainXMLFlags">virDomainXMLFlags</a>
-</pre><pre class="programlisting">Structure <a href="#virNetwork">virNetwork</a><br />struct _virNetwork
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virNetwork">virNetwork</a> * <a name="virNetworkPtr" id="virNetworkPtr">virNetworkPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virNodeInfo">virNodeInfo</a><br />struct _virNodeInfo
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virNodeInfo">virNodeInfo</a> * <a name="virNodeInfoPtr" id="virNodeInfoPtr">virNodeInfoPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virSchedParameter">virSchedParameter</a><br />struct _virSchedParameter
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virSchedParameter">virSchedParameter</a> * <a name="virSchedParameterPtr" id="virSchedParameterPtr">virSchedParameterPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virSchedParameterType">virSchedParameterType</a>
-</pre><pre class="programlisting">Structure <a href="#virStoragePool">virStoragePool</a><br />struct _virStoragePool
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Enum <a href="#virStoragePoolBuildFlags">virStoragePoolBuildFlags</a>
-</pre><pre class="programlisting">Enum <a href="#virStoragePoolDeleteFlags">virStoragePoolDeleteFlags</a>
-</pre><pre class="programlisting">Structure <a href="#virStoragePoolInfo">virStoragePoolInfo</a><br />struct _virStoragePoolInfo
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virStoragePoolInfo">virStoragePoolInfo</a> * <a name="virStoragePoolInfoPtr" id="virStoragePoolInfoPtr">virStoragePoolInfoPtr</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virStoragePool">virStoragePool</a> * <a name="virStoragePoolPtr" id="virStoragePoolPtr">virStoragePoolPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virStoragePoolState">virStoragePoolState</a>
-</pre><pre class="programlisting">Structure <a href="#virStorageVol">virStorageVol</a><br />struct _virStorageVol
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Enum <a href="#virStorageVolDeleteFlags">virStorageVolDeleteFlags</a>
-</pre><pre class="programlisting">Structure <a href="#virStorageVolInfo">virStorageVolInfo</a><br />struct _virStorageVolInfo
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virStorageVolInfo">virStorageVolInfo</a> * <a name="virStorageVolInfoPtr" id="virStorageVolInfoPtr">virStorageVolInfoPtr</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virStorageVol">virStorageVol</a> * <a name="virStorageVolPtr" id="virStorageVolPtr">virStorageVolPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virStorageVolType">virStorageVolType</a>
-</pre><pre class="programlisting">Structure <a href="#virVcpuInfo">virVcpuInfo</a><br />struct _virVcpuInfo
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virVcpuInfo">virVcpuInfo</a> * <a name="virVcpuInfoPtr" id="virVcpuInfoPtr">virVcpuInfoPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virVcpuState">virVcpuState</a>
-</pre><pre class="programlisting">Function type: <a href="#virConnectAuthCallbackPtr">virConnectAuthCallbackPtr</a>
+<html xmlns="http://www.w3.org/1999/xhtml"><!--
+ This file is autogenerated from html/libvirt-libvirt.html.in
+ Do not edit this file. Changes will be lost.
+ --><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../main.css" /><link rel="SHORTCUT ICON" href="../32favicon.png" /><title>libvirt: Module libvirt from libvirt</title><meta name="description" content="libvirt, virtualization, virtualization API" /></head><body><div id="header"><div id="headerLogo"></div><div id="headerSearch"><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input id="query" name="query" type="text" size="12" value="" /><input id="submit" name="submit" type="submit" value="Search" /></form></div></div><div id="body"><div id="content"><h1>Module libvirt from libvirt</h1><p>Provides the interfaces of the libvirt library to handle Xen domains from a process running in domain 0 </p><h2>Table of Contents</h2><h3><a href="#macros">Macros</a></h3><pre>#define <a href="#LIBVIR_VERSION_NUMBER">LIBVIR_VERSION_NUMBER</a>
+#define <a href="#VIR_COPY_CPUMAP">VIR_COPY_CPUMAP</a>
+#define <a href="#VIR_CPU_MAPLEN">VIR_CPU_MAPLEN</a>
+#define <a href="#VIR_CPU_USABLE">VIR_CPU_USABLE</a>
+#define <a href="#VIR_DOMAIN_SCHED_FIELD_LENGTH">VIR_DOMAIN_SCHED_FIELD_LENGTH</a>
+#define <a href="#VIR_GET_CPUMAP">VIR_GET_CPUMAP</a>
+#define <a href="#VIR_NODEINFO_MAXCPUS">VIR_NODEINFO_MAXCPUS</a>
+#define <a href="#VIR_UNUSE_CPU">VIR_UNUSE_CPU</a>
+#define <a href="#VIR_USE_CPU">VIR_USE_CPU</a>
+#define <a href="#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a>
+#define <a href="#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a>
+</pre><h3><a href="#types">Types</a></h3><pre>typedef struct _virConnect <a href="#virConnect">virConnect</a>
+typedef struct _virConnectAuth <a href="#virConnectAuth">virConnectAuth</a>
+typedef <a href="libvirt-libvirt.html#virConnectAuth">virConnectAuth</a> * <a name="virConnectAuthPtr" id="virConnectAuthPtr">virConnectAuthPtr</a>
+typedef struct _virConnectCredential <a href="#virConnectCredential">virConnectCredential</a>
+typedef <a href="libvirt-libvirt.html#virConnectCredential">virConnectCredential</a> * <a name="virConnectCredentialPtr" id="virConnectCredentialPtr">virConnectCredentialPtr</a>
+typedef enum <a href="#virConnectCredentialType">virConnectCredentialType</a>
+typedef enum <a href="#virConnectFlags">virConnectFlags</a>
+typedef <a href="libvirt-libvirt.html#virConnect">virConnect</a> * <a name="virConnectPtr" id="virConnectPtr">virConnectPtr</a>
+typedef struct _virDomain <a href="#virDomain">virDomain</a>
+typedef <a href="libvirt-libvirt.html#virDomainBlockStatsStruct">virDomainBlockStatsStruct</a> * <a name="virDomainBlockStatsPtr" id="virDomainBlockStatsPtr">virDomainBlockStatsPtr</a>
+typedef struct _virDomainBlockStats <a href="#virDomainBlockStatsStruct">virDomainBlockStatsStruct</a>
+typedef enum <a href="#virDomainCreateFlags">virDomainCreateFlags</a>
+typedef struct _virDomainInfo <a href="#virDomainInfo">virDomainInfo</a>
+typedef <a href="libvirt-libvirt.html#virDomainInfo">virDomainInfo</a> * <a name="virDomainInfoPtr" id="virDomainInfoPtr">virDomainInfoPtr</a>
+typedef <a href="libvirt-libvirt.html#virDomainInterfaceStatsStruct">virDomainInterfaceStatsStruct</a> * <a name="virDomainInterfaceStatsPtr" id="virDomainInterfaceStatsPtr">virDomainInterfaceStatsPtr</a>
+typedef struct _virDomainInterfaceStats <a href="#virDomainInterfaceStatsStruct">virDomainInterfaceStatsStruct</a>
+typedef enum <a href="#virDomainMigrateFlags">virDomainMigrateFlags</a>
+typedef <a href="libvirt-libvirt.html#virDomain">virDomain</a> * <a name="virDomainPtr" id="virDomainPtr">virDomainPtr</a>
+typedef enum <a href="#virDomainState">virDomainState</a>
+typedef enum <a href="#virDomainXMLFlags">virDomainXMLFlags</a>
+typedef struct _virNetwork <a href="#virNetwork">virNetwork</a>
+typedef <a href="libvirt-libvirt.html#virNetwork">virNetwork</a> * <a name="virNetworkPtr" id="virNetworkPtr">virNetworkPtr</a>
+typedef struct _virNodeInfo <a href="#virNodeInfo">virNodeInfo</a>
+typedef <a href="libvirt-libvirt.html#virNodeInfo">virNodeInfo</a> * <a name="virNodeInfoPtr" id="virNodeInfoPtr">virNodeInfoPtr</a>
+typedef struct _virSchedParameter <a href="#virSchedParameter">virSchedParameter</a>
+typedef <a href="libvirt-libvirt.html#virSchedParameter">virSchedParameter</a> * <a name="virSchedParameterPtr" id="virSchedParameterPtr">virSchedParameterPtr</a>
+typedef enum <a href="#virSchedParameterType">virSchedParameterType</a>
+typedef struct _virStoragePool <a href="#virStoragePool">virStoragePool</a>
+typedef enum <a href="#virStoragePoolBuildFlags">virStoragePoolBuildFlags</a>
+typedef enum <a href="#virStoragePoolDeleteFlags">virStoragePoolDeleteFlags</a>
+typedef struct _virStoragePoolInfo <a href="#virStoragePoolInfo">virStoragePoolInfo</a>
+typedef <a href="libvirt-libvirt.html#virStoragePoolInfo">virStoragePoolInfo</a> * <a name="virStoragePoolInfoPtr" id="virStoragePoolInfoPtr">virStoragePoolInfoPtr</a>
+typedef <a href="libvirt-libvirt.html#virStoragePool">virStoragePool</a> * <a name="virStoragePoolPtr" id="virStoragePoolPtr">virStoragePoolPtr</a>
+typedef enum <a href="#virStoragePoolState">virStoragePoolState</a>
+typedef struct _virStorageVol <a href="#virStorageVol">virStorageVol</a>
+typedef enum <a href="#virStorageVolDeleteFlags">virStorageVolDeleteFlags</a>
+typedef struct _virStorageVolInfo <a href="#virStorageVolInfo">virStorageVolInfo</a>
+typedef <a href="libvirt-libvirt.html#virStorageVolInfo">virStorageVolInfo</a> * <a name="virStorageVolInfoPtr" id="virStorageVolInfoPtr">virStorageVolInfoPtr</a>
+typedef <a href="libvirt-libvirt.html#virStorageVol">virStorageVol</a> * <a name="virStorageVolPtr" id="virStorageVolPtr">virStorageVolPtr</a>
+typedef enum <a href="#virStorageVolType">virStorageVolType</a>
+typedef struct _virVcpuInfo <a href="#virVcpuInfo">virVcpuInfo</a>
+typedef <a href="libvirt-libvirt.html#virVcpuInfo">virVcpuInfo</a> * <a name="virVcpuInfoPtr" id="virVcpuInfoPtr">virVcpuInfoPtr</a>
+typedef enum <a href="#virVcpuState">virVcpuState</a>
+</pre><h3><a href="#functions">Functions</a></h3><pre>typedef <a href="#virConnectAuthCallbackPtr">virConnectAuthCallbackPtr</a>
int <a href="#virConnectAuthCallbackPtr">virConnectAuthCallbackPtr</a> (<a href="libvirt-libvirt.html#virConnectCredentialPtr">virConnectCredentialPtr</a> cred, <br /> unsigned int ncred, <br /> void * cbdata)
-</pre>
-<pre class="programlisting">int <a href="#virConnectClose">virConnectClose</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">char * <a href="#virConnectGetCapabilities">virConnectGetCapabilities</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">char * <a href="#virConnectGetHostname">virConnectGetHostname</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int <a href="#virConnectGetMaxVcpus">virConnectGetMaxVcpus</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * type)</pre>
-<pre class="programlisting">const char * <a href="#virConnectGetType">virConnectGetType</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">char * <a href="#virConnectGetURI">virConnectGetURI</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int <a href="#virConnectGetVersion">virConnectGetVersion</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> unsigned long * hvVer)</pre>
-<pre class="programlisting">int <a href="#virConnectListDefinedDomains">virConnectListDefinedDomains</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)</pre>
-<pre class="programlisting">int <a href="#virConnectListDefinedNetworks">virConnectListDefinedNetworks</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)</pre>
-<pre class="programlisting">int <a href="#virConnectListDefinedStoragePools">virConnectListDefinedStoragePools</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)</pre>
-<pre class="programlisting">int <a href="#virConnectListDomains">virConnectListDomains</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> int * ids, <br /> int maxids)</pre>
-<pre class="programlisting">int <a href="#virConnectListNetworks">virConnectListNetworks</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)</pre>
-<pre class="programlisting">int <a href="#virConnectListStoragePools">virConnectListStoragePools</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)</pre>
-<pre class="programlisting">int <a href="#virConnectNumOfDefinedDomains">virConnectNumOfDefinedDomains</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int <a href="#virConnectNumOfDefinedNetworks">virConnectNumOfDefinedNetworks</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int <a href="#virConnectNumOfDefinedStoragePools">virConnectNumOfDefinedStoragePools</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int <a href="#virConnectNumOfDomains">virConnectNumOfDomains</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int <a href="#virConnectNumOfNetworks">virConnectNumOfNetworks</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int <a href="#virConnectNumOfStoragePools">virConnectNumOfStoragePools</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virConnectOpen">virConnectOpen</a> (const char * name)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virConnectOpenAuth">virConnectOpenAuth</a> (const char * name, <br /> <a href="libvirt-libvirt.html#virConnectAuthPtr">virConnectAuthPtr</a> auth, <br /> int flags)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virConnectOpenReadOnly">virConnectOpenReadOnly</a> (const char * name)</pre>
-<pre class="programlisting">int <a href="#virDomainAttachDevice">virDomainAttachDevice</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * xml)</pre>
-<pre class="programlisting">int <a href="#virDomainBlockStats">virDomainBlockStats</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br /> const char * path, <br /> <a href="libvirt-libvirt.html#virDomainBlockStatsPtr">virDomainBlockStatsPtr</a> stats, <br /> size_t size)</pre>
-<pre class="programlisting">int <a href="#virDomainCoreDump">virDomainCoreDump</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * to, <br /> int flags)</pre>
-<pre class="programlisting">int <a href="#virDomainCreate">virDomainCreate</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainCreateLinux">virDomainCreateLinux</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc, <br /> unsigned int flags)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainDefineXML">virDomainDefineXML</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml)</pre>
-<pre class="programlisting">int <a href="#virDomainDestroy">virDomainDestroy</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int <a href="#virDomainDetachDevice">virDomainDetachDevice</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * xml)</pre>
-<pre class="programlisting">int <a href="#virDomainFree">virDomainFree</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int <a href="#virDomainGetAutostart">virDomainGetAutostart</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int * autostart)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virDomainGetConnect">virDomainGetConnect</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom)</pre>
-<pre class="programlisting">unsigned int <a href="#virDomainGetID">virDomainGetID</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int <a href="#virDomainGetInfo">virDomainGetInfo</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virDomainInfoPtr">virDomainInfoPtr</a> info)</pre>
-<pre class="programlisting">unsigned long <a href="#virDomainGetMaxMemory">virDomainGetMaxMemory</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int <a href="#virDomainGetMaxVcpus">virDomainGetMaxVcpus</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">const char * <a href="#virDomainGetName">virDomainGetName</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">char * <a href="#virDomainGetOSType">virDomainGetOSType</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int <a href="#virDomainGetSchedulerParameters">virDomainGetSchedulerParameters</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br /> int * nparams)</pre>
-<pre class="programlisting">char * <a href="#virDomainGetSchedulerType">virDomainGetSchedulerType</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int * nparams)</pre>
-<pre class="programlisting">int <a href="#virDomainGetUUID">virDomainGetUUID</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned char * uuid)</pre>
-<pre class="programlisting">int <a href="#virDomainGetUUIDString">virDomainGetUUIDString</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> char * buf)</pre>
-<pre class="programlisting">int <a href="#virDomainGetVcpus">virDomainGetVcpus</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virVcpuInfoPtr">virVcpuInfoPtr</a> info, <br /> int maxinfo, <br /> unsigned char * cpumaps, <br /> int maplen)</pre>
-<pre class="programlisting">char * <a href="#virDomainGetXMLDesc">virDomainGetXMLDesc</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int flags)</pre>
-<pre class="programlisting">int <a href="#virDomainInterfaceStats">virDomainInterfaceStats</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br /> const char * path, <br /> <a href="libvirt-libvirt.html#virDomainInterfaceStatsPtr">virDomainInterfaceStatsPtr</a> stats, <br /> size_t size)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainLookupByID">virDomainLookupByID</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> int id)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainLookupByName">virDomainLookupByName</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainLookupByUUID">virDomainLookupByUUID</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainLookupByUUIDString">virDomainLookupByUUIDString</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainMigrate">virDomainMigrate</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> dconn, <br /> unsigned long flags, <br /> const char * dname, <br /> const char * uri, <br /> unsigned long bandwidth)</pre>
-<pre class="programlisting">int <a href="#virDomainPinVcpu">virDomainPinVcpu</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int vcpu, <br /> unsigned char * cpumap, <br /> int maplen)</pre>
-<pre class="programlisting">int <a href="#virDomainReboot">virDomainReboot</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int flags)</pre>
-<pre class="programlisting">int <a href="#virDomainRestore">virDomainRestore</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * from)</pre>
-<pre class="programlisting">int <a href="#virDomainResume">virDomainResume</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int <a href="#virDomainSave">virDomainSave</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * to)</pre>
-<pre class="programlisting">int <a href="#virDomainSetAutostart">virDomainSetAutostart</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int autostart)</pre>
-<pre class="programlisting">int <a href="#virDomainSetMaxMemory">virDomainSetMaxMemory</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned long memory)</pre>
-<pre class="programlisting">int <a href="#virDomainSetMemory">virDomainSetMemory</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned long memory)</pre>
-<pre class="programlisting">int <a href="#virDomainSetSchedulerParameters">virDomainSetSchedulerParameters</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br /> int nparams)</pre>
-<pre class="programlisting">int <a href="#virDomainSetVcpus">virDomainSetVcpus</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int nvcpus)</pre>
-<pre class="programlisting">int <a href="#virDomainShutdown">virDomainShutdown</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int <a href="#virDomainSuspend">virDomainSuspend</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int <a href="#virDomainUndefine">virDomainUndefine</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int <a href="#virGetVersion">virGetVersion</a> (unsigned long * libVer, <br /> const char * type, <br /> unsigned long * typeVer)</pre>
-<pre class="programlisting">int <a href="#virInitialize">virInitialize</a> (void)</pre>
-<pre class="programlisting">int <a href="#virNetworkCreate">virNetworkCreate</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> <a href="#virNetworkCreateXML">virNetworkCreateXML</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> <a href="#virNetworkDefineXML">virNetworkDefineXML</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml)</pre>
-<pre class="programlisting">int <a href="#virNetworkDestroy">virNetworkDestroy</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting">int <a href="#virNetworkFree">virNetworkFree</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting">int <a href="#virNetworkGetAutostart">virNetworkGetAutostart</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int * autostart)</pre>
-<pre class="programlisting">char * <a href="#virNetworkGetBridgeName">virNetworkGetBridgeName</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virNetworkGetConnect">virNetworkGetConnect</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net)</pre>
-<pre class="programlisting">const char * <a href="#virNetworkGetName">virNetworkGetName</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting">int <a href="#virNetworkGetUUID">virNetworkGetUUID</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> unsigned char * uuid)</pre>
-<pre class="programlisting">int <a href="#virNetworkGetUUIDString">virNetworkGetUUIDString</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> char * buf)</pre>
-<pre class="programlisting">char * <a href="#virNetworkGetXMLDesc">virNetworkGetXMLDesc</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int flags)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> <a href="#virNetworkLookupByName">virNetworkLookupByName</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> <a href="#virNetworkLookupByUUID">virNetworkLookupByUUID</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> <a href="#virNetworkLookupByUUIDString">virNetworkLookupByUUIDString</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)</pre>
-<pre class="programlisting">int <a href="#virNetworkSetAutostart">virNetworkSetAutostart</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int autostart)</pre>
-<pre class="programlisting">int <a href="#virNetworkUndefine">virNetworkUndefine</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting">int <a href="#virNodeGetCellsFreeMemory">virNodeGetCellsFreeMemory</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> unsigned long long * freeMems, <br /> int startCell, <br /> int maxCells)</pre>
-<pre class="programlisting">unsigned long long <a href="#virNodeGetFreeMemory">virNodeGetFreeMemory</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int <a href="#virNodeGetInfo">virNodeGetInfo</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> <a href="libvirt-libvirt.html#virNodeInfoPtr">virNodeInfoPtr</a> info)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolBuild">virStoragePoolBuild</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolCreate">virStoragePoolCreate</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolCreateXML">virStoragePoolCreateXML</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc, <br /> unsigned int flags)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolDefineXML">virStoragePoolDefineXML</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml, <br /> unsigned int flags)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolDelete">virStoragePoolDelete</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolDestroy">virStoragePoolDestroy</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolFree">virStoragePoolFree</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolGetAutostart">virStoragePoolGetAutostart</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> int * autostart)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virStoragePoolGetConnect">virStoragePoolGetConnect</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolGetInfo">virStoragePoolGetInfo</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> <a href="libvirt-libvirt.html#virStoragePoolInfoPtr">virStoragePoolInfoPtr</a> info)</pre>
-<pre class="programlisting">const char * <a href="#virStoragePoolGetName">virStoragePoolGetName</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolGetUUID">virStoragePoolGetUUID</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned char * uuid)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolGetUUIDString">virStoragePoolGetUUIDString</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> char * buf)</pre>
-<pre class="programlisting">char * <a href="#virStoragePoolGetXMLDesc">virStoragePoolGetXMLDesc</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolListVolumes">virStoragePoolListVolumes</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> char ** const names, <br /> int maxnames)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolLookupByName">virStoragePoolLookupByName</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolLookupByUUID">virStoragePoolLookupByUUID</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolLookupByUUIDString">virStoragePoolLookupByUUIDString</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolLookupByVolume">virStoragePoolLookupByVolume</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolNumOfVolumes">virStoragePoolNumOfVolumes</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolRefresh">virStoragePoolRefresh</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolSetAutostart">virStoragePoolSetAutostart</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> int autostart)</pre>
-<pre class="programlisting">int <a href="#virStoragePoolUndefine">virStoragePoolUndefine</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> <a href="#virStorageVolCreateXML">virStorageVolCreateXML</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> const char * xmldesc, <br /> unsigned int flags)</pre>
-<pre class="programlisting">int <a href="#virStorageVolDelete">virStorageVolDelete</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> unsigned int flags)</pre>
-<pre class="programlisting">int <a href="#virStorageVolFree">virStorageVolFree</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virStorageVolGetConnect">virStorageVolGetConnect</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting">int <a href="#virStorageVolGetInfo">virStorageVolGetInfo</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> <a href="libvirt-libvirt.html#virStorageVolInfoPtr">virStorageVolInfoPtr</a> info)</pre>
-<pre class="programlisting">const char * <a href="#virStorageVolGetKey">virStorageVolGetKey</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting">const char * <a href="#virStorageVolGetName">virStorageVolGetName</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting">char * <a href="#virStorageVolGetPath">virStorageVolGetPath</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting">char * <a href="#virStorageVolGetXMLDesc">virStorageVolGetXMLDesc</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> unsigned int flags)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> <a href="#virStorageVolLookupByKey">virStorageVolLookupByKey</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * key)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> <a href="#virStorageVolLookupByName">virStorageVolLookupByName</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> const char * name)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> <a href="#virStorageVolLookupByPath">virStorageVolLookupByPath</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * path)</pre>
-<h2>Description</h2>
-<h3><a name="LIBVIR_VERSION_NUMBER" id="LIBVIR_VERSION_NUMBER"></a>Macro: LIBVIR_VERSION_NUMBER</h3><pre>#define LIBVIR_VERSION_NUMBER</pre><p>Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro</p>
-<h3><a name="VIR_COPY_CPUMAP" id="VIR_COPY_CPUMAP"></a>Macro: VIR_COPY_CPUMAP</h3><pre>#define VIR_COPY_CPUMAP</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. <a href="libvirt-libvirt.html#VIR_COPY_CPUMAP">VIR_COPY_CPUMAP</a> macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.</p>
-<h3><a name="VIR_CPU_MAPLEN" id="VIR_CPU_MAPLEN"></a>Macro: VIR_CPU_MAPLEN</h3><pre>#define VIR_CPU_MAPLEN</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual & all physical CPUs of a domain.</p>
-<h3><a name="VIR_CPU_USABLE" id="VIR_CPU_USABLE"></a>Macro: VIR_CPU_USABLE</h3><pre>#define VIR_CPU_USABLE</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() API. <a href="libvirt-libvirt.html#VIR_CPU_USABLE">VIR_CPU_USABLE</a> macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.</p>
-<h3><a name="VIR_DOMAIN_SCHED_FIELD_LENGTH" id="VIR_DOMAIN_SCHED_FIELD_LENGTH"></a>Macro: VIR_DOMAIN_SCHED_FIELD_LENGTH</h3><pre>#define VIR_DOMAIN_SCHED_FIELD_LENGTH</pre><p>Macro providing the field length of <a href="libvirt-libvirt.html#virSchedParameter">virSchedParameter</a></p>
-<h3><a name="VIR_GET_CPUMAP" id="VIR_GET_CPUMAP"></a>Macro: VIR_GET_CPUMAP</h3><pre>#define VIR_GET_CPUMAP</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. <a href="libvirt-libvirt.html#VIR_GET_CPUMAP">VIR_GET_CPUMAP</a> macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.</p>
-<h3><a name="VIR_NODEINFO_MAXCPUS" id="VIR_NODEINFO_MAXCPUS"></a>Macro: VIR_NODEINFO_MAXCPUS</h3><pre>#define VIR_NODEINFO_MAXCPUS</pre><p>This macro is to calculate the total number of CPUs supported but not necessary active in the host.</p>
-<h3><a name="VIR_UNUSE_CPU" id="VIR_UNUSE_CPU"></a>Macro: VIR_UNUSE_CPU</h3><pre>#define VIR_UNUSE_CPU</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.</p>
-<h3><a name="VIR_USE_CPU" id="VIR_USE_CPU"></a>Macro: VIR_USE_CPU</h3><pre>#define VIR_USE_CPU</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.</p>
-<h3><a name="VIR_UUID_BUFLEN" id="VIR_UUID_BUFLEN"></a>Macro: VIR_UUID_BUFLEN</h3><pre>#define VIR_UUID_BUFLEN</pre><p>This macro provides the length of the buffer required for virDomainGetUUID()</p>
-<h3><a name="VIR_UUID_STRING_BUFLEN" id="VIR_UUID_STRING_BUFLEN"></a>Macro: VIR_UUID_STRING_BUFLEN</h3><pre>#define VIR_UUID_STRING_BUFLEN</pre><p>This macro provides the length of the buffer required for virDomainGetUUIDString()</p>
-<h3><a name="virConnect" id="virConnect">Structure virConnect</a></h3><pre class="programlisting">Structure virConnect<br />struct _virConnect {
-The content of this structure is not made public by the API.
-}</pre><h3><a name="virConnectAuth" id="virConnectAuth">Structure virConnectAuth</a></h3><pre class="programlisting">Structure virConnectAuth<br />struct _virConnectAuth {
- int * credtype : List of supported virConnectCredentialT
- unsigned int ncredtype
- <a href="libvirt-libvirt.html#virConnectAuthCallbackPtr">virConnectAuthCallbackPtr</a> cb : Callback used to collect credentials
- void * cbdata
-}</pre><h3><a name="virConnectCredential" id="virConnectCredential">Structure virConnectCredential</a></h3><pre class="programlisting">Structure virConnectCredential<br />struct _virConnectCredential {
- int type : One of <a href="libvirt-libvirt.html#virConnectCredentialType">virConnectCredentialType</a> constan
- const char * prompt : Prompt to show to user
- const char * challenge : Additional challenge to show
- const char * defresult : Optional default result
- char * result : Result to be filled with user response
- unsigned int resultlen : Length of the result
-}</pre><h3>Enum <a name="virConnectCredentialType" id="virConnectCredentialType">virConnectCredentialType</a></h3><pre class="programlisting">Enum virConnectCredentialType {
- <a name="VIR_CRED_USERNAME" id="VIR_CRED_USERNAME">VIR_CRED_USERNAME</a> = 1 : Identity to act as
- <a name="VIR_CRED_AUTHNAME" id="VIR_CRED_AUTHNAME">VIR_CRED_AUTHNAME</a> = 2 : Identify to authorize as
- <a name="VIR_CRED_LANGUAGE" id="VIR_CRED_LANGUAGE">VIR_CRED_LANGUAGE</a> = 3 : RFC 1766 languages, comma separated
- <a name="VIR_CRED_CNONCE" id="VIR_CRED_CNONCE">VIR_CRED_CNONCE</a> = 4 : client supplies a nonce
- <a name="VIR_CRED_PASSPHRASE" id="VIR_CRED_PASSPHRASE">VIR_CRED_PASSPHRASE</a> = 5 : Passphrase secret
- <a name="VIR_CRED_ECHOPROMPT" id="VIR_CRED_ECHOPROMPT">VIR_CRED_ECHOPROMPT</a> = 6 : Challenge response
- <a name="VIR_CRED_NOECHOPROMPT" id="VIR_CRED_NOECHOPROMPT">VIR_CRED_NOECHOPROMPT</a> = 7 : Challenge response
- <a name="VIR_CRED_REALM" id="VIR_CRED_REALM">VIR_CRED_REALM</a> = 8 : Authentication realm
- <a name="VIR_CRED_EXTERNAL" id="VIR_CRED_EXTERNAL">VIR_CRED_EXTERNAL</a> = 9 : Externally managed credential More may be added - expect the unexpected
+
+int <a href="#virConnectClose">virConnectClose</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+char * <a href="#virConnectGetCapabilities">virConnectGetCapabilities</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+char * <a href="#virConnectGetHostname">virConnectGetHostname</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int <a href="#virConnectGetMaxVcpus">virConnectGetMaxVcpus</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * type)
+const char * <a href="#virConnectGetType">virConnectGetType</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+char * <a href="#virConnectGetURI">virConnectGetURI</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int <a href="#virConnectGetVersion">virConnectGetVersion</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> unsigned long * hvVer)
+int <a href="#virConnectListDefinedDomains">virConnectListDefinedDomains</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)
+int <a href="#virConnectListDefinedNetworks">virConnectListDefinedNetworks</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)
+int <a href="#virConnectListDefinedStoragePools">virConnectListDefinedStoragePools</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)
+int <a href="#virConnectListDomains">virConnectListDomains</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> int * ids, <br /> int maxids)
+int <a href="#virConnectListNetworks">virConnectListNetworks</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)
+int <a href="#virConnectListStoragePools">virConnectListStoragePools</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)
+int <a href="#virConnectNumOfDefinedDomains">virConnectNumOfDefinedDomains</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int <a href="#virConnectNumOfDefinedNetworks">virConnectNumOfDefinedNetworks</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int <a href="#virConnectNumOfDefinedStoragePools">virConnectNumOfDefinedStoragePools</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int <a href="#virConnectNumOfDomains">virConnectNumOfDomains</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int <a href="#virConnectNumOfNetworks">virConnectNumOfNetworks</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int <a href="#virConnectNumOfStoragePools">virConnectNumOfStoragePools</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virConnectOpen">virConnectOpen</a> (const char * name)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virConnectOpenAuth">virConnectOpenAuth</a> (const char * name, <br /> <a href="libvirt-libvirt.html#virConnectAuthPtr">virConnectAuthPtr</a> auth, <br /> int flags)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virConnectOpenReadOnly">virConnectOpenReadOnly</a> (const char * name)
+int <a href="#virDomainAttachDevice">virDomainAttachDevice</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * xml)
+int <a href="#virDomainBlockStats">virDomainBlockStats</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br /> const char * path, <br /> <a href="libvirt-libvirt.html#virDomainBlockStatsPtr">virDomainBlockStatsPtr</a> stats, <br /> size_t size)
+int <a href="#virDomainCoreDump">virDomainCoreDump</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * to, <br /> int flags)
+int <a href="#virDomainCreate">virDomainCreate</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainCreateLinux">virDomainCreateLinux</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc, <br /> unsigned int flags)
+<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainDefineXML">virDomainDefineXML</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml)
+int <a href="#virDomainDestroy">virDomainDestroy</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int <a href="#virDomainDetachDevice">virDomainDetachDevice</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * xml)
+int <a href="#virDomainFree">virDomainFree</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int <a href="#virDomainGetAutostart">virDomainGetAutostart</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int * autostart)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virDomainGetConnect">virDomainGetConnect</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom)
+unsigned int <a href="#virDomainGetID">virDomainGetID</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int <a href="#virDomainGetInfo">virDomainGetInfo</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virDomainInfoPtr">virDomainInfoPtr</a> info)
+unsigned long <a href="#virDomainGetMaxMemory">virDomainGetMaxMemory</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int <a href="#virDomainGetMaxVcpus">virDomainGetMaxVcpus</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+const char * <a href="#virDomainGetName">virDomainGetName</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+char * <a href="#virDomainGetOSType">virDomainGetOSType</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int <a href="#virDomainGetSchedulerParameters">virDomainGetSchedulerParameters</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br /> int * nparams)
+char * <a href="#virDomainGetSchedulerType">virDomainGetSchedulerType</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int * nparams)
+int <a href="#virDomainGetUUID">virDomainGetUUID</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned char * uuid)
+int <a href="#virDomainGetUUIDString">virDomainGetUUIDString</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> char * buf)
+int <a href="#virDomainGetVcpus">virDomainGetVcpus</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virVcpuInfoPtr">virVcpuInfoPtr</a> info, <br /> int maxinfo, <br /> unsigned char * cpumaps, <br /> int maplen)
+char * <a href="#virDomainGetXMLDesc">virDomainGetXMLDesc</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int flags)
+int <a href="#virDomainInterfaceStats">virDomainInterfaceStats</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br /> const char * path, <br /> <a href="libvirt-libvirt.html#virDomainInterfaceStatsPtr">virDomainInterfaceStatsPtr</a> stats, <br /> size_t size)
+<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainLookupByID">virDomainLookupByID</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> int id)
+<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainLookupByName">virDomainLookupByName</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)
+<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainLookupByUUID">virDomainLookupByUUID</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)
+<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainLookupByUUIDString">virDomainLookupByUUIDString</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)
+<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainMigrate">virDomainMigrate</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> dconn, <br /> unsigned long flags, <br /> const char * dname, <br /> const char * uri, <br /> unsigned long bandwidth)
+int <a href="#virDomainPinVcpu">virDomainPinVcpu</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int vcpu, <br /> unsigned char * cpumap, <br /> int maplen)
+int <a href="#virDomainReboot">virDomainReboot</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int flags)
+int <a href="#virDomainRestore">virDomainRestore</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * from)
+int <a href="#virDomainResume">virDomainResume</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int <a href="#virDomainSave">virDomainSave</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * to)
+int <a href="#virDomainSetAutostart">virDomainSetAutostart</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int autostart)
+int <a href="#virDomainSetMaxMemory">virDomainSetMaxMemory</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned long memory)
+int <a href="#virDomainSetMemory">virDomainSetMemory</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned long memory)
+int <a href="#virDomainSetSchedulerParameters">virDomainSetSchedulerParameters</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br /> int nparams)
+int <a href="#virDomainSetVcpus">virDomainSetVcpus</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int nvcpus)
+int <a href="#virDomainShutdown">virDomainShutdown</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int <a href="#virDomainSuspend">virDomainSuspend</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int <a href="#virDomainUndefine">virDomainUndefine</a> (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int <a href="#virGetVersion">virGetVersion</a> (unsigned long * libVer, <br /> const char * type, <br /> unsigned long * typeVer)
+int <a href="#virInitialize">virInitialize</a> (void)
+int <a href="#virNetworkCreate">virNetworkCreate</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> <a href="#virNetworkCreateXML">virNetworkCreateXML</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc)
+<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> <a href="#virNetworkDefineXML">virNetworkDefineXML</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml)
+int <a href="#virNetworkDestroy">virNetworkDestroy</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+int <a href="#virNetworkFree">virNetworkFree</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+int <a href="#virNetworkGetAutostart">virNetworkGetAutostart</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int * autostart)
+char * <a href="#virNetworkGetBridgeName">virNetworkGetBridgeName</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virNetworkGetConnect">virNetworkGetConnect</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net)
+const char * <a href="#virNetworkGetName">virNetworkGetName</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+int <a href="#virNetworkGetUUID">virNetworkGetUUID</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> unsigned char * uuid)
+int <a href="#virNetworkGetUUIDString">virNetworkGetUUIDString</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> char * buf)
+char * <a href="#virNetworkGetXMLDesc">virNetworkGetXMLDesc</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int flags)
+<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> <a href="#virNetworkLookupByName">virNetworkLookupByName</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)
+<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> <a href="#virNetworkLookupByUUID">virNetworkLookupByUUID</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)
+<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> <a href="#virNetworkLookupByUUIDString">virNetworkLookupByUUIDString</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)
+int <a href="#virNetworkSetAutostart">virNetworkSetAutostart</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int autostart)
+int <a href="#virNetworkUndefine">virNetworkUndefine</a> (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+int <a href="#virNodeGetCellsFreeMemory">virNodeGetCellsFreeMemory</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> unsigned long long * freeMems, <br /> int startCell, <br /> int maxCells)
+unsigned long long <a href="#virNodeGetFreeMemory">virNodeGetFreeMemory</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int <a href="#virNodeGetInfo">virNodeGetInfo</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> <a href="libvirt-libvirt.html#virNodeInfoPtr">virNodeInfoPtr</a> info)
+int <a href="#virStoragePoolBuild">virStoragePoolBuild</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)
+int <a href="#virStoragePoolCreate">virStoragePoolCreate</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)
+<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolCreateXML">virStoragePoolCreateXML</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc, <br /> unsigned int flags)
+<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolDefineXML">virStoragePoolDefineXML</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml, <br /> unsigned int flags)
+int <a href="#virStoragePoolDelete">virStoragePoolDelete</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)
+int <a href="#virStoragePoolDestroy">virStoragePoolDestroy</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+int <a href="#virStoragePoolFree">virStoragePoolFree</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+int <a href="#virStoragePoolGetAutostart">virStoragePoolGetAutostart</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> int * autostart)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virStoragePoolGetConnect">virStoragePoolGetConnect</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+int <a href="#virStoragePoolGetInfo">virStoragePoolGetInfo</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> <a href="libvirt-libvirt.html#virStoragePoolInfoPtr">virStoragePoolInfoPtr</a> info)
+const char * <a href="#virStoragePoolGetName">virStoragePoolGetName</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+int <a href="#virStoragePoolGetUUID">virStoragePoolGetUUID</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned char * uuid)
+int <a href="#virStoragePoolGetUUIDString">virStoragePoolGetUUIDString</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> char * buf)
+char * <a href="#virStoragePoolGetXMLDesc">virStoragePoolGetXMLDesc</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)
+int <a href="#virStoragePoolListVolumes">virStoragePoolListVolumes</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> char ** const names, <br /> int maxnames)
+<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolLookupByName">virStoragePoolLookupByName</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)
+<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolLookupByUUID">virStoragePoolLookupByUUID</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)
+<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolLookupByUUIDString">virStoragePoolLookupByUUIDString</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)
+<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> <a href="#virStoragePoolLookupByVolume">virStoragePoolLookupByVolume</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)
+int <a href="#virStoragePoolNumOfVolumes">virStoragePoolNumOfVolumes</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+int <a href="#virStoragePoolRefresh">virStoragePoolRefresh</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)
+int <a href="#virStoragePoolSetAutostart">virStoragePoolSetAutostart</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> int autostart)
+int <a href="#virStoragePoolUndefine">virStoragePoolUndefine</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> <a href="#virStorageVolCreateXML">virStorageVolCreateXML</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> const char * xmldesc, <br /> unsigned int flags)
+int <a href="#virStorageVolDelete">virStorageVolDelete</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> unsigned int flags)
+int <a href="#virStorageVolFree">virStorageVolFree</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> <a href="#virStorageVolGetConnect">virStorageVolGetConnect</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)
+int <a href="#virStorageVolGetInfo">virStorageVolGetInfo</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> <a href="libvirt-libvirt.html#virStorageVolInfoPtr">virStorageVolInfoPtr</a> info)
+const char * <a href="#virStorageVolGetKey">virStorageVolGetKey</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)
+const char * <a href="#virStorageVolGetName">virStorageVolGetName</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)
+char * <a href="#virStorageVolGetPath">virStorageVolGetPath</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)
+char * <a href="#virStorageVolGetXMLDesc">virStorageVolGetXMLDesc</a> (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> unsigned int flags)
+<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> <a href="#virStorageVolLookupByKey">virStorageVolLookupByKey</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * key)
+<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> <a href="#virStorageVolLookupByName">virStorageVolLookupByName</a> (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> const char * name)
+<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> <a href="#virStorageVolLookupByPath">virStorageVolLookupByPath</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * path)
+</pre><h2>Description</h2><h3><a name="macros" id="macros">Macros</a></h3><h3><a name="LIBVIR_VERSION_NUMBER" id="LIBVIR_VERSION_NUMBER"><code>LIBVIR_VERSION_NUMBER</code></a></h3><pre>#define LIBVIR_VERSION_NUMBER</pre><p>Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro</p><h3><a name="VIR_COPY_CPUMAP" id="VIR_COPY_CPUMAP"><code>VIR_COPY_CPUMAP</code></a></h3><pre>#define VIR_COPY_CPUMAP</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. <a href="libvirt-libvirt.html#VIR_COPY_CPUMAP">VIR_COPY_CPUMAP</a> macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.</p><h3><a name="VIR_CPU_MAPLEN" id="VIR_CPU_MAPLEN"><code>VIR_CPU_MAPLEN</code></a></h3><pre>#define VIR_CPU_MAPLEN</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual & all physical CPUs of a domain.</p><h3><a name="VIR_CPU_USABLE" id="VIR_CPU_USABLE"><code>VIR_CPU_USABLE</code></a></h3><pre>#define VIR_CPU_USABLE</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() API. <a href="libvirt-libvirt.html#VIR_CPU_USABLE">VIR_CPU_USABLE</a> macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.</p><h3><a name="VIR_DOMAIN_SCHED_FIELD_LENGTH" id="VIR_DOMAIN_SCHED_FIELD_LENGTH"><code>VIR_DOMAIN_SCHED_FIELD_LENGTH</code></a></h3><pre>#define VIR_DOMAIN_SCHED_FIELD_LENGTH</pre><p>Macro providing the field length of <a href="libvirt-libvirt.html#virSchedParameter">virSchedParameter</a></p><h3><a name="VIR_GET_CPUMAP" id="VIR_GET_CPUMAP"><code>VIR_GET_CPUMAP</code></a></h3><pre>#define VIR_GET_CPUMAP</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. <a href="libvirt-libvirt.html#VIR_GET_CPUMAP">VIR_GET_CPUMAP</a> macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.</p><h3><a name="VIR_NODEINFO_MAXCPUS" id="VIR_NODEINFO_MAXCPUS"><code>VIR_NODEINFO_MAXCPUS</code></a></h3><pre>#define VIR_NODEINFO_MAXCPUS</pre><p>This macro is to calculate the total number of CPUs supported but not necessary active in the host.</p><h3><a name="VIR_UNUSE_CPU" id="VIR_UNUSE_CPU"><code>VIR_UNUSE_CPU</code></a></h3><pre>#define VIR_UNUSE_CPU</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.</p><h3><a name="VIR_USE_CPU" id="VIR_USE_CPU"><code>VIR_USE_CPU</code></a></h3><pre>#define VIR_USE_CPU</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.</p><h3><a name="VIR_UUID_BUFLEN" id="VIR_UUID_BUFLEN"><code>VIR_UUID_BUFLEN</code></a></h3><pre>#define VIR_UUID_BUFLEN</pre><p>This macro provides the length of the buffer required for virDomainGetUUID()</p><h3><a name="VIR_UUID_STRING_BUFLEN" id="VIR_UUID_STRING_BUFLEN"><code>VIR_UUID_STRING_BUFLEN</code></a></h3><pre>#define VIR_UUID_STRING_BUFLEN</pre><p>This macro provides the length of the buffer required for virDomainGetUUIDString()</p><h3><a name="types" id="types">Types</a></h3><h3><a name="virConnect" id="virConnect"><code>virConnect</code></a></h3><div class="api"><pre>struct virConnect{
+</pre><table><tr><td colspan="3">The content of this structure is not made public by the API</td></tr></table><pre>
}
-</pre><h3>Enum <a name="virConnectFlags" id="virConnectFlags">virConnectFlags</a></h3><pre class="programlisting">Enum virConnectFlags {
- <a name="VIR_CONNECT_RO" id="VIR_CONNECT_RO">VIR_CONNECT_RO</a> = 1 : A readonly connection
+</pre></div><h3><a name="virConnectAuth" id="virConnectAuth"><code>virConnectAuth</code></a></h3><div class="api"><pre>struct virConnectAuth{
+</pre><table><tr><td>int *</td><td>credtype</td><td> : List of supported <a href="libvirt-libvirt.html#virConnectCredentialType">virConnectCredentialType</a> values</td></tr><tr><td>unsigned int</td><td>ncredtype</td></tr><tr><td><a href="libvirt-libvirt.html#virConnectAuthCallbackPtr">virConnectAuthCallbackPtr</a></td><td>cb</td><td> : Callback used to collect credentials</td></tr><tr><td>void *</td><td>cbdata</td></tr></table><pre>
}
-</pre>
- a virConnectPtr is pointer to a virConnect private structure, this is the type used to reference a connection to the Xen Hypervisor in the API.
- <h3><a name="virDomain" id="virDomain">Structure virDomain</a></h3><pre class="programlisting">Structure virDomain<br />struct _virDomain {
-The content of this structure is not made public by the API.
-}</pre>
- A pointer to a virDomainBlockStats structure
- <h3><a name="virDomainBlockStatsStruct" id="virDomainBlockStatsStruct">Structure virDomainBlockStatsStruct</a></h3><pre class="programlisting">Structure virDomainBlockStatsStruct<br />struct _virDomainBlockStats {
- long long rd_req : number of read requests
- long long rd_bytes : number of read bytes
- long long wr_req : number of write requests
- long long wr_bytes : number of written bytes
- long long errs : In Xen this returns the mysterious 'oo_
-}</pre><h3>Enum <a name="virDomainCreateFlags" id="virDomainCreateFlags">virDomainCreateFlags</a></h3><pre class="programlisting">Enum virDomainCreateFlags {
- <a name="VIR_DOMAIN_NONE" id="VIR_DOMAIN_NONE">VIR_DOMAIN_NONE</a> = 0
+</pre></div><h3><a name="virConnectCredential" id="virConnectCredential"><code>virConnectCredential</code></a></h3><div class="api"><pre>struct virConnectCredential{
+</pre><table><tr><td>int</td><td>type</td><td> : One of <a href="libvirt-libvirt.html#virConnectCredentialType">virConnectCredentialType</a> constants</td></tr><tr><td>const char *</td><td>prompt</td><td> : Prompt to show to user</td></tr><tr><td>const char *</td><td>challenge</td><td> : Additional challenge to show</td></tr><tr><td>const char *</td><td>defresult</td><td> : Optional default result</td></tr><tr><td>char *</td><td>result</td><td> : Result to be filled with user response (or defresult)</td></tr><tr><td>unsigned int</td><td>resultlen</td><td> : Length of the result</td></tr></table><pre>
}
-</pre><h3><a name="virDomainInfo" id="virDomainInfo">Structure virDomainInfo</a></h3><pre class="programlisting">Structure virDomainInfo<br />struct _virDomainInfo {
- unsigned char state : the running state, one of virDomainFlag
- unsigned long maxMem : the maximum memory in KBytes allowed
- unsigned long memory : the memory in KBytes used by the domain
- unsigned short nrVirtCpu : the number of virtual CPUs for the doma
- unsigned long long cpuTime : the CPU time used in nanoseconds
-}</pre>
- a virDomainInfoPtr is a pointer to a virDomainInfo structure.
-
- A pointer to a virDomainInterfaceStats structure
- <h3><a name="virDomainInterfaceStatsStruct" id="virDomainInterfaceStatsStruct">Structure virDomainInterfaceStatsStruct</a></h3><pre class="programlisting">Structure virDomainInterfaceStatsStruct<br />struct _virDomainInterfaceStats {
- long long rx_bytes
- long long rx_packets
- long long rx_errs
- long long rx_drop
- long long tx_bytes
- long long tx_packets
- long long tx_errs
- long long tx_drop
-}</pre><h3>Enum <a name="virDomainMigrateFlags" id="virDomainMigrateFlags">virDomainMigrateFlags</a></h3><pre class="programlisting">Enum virDomainMigrateFlags {
- <a name="VIR_MIGRATE_LIVE" id="VIR_MIGRATE_LIVE">VIR_MIGRATE_LIVE</a> = 1 : live migration
+</pre></div><h3><a name="virConnectCredentialType" id="virConnectCredentialType"><code>virConnectCredentialType</code></a></h3><div class="api"><pre>enum virConnectCredentialType {
+</pre><table><tr><td><a name="VIR_CRED_USERNAME" id="VIR_CRED_USERNAME">VIR_CRED_USERNAME</a></td><td> = </td><td>1</td><td> : Identity to act as</td></tr><tr><td><a name="VIR_CRED_AUTHNAME" id="VIR_CRED_AUTHNAME">VIR_CRED_AUTHNAME</a></td><td> = </td><td>2</td><td> : Identify to authorize as</td></tr><tr><td><a name="VIR_CRED_LANGUAGE" id="VIR_CRED_LANGUAGE">VIR_CRED_LANGUAGE</a></td><td> = </td><td>3</td><td> : RFC 1766 languages, comma separated</td></tr><tr><td><a name="VIR_CRED_CNONCE" id="VIR_CRED_CNONCE">VIR_CRED_CNONCE</a></td><td> = </td><td>4</td><td> : client supplies a nonce</td></tr><tr><td><a name="VIR_CRED_PASSPHRASE" id="VIR_CRED_PASSPHRASE">VIR_CRED_PASSPHRASE</a></td><td> = </td><td>5</td><td> : Passphrase secret</td></tr><tr><td><a name="VIR_CRED_ECHOPROMPT" id="VIR_CRED_ECHOPROMPT">VIR_CRED_ECHOPROMPT</a></td><td> = </td><td>6</td><td> : Challenge response</td></tr><tr><td><a name="VIR_CRED_NOECHOPROMPT" id="VIR_CRED_NOECHOPROMPT">VIR_CRED_NOECHOPROMPT</a></td><td> = </td><td>7</td><td> : Challenge response</td></tr><tr><td><a name="VIR_CRED_REALM" id="VIR_CRED_REALM">VIR_CRED_REALM</a></td><td> = </td><td>8</td><td> : Authentication realm</td></tr><tr><td><a name="VIR_CRED_EXTERNAL" id="VIR_CRED_EXTERNAL">VIR_CRED_EXTERNAL</a></td><td> = </td><td>9</td><td> : Externally managed credential More may be added - expect the unexpected</td></tr></table><pre>}
+</pre></div><h3><a name="virConnectFlags" id="virConnectFlags"><code>virConnectFlags</code></a></h3><div class="api"><pre>enum virConnectFlags {
+</pre><table><tr><td><a name="VIR_CONNECT_RO" id="VIR_CONNECT_RO">VIR_CONNECT_RO</a></td><td> = </td><td>1</td><td> : A readonly connection</td></tr></table><pre>}
+</pre></div><h3><a name="virDomain" id="virDomain"><code>virDomain</code></a></h3><div class="api"><pre>struct virDomain{
+</pre><table><tr><td colspan="3">The content of this structure is not made public by the API</td></tr></table><pre>
}
-</pre>
- a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a Xen domain in the API.
- <h3>Enum <a name="virDomainState" id="virDomainState">virDomainState</a></h3><pre class="programlisting">Enum virDomainState {
- <a name="VIR_DOMAIN_NOSTATE" id="VIR_DOMAIN_NOSTATE">VIR_DOMAIN_NOSTATE</a> = 0 : no state
- <a name="VIR_DOMAIN_RUNNING" id="VIR_DOMAIN_RUNNING">VIR_DOMAIN_RUNNING</a> = 1 : the domain is running
- <a name="VIR_DOMAIN_BLOCKED" id="VIR_DOMAIN_BLOCKED">VIR_DOMAIN_BLOCKED</a> = 2 : the domain is blocked on resource
- <a name="VIR_DOMAIN_PAUSED" id="VIR_DOMAIN_PAUSED">VIR_DOMAIN_PAUSED</a> = 3 : the domain is paused by user
- <a name="VIR_DOMAIN_SHUTDOWN" id="VIR_DOMAIN_SHUTDOWN">VIR_DOMAIN_SHUTDOWN</a> = 4 : the domain is being shut down
- <a name="VIR_DOMAIN_SHUTOFF" id="VIR_DOMAIN_SHUTOFF">VIR_DOMAIN_SHUTOFF</a> = 5 : the domain is shut off
- <a name="VIR_DOMAIN_CRASHED" id="VIR_DOMAIN_CRASHED">VIR_DOMAIN_CRASHED</a> = 6 : the domain is crashed
+</pre></div><h3><a name="virDomainBlockStatsStruct" id="virDomainBlockStatsStruct"><code>virDomainBlockStatsStruct</code></a></h3><div class="api"><pre>struct virDomainBlockStatsStruct{
+</pre><table><tr><td>long long</td><td>rd_req</td><td> : number of read requests</td></tr><tr><td>long long</td><td>rd_bytes</td><td> : number of read bytes</td></tr><tr><td>long long</td><td>wr_req</td><td> : number of write requests</td></tr><tr><td>long long</td><td>wr_bytes</td><td> : number of written bytes</td></tr><tr><td>long long</td><td>errs</td><td> : In Xen this returns the mysterious 'oo_req'.</td></tr></table><pre>
}
-</pre><h3>Enum <a name="virDomainXMLFlags" id="virDomainXMLFlags">virDomainXMLFlags</a></h3><pre class="programlisting">Enum virDomainXMLFlags {
- <a name="VIR_DOMAIN_XML_SECURE" id="VIR_DOMAIN_XML_SECURE">VIR_DOMAIN_XML_SECURE</a> = 1 : dump security sensitive information too
- <a name="VIR_DOMAIN_XML_INACTIVE" id="VIR_DOMAIN_XML_INACTIVE">VIR_DOMAIN_XML_INACTIVE</a> = 2 : dump inactive domain information
+</pre></div><h3><a name="virDomainCreateFlags" id="virDomainCreateFlags"><code>virDomainCreateFlags</code></a></h3><div class="api"><pre>enum virDomainCreateFlags {
+</pre><table><tr><td><a name="VIR_DOMAIN_NONE" id="VIR_DOMAIN_NONE">VIR_DOMAIN_NONE</a></td><td> = </td><td>0</td></tr></table><pre>}
+</pre></div><h3><a name="virDomainInfo" id="virDomainInfo"><code>virDomainInfo</code></a></h3><div class="api"><pre>struct virDomainInfo{
+</pre><table><tr><td>unsigned char</td><td>state</td><td> : the running state, one of virDomainFlags</td></tr><tr><td>unsigned long</td><td>maxMem</td><td> : the maximum memory in KBytes allowed</td></tr><tr><td>unsigned long</td><td>memory</td><td> : the memory in KBytes used by the domain</td></tr><tr><td>unsigned short</td><td>nrVirtCpu</td><td> : the number of virtual CPUs for the domain</td></tr><tr><td>unsigned long long</td><td>cpuTime</td><td> : the CPU time used in nanoseconds</td></tr></table><pre>
}
-</pre><h3><a name="virNetwork" id="virNetwork">Structure virNetwork</a></h3><pre class="programlisting">Structure virNetwork<br />struct _virNetwork {
-The content of this structure is not made public by the API.
-}</pre>
- a virNetworkPtr is pointer to a virNetwork private structure, this is the type used to reference a virtual network in the API.
- <h3><a name="virNodeInfo" id="virNodeInfo">Structure virNodeInfo</a></h3><pre class="programlisting">Structure virNodeInfo<br />struct _virNodeInfo {
- charmodel[32] model : string indicating the CPU model
- unsigned long memory : memory size in kilobytes
- unsigned int cpus : the number of active CPUs
- unsigned int mhz : expected CPU frequency
- unsigned int nodes : the number of NUMA cell, 1 for uniform
- unsigned int sockets : number of CPU socket per node
- unsigned int cores : number of core per socket
- unsigned int threads : number of threads per core
-}</pre>
- a virNodeInfoPtr is a pointer to a virNodeInfo structure.
- <h3><a name="virSchedParameter" id="virSchedParameter">Structure virSchedParameter</a></h3><pre class="programlisting">Structure virSchedParameter<br />struct _virSchedParameter {
- charfield[VIR_DOMAIN_SCHED_FIELD_LENGTH] field : parameter name
- int type : parameter type
-}</pre>
- a virSchedParameterPtr is a pointer to a virSchedParameter structure.
- <h3>Enum <a name="virSchedParameterType" id="virSchedParameterType">virSchedParameterType</a></h3><pre class="programlisting">Enum virSchedParameterType {
- <a name="VIR_DOMAIN_SCHED_FIELD_INT" id="VIR_DOMAIN_SCHED_FIELD_INT">VIR_DOMAIN_SCHED_FIELD_INT</a> = 1 : integer case
- <a name="VIR_DOMAIN_SCHED_FIELD_UINT" id="VIR_DOMAIN_SCHED_FIELD_UINT">VIR_DOMAIN_SCHED_FIELD_UINT</a> = 2 : unsigned integer case
- <a name="VIR_DOMAIN_SCHED_FIELD_LLONG" id="VIR_DOMAIN_SCHED_FIELD_LLONG">VIR_DOMAIN_SCHED_FIELD_LLONG</a> = 3 : long long case
- <a name="VIR_DOMAIN_SCHED_FIELD_ULLONG" id="VIR_DOMAIN_SCHED_FIELD_ULLONG">VIR_DOMAIN_SCHED_FIELD_ULLONG</a> = 4 : unsigned long long case
- <a name="VIR_DOMAIN_SCHED_FIELD_DOUBLE" id="VIR_DOMAIN_SCHED_FIELD_DOUBLE">VIR_DOMAIN_SCHED_FIELD_DOUBLE</a> = 5 : double case
- <a name="VIR_DOMAIN_SCHED_FIELD_BOOLEAN" id="VIR_DOMAIN_SCHED_FIELD_BOOLEAN">VIR_DOMAIN_SCHED_FIELD_BOOLEAN</a> = 6 : boolean(character) case
+</pre></div><h3><a name="virDomainInterfaceStatsStruct" id="virDomainInterfaceStatsStruct"><code>virDomainInterfaceStatsStruct</code></a></h3><div class="api"><pre>struct virDomainInterfaceStatsStruct{
+</pre><table><tr><td>long long</td><td>rx_bytes</td></tr><tr><td>long long</td><td>rx_packets</td></tr><tr><td>long long</td><td>rx_errs</td></tr><tr><td>long long</td><td>rx_drop</td></tr><tr><td>long long</td><td>tx_bytes</td></tr><tr><td>long long</td><td>tx_packets</td></tr><tr><td>long long</td><td>tx_errs</td></tr><tr><td>long long</td><td>tx_drop</td></tr></table><pre>
}
-</pre><h3><a name="virStoragePool" id="virStoragePool">Structure virStoragePool</a></h3><pre class="programlisting">Structure virStoragePool<br />struct _virStoragePool {
-The content of this structure is not made public by the API.
-}</pre><h3>Enum <a name="virStoragePoolBuildFlags" id="virStoragePoolBuildFlags">virStoragePoolBuildFlags</a></h3><pre class="programlisting">Enum virStoragePoolBuildFlags {
- <a name="VIR_STORAGE_POOL_BUILD_NEW" id="VIR_STORAGE_POOL_BUILD_NEW">VIR_STORAGE_POOL_BUILD_NEW</a> = 0 : Regular build from scratch
- <a name="VIR_STORAGE_POOL_BUILD_REPAIR" id="VIR_STORAGE_POOL_BUILD_REPAIR">VIR_STORAGE_POOL_BUILD_REPAIR</a> = 1 : Repair / reinitialize
- <a name="VIR_STORAGE_POOL_BUILD_RESIZE" id="VIR_STORAGE_POOL_BUILD_RESIZE">VIR_STORAGE_POOL_BUILD_RESIZE</a> = 2 : Extend existing pool
+</pre></div><h3><a name="virDomainMigrateFlags" id="virDomainMigrateFlags"><code>virDomainMigrateFlags</code></a></h3><div class="api"><pre>enum virDomainMigrateFlags {
+</pre><table><tr><td><a name="VIR_MIGRATE_LIVE" id="VIR_MIGRATE_LIVE">VIR_MIGRATE_LIVE</a></td><td> = </td><td>1</td><td> : live migration</td></tr></table><pre>}
+</pre></div><h3><a name="virDomainState" id="virDomainState"><code>virDomainState</code></a></h3><div class="api"><pre>enum virDomainState {
+</pre><table><tr><td><a name="VIR_DOMAIN_NOSTATE" id="VIR_DOMAIN_NOSTATE">VIR_DOMAIN_NOSTATE</a></td><td> = </td><td>0</td><td> : no state</td></tr><tr><td><a name="VIR_DOMAIN_RUNNING" id="VIR_DOMAIN_RUNNING">VIR_DOMAIN_RUNNING</a></td><td> = </td><td>1</td><td> : the domain is running</td></tr><tr><td><a name="VIR_DOMAIN_BLOCKED" id="VIR_DOMAIN_BLOCKED">VIR_DOMAIN_BLOCKED</a></td><td> = </td><td>2</td><td> : the domain is blocked on resource</td></tr><tr><td><a name="VIR_DOMAIN_PAUSED" id="VIR_DOMAIN_PAUSED">VIR_DOMAIN_PAUSED</a></td><td> = </td><td>3</td><td> : the domain is paused by user</td></tr><tr><td><a name="VIR_DOMAIN_SHUTDOWN" id="VIR_DOMAIN_SHUTDOWN">VIR_DOMAIN_SHUTDOWN</a></td><td> = </td><td>4</td><td> : the domain is being shut down</td></tr><tr><td><a name="VIR_DOMAIN_SHUTOFF" id="VIR_DOMAIN_SHUTOFF">VIR_DOMAIN_SHUTOFF</a></td><td> = </td><td>5</td><td> : the domain is shut off</td></tr><tr><td><a name="VIR_DOMAIN_CRASHED" id="VIR_DOMAIN_CRASHED">VIR_DOMAIN_CRASHED</a></td><td> = </td><td>6</td><td> : the domain is crashed</td></tr></table><pre>}
+</pre></div><h3><a name="virDomainXMLFlags" id="virDomainXMLFlags"><code>virDomainXMLFlags</code></a></h3><div class="api"><pre>enum virDomainXMLFlags {
+</pre><table><tr><td><a name="VIR_DOMAIN_XML_SECURE" id="VIR_DOMAIN_XML_SECURE">VIR_DOMAIN_XML_SECURE</a></td><td> = </td><td>1</td><td> : dump security sensitive information too</td></tr><tr><td><a name="VIR_DOMAIN_XML_INACTIVE" id="VIR_DOMAIN_XML_INACTIVE">VIR_DOMAIN_XML_INACTIVE</a></td><td> = </td><td>2</td><td> : dump inactive domain information</td></tr></table><pre>}
+</pre></div><h3><a name="virNetwork" id="virNetwork"><code>virNetwork</code></a></h3><div class="api"><pre>struct virNetwork{
+</pre><table><tr><td colspan="3">The content of this structure is not made public by the API</td></tr></table><pre>
}
-</pre><h3>Enum <a name="virStoragePoolDeleteFlags" id="virStoragePoolDeleteFlags">virStoragePoolDeleteFlags</a></h3><pre class="programlisting">Enum virStoragePoolDeleteFlags {
- <a name="VIR_STORAGE_POOL_DELETE_NORMAL" id="VIR_STORAGE_POOL_DELETE_NORMAL">VIR_STORAGE_POOL_DELETE_NORMAL</a> = 0 : Delete metadata only (fast)
- <a name="VIR_STORAGE_POOL_DELETE_ZEROED" id="VIR_STORAGE_POOL_DELETE_ZEROED">VIR_STORAGE_POOL_DELETE_ZEROED</a> = 1 : Clear all data to zeros (slow)
+</pre></div><h3><a name="virNodeInfo" id="virNodeInfo"><code>virNodeInfo</code></a></h3><div class="api"><pre>struct virNodeInfo{
+</pre><table><tr><td>charmodel[32]</td><td>model</td><td> : string indicating the CPU model</td></tr><tr><td>unsigned long</td><td>memory</td><td> : memory size in kilobytes</td></tr><tr><td>unsigned int</td><td>cpus</td><td> : the number of active CPUs</td></tr><tr><td>unsigned int</td><td>mhz</td><td> : expected CPU frequency</td></tr><tr><td>unsigned int</td><td>nodes</td><td> : the number of NUMA cell, 1 for uniform mem access</td></tr><tr><td>unsigned int</td><td>sockets</td><td> : number of CPU socket per node</td></tr><tr><td>unsigned int</td><td>cores</td><td> : number of core per socket</td></tr><tr><td>unsigned int</td><td>threads</td><td> : number of threads per core</td></tr></table><pre>
}
-</pre><h3><a name="virStoragePoolInfo" id="virStoragePoolInfo">Structure virStoragePoolInfo</a></h3><pre class="programlisting">Structure virStoragePoolInfo<br />struct _virStoragePoolInfo {
- int state : <a href="libvirt-libvirt.html#virStoragePoolState">virStoragePoolState</a> flags
- unsigned long long capacity : Logical size bytes
- unsigned long long allocation : Current allocation bytes
- unsigned long long available : Remaining free space bytes
-}</pre>
- a virStoragePoolPtr is pointer to a virStoragePool private structure, this is the type used to reference a storage pool in the API.
- <h3>Enum <a name="virStoragePoolState" id="virStoragePoolState">virStoragePoolState</a></h3><pre class="programlisting">Enum virStoragePoolState {
- <a name="VIR_STORAGE_POOL_INACTIVE" id="VIR_STORAGE_POOL_INACTIVE">VIR_STORAGE_POOL_INACTIVE</a> = 0 : Not running
- <a name="VIR_STORAGE_POOL_BUILDING" id="VIR_STORAGE_POOL_BUILDING">VIR_STORAGE_POOL_BUILDING</a> = 1 : Initializing pool, not available
- <a name="VIR_STORAGE_POOL_RUNNING" id="VIR_STORAGE_POOL_RUNNING">VIR_STORAGE_POOL_RUNNING</a> = 2 : Running normally
- <a name="VIR_STORAGE_POOL_DEGRADED" id="VIR_STORAGE_POOL_DEGRADED">VIR_STORAGE_POOL_DEGRADED</a> = 3 : Running degraded
+</pre></div><h3><a name="virSchedParameter" id="virSchedParameter"><code>virSchedParameter</code></a></h3><div class="api"><pre>struct virSchedParameter{
+</pre><table><tr><td>charfield[VIR_DOMAIN_SCHED_FIELD_LENGTH]</td><td>field</td><td> : parameter name</td></tr><tr><td>int</td><td>type</td><td> : parameter type</td></tr></table><pre>
}
-</pre><h3><a name="virStorageVol" id="virStorageVol">Structure virStorageVol</a></h3><pre class="programlisting">Structure virStorageVol<br />struct _virStorageVol {
-The content of this structure is not made public by the API.
-}</pre><h3>Enum <a name="virStorageVolDeleteFlags" id="virStorageVolDeleteFlags">virStorageVolDeleteFlags</a></h3><pre class="programlisting">Enum virStorageVolDeleteFlags {
- <a name="VIR_STORAGE_VOL_DELETE_NORMAL" id="VIR_STORAGE_VOL_DELETE_NORMAL">VIR_STORAGE_VOL_DELETE_NORMAL</a> = 0 : Delete metadata only (fast)
- <a name="VIR_STORAGE_VOL_DELETE_ZEROED" id="VIR_STORAGE_VOL_DELETE_ZEROED">VIR_STORAGE_VOL_DELETE_ZEROED</a> = 1 : Clear all data to zeros (slow)
+</pre></div><h3><a name="virSchedParameterType" id="virSchedParameterType"><code>virSchedParameterType</code></a></h3><div class="api"><pre>enum virSchedParameterType {
+</pre><table><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_INT" id="VIR_DOMAIN_SCHED_FIELD_INT">VIR_DOMAIN_SCHED_FIELD_INT</a></td><td> = </td><td>1</td><td> : integer case</td></tr><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_UINT" id="VIR_DOMAIN_SCHED_FIELD_UINT">VIR_DOMAIN_SCHED_FIELD_UINT</a></td><td> = </td><td>2</td><td> : unsigned integer case</td></tr><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_LLONG" id="VIR_DOMAIN_SCHED_FIELD_LLONG">VIR_DOMAIN_SCHED_FIELD_LLONG</a></td><td> = </td><td>3</td><td> : long long case</td></tr><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_ULLONG" id="VIR_DOMAIN_SCHED_FIELD_ULLONG">VIR_DOMAIN_SCHED_FIELD_ULLONG</a></td><td> = </td><td>4</td><td> : unsigned long long case</td></tr><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_DOUBLE" id="VIR_DOMAIN_SCHED_FIELD_DOUBLE">VIR_DOMAIN_SCHED_FIELD_DOUBLE</a></td><td> = </td><td>5</td><td> : double case</td></tr><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_BOOLEAN" id="VIR_DOMAIN_SCHED_FIELD_BOOLEAN">VIR_DOMAIN_SCHED_FIELD_BOOLEAN</a></td><td> = </td><td>6</td><td> : boolean(character) case</td></tr></table><pre>}
+</pre></div><h3><a name="virStoragePool" id="virStoragePool"><code>virStoragePool</code></a></h3><div class="api"><pre>struct virStoragePool{
+</pre><table><tr><td colspan="3">The content of this structure is not made public by the API</td></tr></table><pre>
}
-</pre><h3><a name="virStorageVolInfo" id="virStorageVolInfo">Structure virStorageVolInfo</a></h3><pre class="programlisting">Structure virStorageVolInfo<br />struct _virStorageVolInfo {
- int type : <a href="libvirt-libvirt.html#virStorageVolType">virStorageVolType</a> flags
- unsigned long long capacity : Logical size bytes
- unsigned long long allocation : Current allocation bytes
-}</pre>
- a virStorageVolPtr is pointer to a virStorageVol private structure, this is the type used to reference a storage volume in the API.
- <h3>Enum <a name="virStorageVolType" id="virStorageVolType">virStorageVolType</a></h3><pre class="programlisting">Enum virStorageVolType {
- <a name="VIR_STORAGE_VOL_FILE" id="VIR_STORAGE_VOL_FILE">VIR_STORAGE_VOL_FILE</a> = 0 : Regular file based volumes
- <a name="VIR_STORAGE_VOL_BLOCK" id="VIR_STORAGE_VOL_BLOCK">VIR_STORAGE_VOL_BLOCK</a> = 1 : Block based volumes
+</pre></div><h3><a name="virStoragePoolBuildFlags" id="virStoragePoolBuildFlags"><code>virStoragePoolBuildFlags</code></a></h3><div class="api"><pre>enum virStoragePoolBuildFlags {
+</pre><table><tr><td><a name="VIR_STORAGE_POOL_BUILD_NEW" id="VIR_STORAGE_POOL_BUILD_NEW">VIR_STORAGE_POOL_BUILD_NEW</a></td><td> = </td><td>0</td><td> : Regular build from scratch</td></tr><tr><td><a name="VIR_STORAGE_POOL_BUILD_REPAIR" id="VIR_STORAGE_POOL_BUILD_REPAIR">VIR_STORAGE_POOL_BUILD_REPAIR</a></td><td> = </td><td>1</td><td> : Repair / reinitialize</td></tr><tr><td><a name="VIR_STORAGE_POOL_BUILD_RESIZE" id="VIR_STORAGE_POOL_BUILD_RESIZE">VIR_STORAGE_POOL_BUILD_RESIZE</a></td><td> = </td><td>2</td><td> : Extend existing pool</td></tr></table><pre>}
+</pre></div><h3><a name="virStoragePoolDeleteFlags" id="virStoragePoolDeleteFlags"><code>virStoragePoolDeleteFlags</code></a></h3><div class="api"><pre>enum virStoragePoolDeleteFlags {
+</pre><table><tr><td><a name="VIR_STORAGE_POOL_DELETE_NORMAL" id="VIR_STORAGE_POOL_DELETE_NORMAL">VIR_STORAGE_POOL_DELETE_NORMAL</a></td><td> = </td><td>0</td><td> : Delete metadata only (fast)</td></tr><tr><td><a name="VIR_STORAGE_POOL_DELETE_ZEROED" id="VIR_STORAGE_POOL_DELETE_ZEROED">VIR_STORAGE_POOL_DELETE_ZEROED</a></td><td> = </td><td>1</td><td> : Clear all data to zeros (slow)</td></tr></table><pre>}
+</pre></div><h3><a name="virStoragePoolInfo" id="virStoragePoolInfo"><code>virStoragePoolInfo</code></a></h3><div class="api"><pre>struct virStoragePoolInfo{
+</pre><table><tr><td>int</td><td>state</td><td> : <a href="libvirt-libvirt.html#virStoragePoolState">virStoragePoolState</a> flags</td></tr><tr><td>unsigned long long</td><td>capacity</td><td> : Logical size bytes</td></tr><tr><td>unsigned long long</td><td>allocation</td><td> : Current allocation bytes</td></tr><tr><td>unsigned long long</td><td>available</td><td> : Remaining free space bytes</td></tr></table><pre>
}
-</pre><h3><a name="virVcpuInfo" id="virVcpuInfo">Structure virVcpuInfo</a></h3><pre class="programlisting">Structure virVcpuInfo<br />struct _virVcpuInfo {
- unsigned int number : virtual CPU number
- int state : value from <a href="libvirt-libvirt.html#virVcpuState">virVcpuState</a>
- unsigned long long cpuTime : CPU time used, in nanoseconds
- int cpu : real CPU number, or -1 if offline
-}</pre><h3>Enum <a name="virVcpuState" id="virVcpuState">virVcpuState</a></h3><pre class="programlisting">Enum virVcpuState {
- <a name="VIR_VCPU_OFFLINE" id="VIR_VCPU_OFFLINE">VIR_VCPU_OFFLINE</a> = 0 : the virtual CPU is offline
- <a name="VIR_VCPU_RUNNING" id="VIR_VCPU_RUNNING">VIR_VCPU_RUNNING</a> = 1 : the virtual CPU is running
- <a name="VIR_VCPU_BLOCKED" id="VIR_VCPU_BLOCKED">VIR_VCPU_BLOCKED</a> = 2 : the virtual CPU is blocked on resource
+</pre></div><h3><a name="virStoragePoolState" id="virStoragePoolState"><code>virStoragePoolState</code></a></h3><div class="api"><pre>enum virStoragePoolState {
+</pre><table><tr><td><a name="VIR_STORAGE_POOL_INACTIVE" id="VIR_STORAGE_POOL_INACTIVE">VIR_STORAGE_POOL_INACTIVE</a></td><td> = </td><td>0</td><td> : Not running</td></tr><tr><td><a name="VIR_STORAGE_POOL_BUILDING" id="VIR_STORAGE_POOL_BUILDING">VIR_STORAGE_POOL_BUILDING</a></td><td> = </td><td>1</td><td> : Initializing pool, not available</td></tr><tr><td><a name="VIR_STORAGE_POOL_RUNNING" id="VIR_STORAGE_POOL_RUNNING">VIR_STORAGE_POOL_RUNNING</a></td><td> = </td><td>2</td><td> : Running normally</td></tr><tr><td><a name="VIR_STORAGE_POOL_DEGRADED" id="VIR_STORAGE_POOL_DEGRADED">VIR_STORAGE_POOL_DEGRADED</a></td><td> = </td><td>3</td><td> : Running degraded</td></tr></table><pre>}
+</pre></div><h3><a name="virStorageVol" id="virStorageVol"><code>virStorageVol</code></a></h3><div class="api"><pre>struct virStorageVol{
+</pre><table><tr><td colspan="3">The content of this structure is not made public by the API</td></tr></table><pre>
}
-</pre><h3><a name="virConnectAuthCallbackPtr" id="virConnectAuthCallbackPtr"></a>Function type: virConnectAuthCallbackPtr</h3><pre class="programlisting">Function type: virConnectAuthCallbackPtr
-int virConnectAuthCallbackPtr (<a href="libvirt-libvirt.html#virConnectCredentialPtr">virConnectCredentialPtr</a> cred, <br /> unsigned int ncred, <br /> void * cbdata)
-</pre><p></p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>cred</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>ncred</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>cbdata</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td></td></tr></tbody></table></div><br />
-<h3><a name="virConnectClose" id="virConnectClose"></a>Function: virConnectClose</h3><pre class="programlisting">int virConnectClose (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>This function closes the connection to the Hypervisor. This should not be called if further interaction with the Hypervisor are needed especially if there is running domain which need further monitoring by the application.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virConnectGetCapabilities" id="virConnectGetCapabilities"></a>Function: virConnectGetCapabilities</h3><pre class="programlisting">char * virConnectGetCapabilities (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides capabilities of the hypervisor / driver.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, or an XML string defining the capabilities. The client must free the returned string after use.</td></tr></tbody></table></div><h3><a name="virConnectGetHostname" id="virConnectGetHostname"></a>Function: virConnectGetHostname</h3><pre class="programlisting">char * virConnectGetHostname (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>This returns the system hostname on which the hypervisor is running (the result of the gethostname(2) system call). If we are connected to a remote system, then this returns the hostname of the remote system.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to a hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the hostname which must be freed by the caller, or NULL if there was an error.</td></tr></tbody></table></div><h3><a name="virConnectGetMaxVcpus" id="virConnectGetMaxVcpus"></a>Function: virConnectGetMaxVcpus</h3><pre class="programlisting">int virConnectGetMaxVcpus (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * type)<br />
-</pre><p>Provides the maximum number of virtual CPUs supported for a guest VM of a specific type. The 'type' parameter here corresponds to the 'type' attribute in the <domain> element of the XML.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>type</tt></i>:</span></td><td>value of the 'type' attribute in the <domain> element</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the maximum of virtual CPU or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virConnectGetType" id="virConnectGetType"></a>Function: virConnectGetType</h3><pre class="programlisting">const char * virConnectGetType (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Get the name of the Hypervisor software used.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a static zero terminated string otherwise. See also: http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html</td></tr></tbody></table></div><h3><a name="virConnectGetURI" id="virConnectGetURI"></a>Function: virConnectGetURI</h3><pre class="programlisting">char * virConnectGetURI (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>This returns the URI (name) of the hypervisor connection. Normally this is the same as or similar to the string passed to the virConnectOpen/virConnectOpenReadOnly call, but the driver may make the URI canonical. If name == NULL was passed to virConnectOpen, then the driver will return a non-NULL URI which can be used to connect to the same hypervisor later.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to a hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the URI string which must be freed by the caller, or NULL if there was an error.</td></tr></tbody></table></div><h3><a name="virConnectGetVersion" id="virConnectGetVersion"></a>Function: virConnectGetVersion</h3><pre class="programlisting">int virConnectGetVersion (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> unsigned long * hvVer)<br />
-</pre><p>Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with privileged access to the hypervisor, not with a Read-Only connection.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>hvVer</tt></i>:</span></td><td>return value for the version of the running hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 otherwise. if the version can't be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release</td></tr></tbody></table></div><h3><a name="virConnectListDefinedDomains" id="virConnectListDefinedDomains"></a>Function: virConnectListDefinedDomains</h3><pre class="programlisting">int virConnectListDefinedDomains (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)<br />
-</pre><p>list the defined but inactive domains, stores the pointers to the names in @names</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>pointer to an array to store the names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names provided in the array or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListDefinedNetworks" id="virConnectListDefinedNetworks"></a>Function: virConnectListDefinedNetworks</h3><pre class="programlisting">int virConnectListDefinedNetworks (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)<br />
-</pre><p>list the inactive networks, stores the pointers to the names in @names</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>pointer to an array to store the names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names provided in the array or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListDefinedStoragePools" id="virConnectListDefinedStoragePools"></a>Function: virConnectListDefinedStoragePools</h3><pre class="programlisting">int virConnectListDefinedStoragePools (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)<br />
-</pre><p>Provides the list of names of inactive storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array of char * to fill with pool names (allocated by caller)</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on error</td></tr></tbody></table></div><h3><a name="virConnectListDomains" id="virConnectListDomains"></a>Function: virConnectListDomains</h3><pre class="programlisting">int virConnectListDomains (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> int * ids, <br /> int maxids)<br />
-</pre><p>Collect the list of active domains, and store their ID in @maxids</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>ids</tt></i>:</span></td><td>array to collect the list of IDs of active domains</td></tr><tr><td><span class="term"><i><tt>maxids</tt></i>:</span></td><td>size of @ids</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListNetworks" id="virConnectListNetworks"></a>Function: virConnectListNetworks</h3><pre class="programlisting">int virConnectListNetworks (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)<br />
-</pre><p>Collect the list of active networks, and store their names in @names</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array to collect the list of names of active networks</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of @names</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of networks found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListStoragePools" id="virConnectListStoragePools"></a>Function: virConnectListStoragePools</h3><pre class="programlisting">int virConnectListStoragePools (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)<br />
-</pre><p>Provides the list of names of active storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array of char * to fill with pool names (allocated by caller)</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedDomains" id="virConnectNumOfDefinedDomains"></a>Function: virConnectNumOfDefinedDomains</h3><pre class="programlisting">int virConnectNumOfDefinedDomains (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of defined but inactive domains.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedNetworks" id="virConnectNumOfDefinedNetworks"></a>Function: virConnectNumOfDefinedNetworks</h3><pre class="programlisting">int virConnectNumOfDefinedNetworks (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of inactive networks.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of networks found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedStoragePools" id="virConnectNumOfDefinedStoragePools"></a>Function: virConnectNumOfDefinedStoragePools</h3><pre class="programlisting">int virConnectNumOfDefinedStoragePools (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of inactive storage pools</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of pools found, or -1 on error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDomains" id="virConnectNumOfDomains"></a>Function: virConnectNumOfDomains</h3><pre class="programlisting">int virConnectNumOfDomains (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of active domains.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfNetworks" id="virConnectNumOfNetworks"></a>Function: virConnectNumOfNetworks</h3><pre class="programlisting">int virConnectNumOfNetworks (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of active networks.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of network found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfStoragePools" id="virConnectNumOfStoragePools"></a>Function: virConnectNumOfStoragePools</h3><pre class="programlisting">int virConnectNumOfStoragePools (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of active storage pools</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of pools found, or -1 on error</td></tr></tbody></table></div><h3><a name="virConnectOpen" id="virConnectOpen"></a>Function: virConnectOpen</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virConnectOpen (const char * name)<br />
-</pre><p>This function should be called first to get a connection to the Hypervisor and xen store</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virConnectOpenAuth" id="virConnectOpenAuth"></a>Function: virConnectOpenAuth</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virConnectOpenAuth (const char * name, <br /> <a href="libvirt-libvirt.html#virConnectAuthPtr">virConnectAuthPtr</a> auth, <br /> int flags)<br />
-</pre><p>This function should be called first to get a connection to the Hypervisor. If necessary, authentication will be performed fetching credentials via the callback</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>auth</tt></i>:</span></td><td>Authenticate callback parameters</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>Open flags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virConnectOpenReadOnly" id="virConnectOpenReadOnly"></a>Function: virConnectOpenReadOnly</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virConnectOpenReadOnly (const char * name)<br />
-</pre><p>This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virDomainAttachDevice" id="virDomainAttachDevice"></a>Function: virDomainAttachDevice</h3><pre class="programlisting">int virDomainAttachDevice (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * xml)<br />
-</pre><p>Create a virtual device attachment to backend.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>pointer to XML description of one device</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainBlockStats" id="virDomainBlockStats"></a>Function: virDomainBlockStats</h3><pre class="programlisting">int virDomainBlockStats (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br /> const char * path, <br /> <a href="libvirt-libvirt.html#virDomainBlockStatsPtr">virDomainBlockStatsPtr</a> stats, <br /> size_t size)<br />
-</pre><p>This function returns block device (disk) stats for block devices attached to the domain. The path parameter is the name of the block device. Get this by calling <a href="libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a> and finding the <target dev='...'> attribute within //domain/devices/disk. (For example, "xvda"). Domains may have more than one block device. To get stats for each you should make multiple calls to this function. Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to the domain object</td></tr><tr><td><span class="term"><i><tt>path</tt></i>:</span></td><td>path to the block device</td></tr><tr><td><span class="term"><i><tt>stats</tt></i>:</span></td><td>block device stats (returned)</td></tr><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td>size of stats structure</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainCoreDump" id="virDomainCoreDump"></a>Function: virDomainCoreDump</h3><pre class="programlisting">int virDomainCoreDump (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * to, <br /> int flags)<br />
-</pre><p>This method will dump the core of a domain on a given file for analysis. Note that for remote Xen Daemon the file path will be interpreted in the remote host.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>to</tt></i>:</span></td><td>path for the core file</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>extra flags, currently unused</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainCreate" id="virDomainCreate"></a>Function: virDomainCreate</h3><pre class="programlisting">int virDomainCreate (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virDomainCreateLinux" id="virDomainCreateLinux"></a>Function: virDomainCreateLinux</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainCreateLinux (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc, <br /> unsigned int flags)<br />
-</pre><p>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>string containing an XML description of the domain</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>an optional set of virDomainFlags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure</td></tr></tbody></table></div><h3><a name="virDomainDefineXML" id="virDomainDefineXML"></a>Function: virDomainDefineXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainDefineXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml)<br />
-</pre><p>define a domain, but does not start it</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>the XML description for the domain, preferably in UTF-8</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a pointer to the domain otherwise</td></tr></tbody></table></div><h3><a name="virDomainDestroy" id="virDomainDestroy"></a>Function: virDomainDestroy</h3><pre class="programlisting">int virDomainDestroy (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires privileged access</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainDetachDevice" id="virDomainDetachDevice"></a>Function: virDomainDetachDevice</h3><pre class="programlisting">int virDomainDetachDevice (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * xml)<br />
-</pre><p>Destroy a virtual device attachment to backend.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>pointer to XML description of one device</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainFree" id="virDomainFree"></a>Function: virDomainFree</h3><pre class="programlisting">int virDomainFree (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetAutostart" id="virDomainGetAutostart"></a>Function: virDomainGetAutostart</h3><pre class="programlisting">int virDomainGetAutostart (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int * autostart)<br />
-</pre><p>Provides a boolean value indicating whether the domain configured to be automatically started when the host machine boots.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetConnect" id="virDomainGetConnect"></a>Function: virDomainGetConnect</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virDomainGetConnect (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom)<br />
-</pre><p>Provides the connection pointer associated with a domain. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the domain object together.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to a domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetID" id="virDomainGetID"></a>Function: virDomainGetID</h3><pre class="programlisting">unsigned int virDomainGetID (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Get the hypervisor ID number for the domain</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the domain ID number or (unsigned int) -1 in case of error</td></tr></tbody></table></div><h3><a name="virDomainGetInfo" id="virDomainGetInfo"></a>Function: virDomainGetInfo</h3><pre class="programlisting">int virDomainGetInfo (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virDomainInfoPtr">virDomainInfoPtr</a> info)<br />
-</pre><p>Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#virDomainInfo">virDomainInfo</a> structure allocated by the user</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetMaxMemory" id="virDomainGetMaxMemory"></a>Function: virDomainGetMaxMemory</h3><pre class="programlisting">unsigned long virDomainGetMaxMemory (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Retrieve the maximum amount of physical memory allocated to a domain. If domain is NULL, then this get the amount of memory reserved to Domain0 i.e. the domain where the application runs.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object or NULL</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the memory size in kilobytes or 0 in case of error.</td></tr></tbody></table></div><h3><a name="virDomainGetMaxVcpus" id="virDomainGetMaxVcpus"></a>Function: virDomainGetMaxVcpus</h3><pre class="programlisting">int virDomainGetMaxVcpus (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Provides the maximum number of virtual CPUs supported for the guest VM. If the guest is inactive, this is basically the same as virConnectGetMaxVcpus. If the guest is running this will reflect the maximum number of virtual CPUs the guest was booted with.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the maximum of virtual CPU or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virDomainGetName" id="virDomainGetName"></a>Function: virDomainGetName</h3><pre class="programlisting">const char * virDomainGetName (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Get the public name for that domain</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.</td></tr></tbody></table></div><h3><a name="virDomainGetOSType" id="virDomainGetOSType"></a>Function: virDomainGetOSType</h3><pre class="programlisting">char * virDomainGetOSType (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Get the type of domain operation system.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the new string or NULL in case of error, the string must be freed by the caller.</td></tr></tbody></table></div><h3><a name="virDomainGetSchedulerParameters" id="virDomainGetSchedulerParameters"></a>Function: virDomainGetSchedulerParameters</h3><pre class="programlisting">int virDomainGetSchedulerParameters (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br /> int * nparams)<br />
-</pre><p>Get the scheduler parameters, the @params array will be filled with the values.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>params</tt></i>:</span></td><td>pointer to scheduler parameter object (return value)</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>pointer to number of scheduler parameter (this value should be same than the returned value nparams of virDomainGetSchedulerType)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success.</td></tr></tbody></table></div><h3><a name="virDomainGetSchedulerType" id="virDomainGetSchedulerType"></a>Function: virDomainGetSchedulerType</h3><pre class="programlisting">char * virDomainGetSchedulerType (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int * nparams)<br />
-</pre><p>Get the scheduler type.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>number of scheduler parameters(return value)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error. The caller must free the returned string.</td></tr></tbody></table></div><h3><a name="virDomainGetUUID" id="virDomainGetUUID"></a>Function: virDomainGetUUID</h3><pre class="programlisting">int virDomainGetUUID (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned char * uuid)<br />
-</pre><p>Get the UUID for a domain</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetUUIDString" id="virDomainGetUUIDString"></a>Function: virDomainGetUUIDString</h3><pre class="programlisting">int virDomainGetUUIDString (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> char * buf)<br />
-</pre><p>Get the UUID for a domain as string. For more information about UUID see RFC4122.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>buf</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetVcpus" id="virDomainGetVcpus"></a>Function: virDomainGetVcpus</h3><pre class="programlisting">int virDomainGetVcpus (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virVcpuInfoPtr">virVcpuInfoPtr</a> info, <br /> int maxinfo, <br /> unsigned char * cpumaps, <br /> int maplen)<br />
-</pre><p>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer isn't NULL.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer to an array of <a href="libvirt-libvirt.html#virVcpuInfo">virVcpuInfo</a> structures (OUT)</td></tr><tr><td><span class="term"><i><tt>maxinfo</tt></i>:</span></td><td>number of structures in info array</td></tr><tr><td><span class="term"><i><tt>cpumaps</tt></i>:</span></td><td>pointer to an bit map of real CPUs for all vcpus of this domain (in 8-bit bytes) (OUT) If cpumaps is NULL, then no cpumap information is returned by the API. It's assumed there is <maxinfo> cpumap in cpumaps array. The memory allocated to cpumaps must be (maxinfo * maplen) bytes (ie: calloc(maxinfo, maplen)). One cpumap inside cpumaps has the format described in virDomainPinVcpu() API.</td></tr><tr><td><span class="term"><i><tt>maplen</tt></i>:</span></td><td>number of bytes in one cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...).</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of info filled in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetXMLDesc" id="virDomainGetXMLDesc"></a>Function: virDomainGetXMLDesc</h3><pre class="programlisting">char * virDomainGetXMLDesc (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int flags)<br />
-</pre><p>Provide an XML description of the domain. The description may be reused later to relaunch the domain with virDomainCreateLinux().</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>an OR'ed set of <a href="libvirt-libvirt.html#virDomainXMLFlags">virDomainXMLFlags</a></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div><h3><a name="virDomainInterfaceStats" id="virDomainInterfaceStats"></a>Function: virDomainInterfaceStats</h3><pre class="programlisting">int virDomainInterfaceStats (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br /> const char * path, <br /> <a href="libvirt-libvirt.html#virDomainInterfaceStatsPtr">virDomainInterfaceStatsPtr</a> stats, <br /> size_t size)<br />
-</pre><p>This function returns network interface stats for interfaces attached to the domain. The path parameter is the name of the network interface. Domains may have more than network interface. To get stats for each you should make multiple calls to this function. Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to the domain object</td></tr><tr><td><span class="term"><i><tt>path</tt></i>:</span></td><td>path to the interface</td></tr><tr><td><span class="term"><i><tt>stats</tt></i>:</span></td><td>network interface stats (returned)</td></tr><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td>size of stats structure</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainLookupByID" id="virDomainLookupByID"></a>Function: virDomainLookupByID</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainLookupByID (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> int id)<br />
-</pre><p>Try to find a domain based on the hypervisor ID number</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>id</tt></i>:</span></td><td>the domain ID number</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure. If the domain cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> error is raised.</td></tr></tbody></table></div><h3><a name="virDomainLookupByName" id="virDomainLookupByName"></a>Function: virDomainLookupByName</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainLookupByName (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)<br />
-</pre><p>Try to lookup a domain on the given hypervisor based on its name.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name for the domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure. If the domain cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> error is raised.</td></tr></tbody></table></div><h3><a name="virDomainLookupByUUID" id="virDomainLookupByUUID"></a>Function: virDomainLookupByUUID</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainLookupByUUID (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)<br />
-</pre><p>Try to lookup a domain on the given hypervisor based on its UUID.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>the raw UUID for the domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure. If the domain cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> error is raised.</td></tr></tbody></table></div><h3><a name="virDomainLookupByUUIDString" id="virDomainLookupByUUIDString"></a>Function: virDomainLookupByUUIDString</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainLookupByUUIDString (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)<br />
-</pre><p>Try to lookup a domain on the given hypervisor based on its UUID.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuidstr</tt></i>:</span></td><td>the string UUID for the domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure. If the domain cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> error is raised.</td></tr></tbody></table></div><h3><a name="virDomainMigrate" id="virDomainMigrate"></a>Function: virDomainMigrate</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainMigrate (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> dconn, <br /> unsigned long flags, <br /> const char * dname, <br /> const char * uri, <br /> unsigned long bandwidth)<br />
-</pre><p>Migrate the domain object from its current host to the destination host given by dconn (a connection to the destination host). Flags may be one of more of the following: <a href="libvirt-libvirt.html#VIR_MIGRATE_LIVE">VIR_MIGRATE_LIVE</a> Attempt a live migration. If a hypervisor supports renaming domains during migration, then you may set the dname parameter to the new name (otherwise it keeps the same name). If this is not supported by the hypervisor, dname must be NULL or else you will get an error. Since typically the two hypervisors connect directly to each other in order to perform the migration, you may need to specify a path from the source to the destination. This is the purpose of the uri parameter. If uri is NULL, then libvirt will try to find the best method. Uri may specify the hostname or IP address of the destination host as seen from the source. Or uri may be a URI giving transport, hostname, user, port, etc. in the usual form. Refer to driver documentation for the particular URIs supported. The maximum bandwidth (in Mbps) that will be used to do migration can be specified with the bandwidth parameter. If set to 0, libvirt will choose a suitable default. Some hypervisors do not support this feature and will return an error if bandwidth is not 0. To see which features are supported by the current hypervisor, see virConnectGetCapabilities, /capabilities/host/migration_features. There are many limitations on migration imposed by the underlying technology - for example it may not be possible to migrate between different processors even with the same architecture, or between different types of hypervisor.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>dconn</tt></i>:</span></td><td>destination host (a connection object)</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags</td></tr><tr><td><span class="term"><i><tt>dname</tt></i>:</span></td><td>(optional) rename domain to this at destination</td></tr><tr><td><span class="term"><i><tt>uri</tt></i>:</span></td><td>(optional) dest hostname/URI as seen from the source host</td></tr><tr><td><span class="term"><i><tt>bandwidth</tt></i>:</span></td><td>(optional) specify migration bandwidth limit in Mbps</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the new domain object if the migration was successful, or NULL in case of error. Note that the new domain object exists in the scope of the destination connection (dconn).</td></tr></tbody></table></div><h3><a name="virDomainPinVcpu" id="virDomainPinVcpu"></a>Function: virDomainPinVcpu</h3><pre class="programlisting">int virDomainPinVcpu (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int vcpu, <br /> unsigned char * cpumap, <br /> int maplen)<br />
-</pre><p>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>vcpu</tt></i>:</span></td><td>virtual CPU number</td></tr><tr><td><span class="term"><i><tt>cpumap</tt></i>:</span></td><td>pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.</td></tr><tr><td><span class="term"><i><tt>maplen</tt></i>:</span></td><td>number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen < size, missing bytes are set to zero. If maplen > size, failure code is returned.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainReboot" id="virDomainReboot"></a>Function: virDomainReboot</h3><pre class="programlisting">int virDomainReboot (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int flags)<br />
-</pre><p>Reboot a domain, the domain object is still usable there after but the domain OS is being stopped for a restart. Note that the guest OS may ignore the request.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>extra flags for the reboot operation, not used yet</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainRestore" id="virDomainRestore"></a>Function: virDomainRestore</h3><pre class="programlisting">int virDomainRestore (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * from)<br />
-</pre><p>This method will restore a domain saved to disk by virDomainSave().</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>from</tt></i>:</span></td><td>path to the</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainResume" id="virDomainResume"></a>Function: virDomainResume</h3><pre class="programlisting">int virDomainResume (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires privileged access</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSave" id="virDomainSave"></a>Function: virDomainSave</h3><pre class="programlisting">int virDomainSave (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * to)<br />
-</pre><p>This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this may be a problem). Use virDomainRestore() to restore a domain after saving.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>to</tt></i>:</span></td><td>path for the output file</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSetAutostart" id="virDomainSetAutostart"></a>Function: virDomainSetAutostart</h3><pre class="programlisting">int virDomainSetAutostart (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int autostart)<br />
-</pre><p>Configure the domain to be automatically started when the host machine boots.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>whether the domain should be automatically started 0 or 1</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainSetMaxMemory" id="virDomainSetMaxMemory"></a>Function: virDomainSetMaxMemory</h3><pre class="programlisting">int virDomainSetMaxMemory (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned long memory)<br />
-</pre><p>Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function requires privileged access to the hypervisor.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object or NULL</td></tr><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>the memory size in kilobytes</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSetMemory" id="virDomainSetMemory"></a>Function: virDomainSetMemory</h3><pre class="programlisting">int virDomainSetMemory (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned long memory)<br />
-</pre><p>Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may requires privileged access to the hypervisor.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object or NULL</td></tr><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>the memory size in kilobytes</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSetSchedulerParameters" id="virDomainSetSchedulerParameters"></a>Function: virDomainSetSchedulerParameters</h3><pre class="programlisting">int virDomainSetSchedulerParameters (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br /> int nparams)<br />
-</pre><p>Change the scheduler parameters</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>params</tt></i>:</span></td><td>pointer to scheduler parameter objects</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>number of scheduler parameter (this value should be same or less than the returned value nparams of virDomainGetSchedulerType)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success.</td></tr></tbody></table></div><h3><a name="virDomainSetVcpus" id="virDomainSetVcpus"></a>Function: virDomainSetVcpus</h3><pre class="programlisting">int virDomainSetVcpus (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int nvcpus)<br />
-</pre><p>Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires privileged access to the hypervisor.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>nvcpus</tt></i>:</span></td><td>the new number of virtual CPUs for this domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainShutdown" id="virDomainShutdown"></a>Function: virDomainShutdown</h3><pre class="programlisting">int virDomainShutdown (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request. TODO: should we add an option for reboot, knowing it may not be doable in the general case ?</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSuspend" id="virDomainSuspend"></a>Function: virDomainSuspend</h3><pre class="programlisting">int virDomainSuspend (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires privileged access.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainUndefine" id="virDomainUndefine"></a>Function: virDomainUndefine</h3><pre class="programlisting">int virDomainUndefine (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>undefine a domain but does not stop it if it is running</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virGetVersion" id="virGetVersion"></a>Function: virGetVersion</h3><pre class="programlisting">int virGetVersion (unsigned long * libVer, <br /> const char * type, <br /> unsigned long * typeVer)<br />
-</pre><p>Provides two information back, @libVer is the version of the library while @typeVer will be the version of the hypervisor type @type against which the library was compiled. If @type is NULL, "Xen" is assumed, if @type is unknown or not available, an error code will be returned and @typeVer will be 0.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>libVer</tt></i>:</span></td><td>return value for the library version (OUT)</td></tr><tr><td><span class="term"><i><tt>type</tt></i>:</span></td><td>the type of connection/driver looked at</td></tr><tr><td><span class="term"><i><tt>typeVer</tt></i>:</span></td><td>return value for the version of the hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.</td></tr></tbody></table></div><h3><a name="virInitialize" id="virInitialize"></a>Function: virInitialize</h3><pre class="programlisting">int virInitialize (void)<br />
-</pre><p>Initialize the library. It's better to call this routine at startup in multithreaded applications to avoid potential race when initializing the library.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virNetworkCreate" id="virNetworkCreate"></a>Function: virNetworkCreate</h3><pre class="programlisting">int virNetworkCreate (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
-</pre><p>Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>pointer to a defined network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virNetworkCreateXML" id="virNetworkCreateXML"></a>Function: virNetworkCreateXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkCreateXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc)<br />
-</pre><p>Create and start a new virtual network, based on an XML description similar to the one returned by virNetworkGetXMLDesc()</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>an XML description of the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure</td></tr></tbody></table></div><h3><a name="virNetworkDefineXML" id="virNetworkDefineXML"></a>Function: virNetworkDefineXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkDefineXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml)<br />
-</pre><p>Define a network, but does not create it</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>the XML description for the network, preferably in UTF-8</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a pointer to the network otherwise</td></tr></tbody></table></div><h3><a name="virNetworkDestroy" id="virNetworkDestroy"></a>Function: virNetworkDestroy</h3><pre class="programlisting">int virNetworkDestroy (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
-</pre><p>Destroy the network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires privileged access</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virNetworkFree" id="virNetworkFree"></a>Function: virNetworkFree</h3><pre class="programlisting">int virNetworkFree (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
-</pre><p>Free the network object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virNetworkGetAutostart" id="virNetworkGetAutostart"></a>Function: virNetworkGetAutostart</h3><pre class="programlisting">int virNetworkGetAutostart (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int * autostart)<br />
-</pre><p>Provides a boolean value indicating whether the network configured to be automatically started when the host machine boots.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetBridgeName" id="virNetworkGetBridgeName"></a>Function: virNetworkGetBridgeName</h3><pre class="programlisting">char * virNetworkGetBridgeName (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
-</pre><p>Provides a bridge interface name to which a domain may connect a network interface in order to join the network.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div><h3><a name="virNetworkGetConnect" id="virNetworkGetConnect"></a>Function: virNetworkGetConnect</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virNetworkGetConnect (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net)<br />
-</pre><p>Provides the connection pointer associated with a network. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the network object together.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>net</tt></i>:</span></td><td>pointer to a network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virNetworkGetName" id="virNetworkGetName"></a>Function: virNetworkGetName</h3><pre class="programlisting">const char * virNetworkGetName (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
-</pre><p>Get the public name for that network</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the network object.</td></tr></tbody></table></div><h3><a name="virNetworkGetUUID" id="virNetworkGetUUID"></a>Function: virNetworkGetUUID</h3><pre class="programlisting">int virNetworkGetUUID (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> unsigned char * uuid)<br />
-</pre><p>Get the UUID for a network</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetUUIDString" id="virNetworkGetUUIDString"></a>Function: virNetworkGetUUIDString</h3><pre class="programlisting">int virNetworkGetUUIDString (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> char * buf)<br />
-</pre><p>Get the UUID for a network as string. For more information about UUID see RFC4122.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>buf</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetXMLDesc" id="virNetworkGetXMLDesc"></a>Function: virNetworkGetXMLDesc</h3><pre class="programlisting">char * virNetworkGetXMLDesc (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int flags)<br />
-</pre><p>Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>and OR'ed set of extraction flags, not used yet</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div><h3><a name="virNetworkLookupByName" id="virNetworkLookupByName"></a>Function: virNetworkLookupByName</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkLookupByName (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)<br />
-</pre><p>Try to lookup a network on the given hypervisor based on its name.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name for the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkLookupByUUID" id="virNetworkLookupByUUID"></a>Function: virNetworkLookupByUUID</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkLookupByUUID (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)<br />
-</pre><p>Try to lookup a network on the given hypervisor based on its UUID.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>the raw UUID for the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkLookupByUUIDString" id="virNetworkLookupByUUIDString"></a>Function: virNetworkLookupByUUIDString</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkLookupByUUIDString (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)<br />
-</pre><p>Try to lookup a network on the given hypervisor based on its UUID.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuidstr</tt></i>:</span></td><td>the string UUID for the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkSetAutostart" id="virNetworkSetAutostart"></a>Function: virNetworkSetAutostart</h3><pre class="programlisting">int virNetworkSetAutostart (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int autostart)<br />
-</pre><p>Configure the network to be automatically started when the host machine boots.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>whether the network should be automatically started 0 or 1</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkUndefine" id="virNetworkUndefine"></a>Function: virNetworkUndefine</h3><pre class="programlisting">int virNetworkUndefine (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
-</pre><p>Undefine a network but does not stop it if it is running</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>pointer to a defined network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virNodeGetCellsFreeMemory" id="virNodeGetCellsFreeMemory"></a>Function: virNodeGetCellsFreeMemory</h3><pre class="programlisting">int virNodeGetCellsFreeMemory (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> unsigned long long * freeMems, <br /> int startCell, <br /> int maxCells)<br />
-</pre><p>This call returns the amount of free memory in one or more NUMA cells. The @freeMems array must be allocated by the caller and will be filled with the amount of free memory in kilobytes for each cell requested, starting with startCell (in freeMems[0]), up to either (startCell + maxCells), or the number of additional cells in the node, whichever is smaller.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>freeMems</tt></i>:</span></td><td>pointer to the array of unsigned long long</td></tr><tr><td><span class="term"><i><tt>startCell</tt></i>:</span></td><td>index of first cell to return freeMems info on.</td></tr><tr><td><span class="term"><i><tt>maxCells</tt></i>:</span></td><td>Maximum number of cells for which freeMems information can be returned.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of entries filled in freeMems, or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virNodeGetFreeMemory" id="virNodeGetFreeMemory"></a>Function: virNodeGetFreeMemory</h3><pre class="programlisting">unsigned long long virNodeGetFreeMemory (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>provides the free memory available on the Node</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the available free memory in kilobytes or 0 in case of error</td></tr></tbody></table></div><h3><a name="virNodeGetInfo" id="virNodeGetInfo"></a>Function: virNodeGetInfo</h3><pre class="programlisting">int virNodeGetInfo (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> <a href="libvirt-libvirt.html#virNodeInfoPtr">virNodeInfoPtr</a> info)<br />
-</pre><p>Extract hardware information about the node.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#virNodeInfo">virNodeInfo</a> structure allocated by the user</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virStoragePoolBuild" id="virStoragePoolBuild"></a>Function: virStoragePoolBuild</h3><pre class="programlisting">int virStoragePoolBuild (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)<br />
-</pre><p>Build the underlying storage pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 upon failure</td></tr></tbody></table></div><h3><a name="virStoragePoolCreate" id="virStoragePoolCreate"></a>Function: virStoragePoolCreate</h3><pre class="programlisting">int virStoragePoolCreate (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)<br />
-</pre><p>Starts an inactive storage pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be started</td></tr></tbody></table></div><h3><a name="virStoragePoolCreateXML" id="virStoragePoolCreateXML"></a>Function: virStoragePoolCreateXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolCreateXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc, <br /> unsigned int flags)<br />
-</pre><p>Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStoragePoolDefineXML" id="virStoragePoolDefineXML"></a>Function: virStoragePoolDefineXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolDefineXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml, <br /> unsigned int flags)<br />
-</pre><p>Define a new inactive storage pool based on its XML description. The pool is persistent, until explicitly undefined.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStoragePoolDelete" id="virStoragePoolDelete"></a>Function: virStoragePoolDelete</h3><pre class="programlisting">int virStoragePoolDelete (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)<br />
-</pre><p>Delete the underlying pool resources. This is a non-recoverable operation. The <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object itself is not free'd.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for obliteration process</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be obliterate</td></tr></tbody></table></div><h3><a name="virStoragePoolDestroy" id="virStoragePoolDestroy"></a>Function: virStoragePoolDestroy</h3><pre class="programlisting">int virStoragePoolDestroy (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Destroy an active storage pool. This will deactivate the pool on the host, but keep any persistent config associated with it. If it has a persistent config it can later be restarted with virStoragePoolCreate(). This does not free the associated <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be destroyed</td></tr></tbody></table></div><h3><a name="virStoragePoolFree" id="virStoragePoolFree"></a>Function: virStoragePoolFree</h3><pre class="programlisting">int virStoragePoolFree (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Free a storage pool object, releasing all memory associated with it. Does not change the state of the pool on the host.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be free'd.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetAutostart" id="virStoragePoolGetAutostart"></a>Function: virStoragePoolGetAutostart</h3><pre class="programlisting">int virStoragePoolGetAutostart (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> int * autostart)<br />
-</pre><p>Fetches the value of the autostart flag, which determines whether the pool is automatically started at boot time</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>location in which to store autostart flag</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolGetConnect" id="virStoragePoolGetConnect"></a>Function: virStoragePoolGetConnect</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virStoragePoolGetConnect (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Provides the connection pointer associated with a storage pool. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the pool object together.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to a pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetInfo" id="virStoragePoolGetInfo"></a>Function: virStoragePoolGetInfo</h3><pre class="programlisting">int virStoragePoolGetInfo (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> <a href="libvirt-libvirt.html#virStoragePoolInfoPtr">virStoragePoolInfoPtr</a> info)<br />
-</pre><p>Get volatile information about the storage pool such as free space / usage summary</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer at which to store info</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on failure.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetName" id="virStoragePoolGetName"></a>Function: virStoragePoolGetName</h3><pre class="programlisting">const char * virStoragePoolGetName (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Fetch the locally unique name of the storage pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the name of the pool, or NULL on error</td></tr></tbody></table></div><h3><a name="virStoragePoolGetUUID" id="virStoragePoolGetUUID"></a>Function: virStoragePoolGetUUID</h3><pre class="programlisting">int virStoragePoolGetUUID (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned char * uuid)<br />
-</pre><p>Fetch the globally unique ID of the storage pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>buffer of <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes in size</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error;</td></tr></tbody></table></div><h3><a name="virStoragePoolGetUUIDString" id="virStoragePoolGetUUIDString"></a>Function: virStoragePoolGetUUIDString</h3><pre class="programlisting">int virStoragePoolGetUUIDString (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> char * buf)<br />
-</pre><p>Fetch the globally unique ID of the storage pool as a string</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>buf</tt></i>:</span></td><td>buffer of <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes in size</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error;</td></tr></tbody></table></div><h3><a name="virStoragePoolGetXMLDesc" id="virStoragePoolGetXMLDesc"></a>Function: virStoragePoolGetXMLDesc</h3><pre class="programlisting">char * virStoragePoolGetXMLDesc (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)<br />
-</pre><p>Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the <a href="libvirt-libvirt.html#virStoragePoolCreateXML">virStoragePoolCreateXML</a> method.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML format options (set of virDomainXMLFlags)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a XML document, or NULL on error</td></tr></tbody></table></div><h3><a name="virStoragePoolListVolumes" id="virStoragePoolListVolumes"></a>Function: virStoragePoolListVolumes</h3><pre class="programlisting">int virStoragePoolListVolumes (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> char ** const names, <br /> int maxnames)<br />
-</pre><p>Fetch list of storage volume names, limiting to at most maxnames.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array in which to storage volume names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names fetched, or -1 on error</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByName" id="virStoragePoolLookupByName"></a>Function: virStoragePoolLookupByName</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolLookupByName (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)<br />
-</pre><p>Fetch a storage pool based on its unique name</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByUUID" id="virStoragePoolLookupByUUID"></a>Function: virStoragePoolLookupByUUID</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolLookupByUUID (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)<br />
-</pre><p>Fetch a storage pool based on its globally unique id</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>globally unique id of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByUUIDString" id="virStoragePoolLookupByUUIDString"></a>Function: virStoragePoolLookupByUUIDString</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolLookupByUUIDString (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)<br />
-</pre><p>Fetch a storage pool based on its globally unique id</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuidstr</tt></i>:</span></td><td>globally unique id of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByVolume" id="virStoragePoolLookupByVolume"></a>Function: virStoragePoolLookupByVolume</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolLookupByVolume (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Fetch a storage pool which contains a particular volume</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolNumOfVolumes" id="virStoragePoolNumOfVolumes"></a>Function: virStoragePoolNumOfVolumes</h3><pre class="programlisting">int virStoragePoolNumOfVolumes (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Fetch the number of storage volumes within a pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of storage pools, or -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolRefresh" id="virStoragePoolRefresh"></a>Function: virStoragePoolRefresh</h3><pre class="programlisting">int virStoragePoolRefresh (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)<br />
-</pre><p>Request that the pool refresh its list of volumes. This may involve communicating with a remote server, and/or initializing new devices at the OS layer</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags to control refresh behaviour (currently unused, use 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if the volume list was refreshed, -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolSetAutostart" id="virStoragePoolSetAutostart"></a>Function: virStoragePoolSetAutostart</h3><pre class="programlisting">int virStoragePoolSetAutostart (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> int autostart)<br />
-</pre><p>Sets the autostart flag</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>new flag setting</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolUndefine" id="virStoragePoolUndefine"></a>Function: virStoragePoolUndefine</h3><pre class="programlisting">int virStoragePoolUndefine (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Undefine an inactive storage pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStorageVolCreateXML" id="virStorageVolCreateXML"></a>Function: virStorageVolCreateXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> virStorageVolCreateXML (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> const char * xmldesc, <br /> unsigned int flags)<br />
-</pre><p>Create a storage volume within a pool based on an XML description. Not all pools support creation of volumes</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>xmldesc</tt></i>:</span></td><td>description of volume to create</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for creation (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the storage volume, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolDelete" id="virStorageVolDelete"></a>Function: virStorageVolDelete</h3><pre class="programlisting">int virStorageVolDelete (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> unsigned int flags)<br />
-</pre><p>Delete the storage volume from the pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><a name="virStorageVolFree" id="virStorageVolFree"></a>Function: virStorageVolFree</h3><pre class="programlisting">int virStorageVolFree (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Release the storage volume handle. The underlying storage volume contains to exist</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetConnect" id="virStorageVolGetConnect"></a>Function: virStorageVolGetConnect</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virStorageVolGetConnect (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Provides the connection pointer associated with a storage volume. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the volume object together.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to a pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virStorageVolGetInfo" id="virStorageVolGetInfo"></a>Function: virStorageVolGetInfo</h3><pre class="programlisting">int virStorageVolGetInfo (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> <a href="libvirt-libvirt.html#virStorageVolInfoPtr">virStorageVolInfoPtr</a> info)<br />
-</pre><p>Fetches volatile information about the storage volume such as its current allocation</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer at which to store info</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on failure</td></tr></tbody></table></div><h3><a name="virStorageVolGetKey" id="virStorageVolGetKey"></a>Function: virStorageVolGetKey</h3><pre class="programlisting">const char * virStorageVolGetKey (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Fetch the storage volume key. This is globally unique, so the same volume will have the same key no matter what host it is accessed from</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the volume key, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetName" id="virStorageVolGetName"></a>Function: virStorageVolGetName</h3><pre class="programlisting">const char * virStorageVolGetName (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Fetch the storage volume name. This is unique within the scope of a pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the volume name, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetPath" id="virStorageVolGetPath"></a>Function: virStorageVolGetPath</h3><pre class="programlisting">char * virStorageVolGetPath (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Fetch the storage volume path. Depending on the pool configuration this is either persistent across hosts, or dynamically assigned at pool startup. Consult pool documentation for information on getting the persistent naming</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the storage volume path, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetXMLDesc" id="virStorageVolGetXMLDesc"></a>Function: virStorageVolGetXMLDesc</h3><pre class="programlisting">char * virStorageVolGetXMLDesc (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> unsigned int flags)<br />
-</pre><p>Fetch an XML document describing all aspects of the storage volume</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML generation (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the XML document, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolLookupByKey" id="virStorageVolLookupByKey"></a>Function: virStorageVolLookupByKey</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> virStorageVolLookupByKey (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * key)<br />
-</pre><p>Fetch a pointer to a storage volume based on its globally unique key</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>key</tt></i>:</span></td><td>globally unique key</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div><h3><a name="virStorageVolLookupByName" id="virStorageVolLookupByName"></a>Function: virStorageVolLookupByName</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> virStorageVolLookupByName (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> const char * name)<br />
-</pre><p>Fetch a pointer to a storage volume based on its name within a pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name of storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div><h3><a name="virStorageVolLookupByPath" id="virStorageVolLookupByPath"></a>Function: virStorageVolLookupByPath</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> virStorageVolLookupByPath (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * path)<br />
-</pre><p>Fetch a pointer to a storage volume based on its locally (host) unique path</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>path</tt></i>:</span></td><td>locally unique path</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a href="../html/index.html">API Menu</a></li><li><a href="../examples/index.html">C code examples</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+</pre></div><h3><a name="virStorageVolDeleteFlags" id="virStorageVolDeleteFlags"><code>virStorageVolDeleteFlags</code></a></h3><div class="api"><pre>enum virStorageVolDeleteFlags {
+</pre><table><tr><td><a name="VIR_STORAGE_VOL_DELETE_NORMAL" id="VIR_STORAGE_VOL_DELETE_NORMAL">VIR_STORAGE_VOL_DELETE_NORMAL</a></td><td> = </td><td>0</td><td> : Delete metadata only (fast)</td></tr><tr><td><a name="VIR_STORAGE_VOL_DELETE_ZEROED" id="VIR_STORAGE_VOL_DELETE_ZEROED">VIR_STORAGE_VOL_DELETE_ZEROED</a></td><td> = </td><td>1</td><td> : Clear all data to zeros (slow)</td></tr></table><pre>}
+</pre></div><h3><a name="virStorageVolInfo" id="virStorageVolInfo"><code>virStorageVolInfo</code></a></h3><div class="api"><pre>struct virStorageVolInfo{
+</pre><table><tr><td>int</td><td>type</td><td> : <a href="libvirt-libvirt.html#virStorageVolType">virStorageVolType</a> flags</td></tr><tr><td>unsigned long long</td><td>capacity</td><td> : Logical size bytes</td></tr><tr><td>unsigned long long</td><td>allocation</td><td> : Current allocation bytes</td></tr></table><pre>
+}
+</pre></div><h3><a name="virStorageVolType" id="virStorageVolType"><code>virStorageVolType</code></a></h3><div class="api"><pre>enum virStorageVolType {
+</pre><table><tr><td><a name="VIR_STORAGE_VOL_FILE" id="VIR_STORAGE_VOL_FILE">VIR_STORAGE_VOL_FILE</a></td><td> = </td><td>0</td><td> : Regular file based volumes</td></tr><tr><td><a name="VIR_STORAGE_VOL_BLOCK" id="VIR_STORAGE_VOL_BLOCK">VIR_STORAGE_VOL_BLOCK</a></td><td> = </td><td>1</td><td> : Block based volumes</td></tr></table><pre>}
+</pre></div><h3><a name="virVcpuInfo" id="virVcpuInfo"><code>virVcpuInfo</code></a></h3><div class="api"><pre>struct virVcpuInfo{
+</pre><table><tr><td>unsigned int</td><td>number</td><td> : virtual CPU number</td></tr><tr><td>int</td><td>state</td><td> : value from <a href="libvirt-libvirt.html#virVcpuState">virVcpuState</a></td></tr><tr><td>unsigned long long</td><td>cpuTime</td><td> : CPU time used, in nanoseconds</td></tr><tr><td>int</td><td>cpu</td><td> : real CPU number, or -1 if offline</td></tr></table><pre>
+}
+</pre></div><h3><a name="virVcpuState" id="virVcpuState"><code>virVcpuState</code></a></h3><div class="api"><pre>enum virVcpuState {
+</pre><table><tr><td><a name="VIR_VCPU_OFFLINE" id="VIR_VCPU_OFFLINE">VIR_VCPU_OFFLINE</a></td><td> = </td><td>0</td><td> : the virtual CPU is offline</td></tr><tr><td><a name="VIR_VCPU_RUNNING" id="VIR_VCPU_RUNNING">VIR_VCPU_RUNNING</a></td><td> = </td><td>1</td><td> : the virtual CPU is running</td></tr><tr><td><a name="VIR_VCPU_BLOCKED" id="VIR_VCPU_BLOCKED">VIR_VCPU_BLOCKED</a></td><td> = </td><td>2</td><td> : the virtual CPU is blocked on resource</td></tr></table><pre>}
+</pre></div><h3><a name="functions" id="functions">Functions</a></h3><h3><a name="virConnectAuthCallbackPtr" id="virConnectAuthCallbackPtr"><code>virConnectAuthCallbackPtr</code></a></h3><pre class="programlisting">typedef int (*virConnectAuthCallbackPtr) (<a href="libvirt-libvirt.html#virConnectCredentialPtr">virConnectCredentialPtr</a> cred, <br /> unsigned int ncred, <br /> void * cbdata)
+</pre><p></p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>cred</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>ncred</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>cbdata</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td></td></tr></tbody></table></div><br /><h3><a name="virConnectClose" id="virConnectClose"><code>virConnectClose</code></a></h3><pre class="programlisting">int virConnectClose (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>This function closes the connection to the Hypervisor. This should not be called if further interaction with the Hypervisor are needed especially if there is running domain which need further monitoring by the application.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virConnectGetCapabilities" id="virConnectGetCapabilities"><code>virConnectGetCapabilities</code></a></h3><pre class="programlisting">char * virConnectGetCapabilities (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides capabilities of the hypervisor / driver.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, or an XML string defining the capabilities. The client must free the returned string after use.</td></tr></tbody></table></div><h3><a name="virConnectGetHostname" id="virConnectGetHostname"><code>virConnectGetHostname</code></a></h3><pre class="programlisting">char * virConnectGetHostname (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>This returns the system hostname on which the hypervisor is running (the result of the gethostname(2) system call). If we are connected to a remote system, then this returns the hostname of the remote system.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to a hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the hostname which must be freed by the caller, or NULL if there was an error.</td></tr></tbody></table></div><h3><a name="virConnectGetMaxVcpus" id="virConnectGetMaxVcpus"><code>virConnectGetMaxVcpus</code></a></h3><pre class="programlisting">int virConnectGetMaxVcpus (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * type)<br />
+</pre><p>Provides the maximum number of virtual CPUs supported for a guest VM of a specific type. The 'type' parameter here corresponds to the 'type' attribute in the <domain> element of the XML.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>type</tt></i>:</span></td><td>value of the 'type' attribute in the <domain> element</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the maximum of virtual CPU or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virConnectGetType" id="virConnectGetType"><code>virConnectGetType</code></a></h3><pre class="programlisting">const char * virConnectGetType (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Get the name of the Hypervisor software used.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a static zero terminated string otherwise. See also: http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html</td></tr></tbody></table></div><h3><a name="virConnectGetURI" id="virConnectGetURI"><code>virConnectGetURI</code></a></h3><pre class="programlisting">char * virConnectGetURI (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>This returns the URI (name) of the hypervisor connection. Normally this is the same as or similar to the string passed to the virConnectOpen/virConnectOpenReadOnly call, but the driver may make the URI canonical. If name == NULL was passed to virConnectOpen, then the driver will return a non-NULL URI which can be used to connect to the same hypervisor later.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to a hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the URI string which must be freed by the caller, or NULL if there was an error.</td></tr></tbody></table></div><h3><a name="virConnectGetVersion" id="virConnectGetVersion"><code>virConnectGetVersion</code></a></h3><pre class="programlisting">int virConnectGetVersion (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> unsigned long * hvVer)<br />
+</pre><p>Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with privileged access to the hypervisor, not with a Read-Only connection.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>hvVer</tt></i>:</span></td><td>return value for the version of the running hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 otherwise. if the version can't be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release</td></tr></tbody></table></div><h3><a name="virConnectListDefinedDomains" id="virConnectListDefinedDomains"><code>virConnectListDefinedDomains</code></a></h3><pre class="programlisting">int virConnectListDefinedDomains (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)<br />
+</pre><p>list the defined but inactive domains, stores the pointers to the names in @names</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>pointer to an array to store the names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names provided in the array or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListDefinedNetworks" id="virConnectListDefinedNetworks"><code>virConnectListDefinedNetworks</code></a></h3><pre class="programlisting">int virConnectListDefinedNetworks (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)<br />
+</pre><p>list the inactive networks, stores the pointers to the names in @names</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>pointer to an array to store the names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names provided in the array or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListDefinedStoragePools" id="virConnectListDefinedStoragePools"><code>virConnectListDefinedStoragePools</code></a></h3><pre class="programlisting">int virConnectListDefinedStoragePools (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)<br />
+</pre><p>Provides the list of names of inactive storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array of char * to fill with pool names (allocated by caller)</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on error</td></tr></tbody></table></div><h3><a name="virConnectListDomains" id="virConnectListDomains"><code>virConnectListDomains</code></a></h3><pre class="programlisting">int virConnectListDomains (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> int * ids, <br /> int maxids)<br />
+</pre><p>Collect the list of active domains, and store their ID in @maxids</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>ids</tt></i>:</span></td><td>array to collect the list of IDs of active domains</td></tr><tr><td><span class="term"><i><tt>maxids</tt></i>:</span></td><td>size of @ids</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListNetworks" id="virConnectListNetworks"><code>virConnectListNetworks</code></a></h3><pre class="programlisting">int virConnectListNetworks (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)<br />
+</pre><p>Collect the list of active networks, and store their names in @names</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array to collect the list of names of active networks</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of @names</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of networks found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListStoragePools" id="virConnectListStoragePools"><code>virConnectListStoragePools</code></a></h3><pre class="programlisting">int virConnectListStoragePools (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> char ** const names, <br /> int maxnames)<br />
+</pre><p>Provides the list of names of active storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array of char * to fill with pool names (allocated by caller)</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedDomains" id="virConnectNumOfDefinedDomains"><code>virConnectNumOfDefinedDomains</code></a></h3><pre class="programlisting">int virConnectNumOfDefinedDomains (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of defined but inactive domains.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedNetworks" id="virConnectNumOfDefinedNetworks"><code>virConnectNumOfDefinedNetworks</code></a></h3><pre class="programlisting">int virConnectNumOfDefinedNetworks (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of inactive networks.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of networks found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedStoragePools" id="virConnectNumOfDefinedStoragePools"><code>virConnectNumOfDefinedStoragePools</code></a></h3><pre class="programlisting">int virConnectNumOfDefinedStoragePools (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of inactive storage pools</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of pools found, or -1 on error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDomains" id="virConnectNumOfDomains"><code>virConnectNumOfDomains</code></a></h3><pre class="programlisting">int virConnectNumOfDomains (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of active domains.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfNetworks" id="virConnectNumOfNetworks"><code>virConnectNumOfNetworks</code></a></h3><pre class="programlisting">int virConnectNumOfNetworks (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of active networks.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of network found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfStoragePools" id="virConnectNumOfStoragePools"><code>virConnectNumOfStoragePools</code></a></h3><pre class="programlisting">int virConnectNumOfStoragePools (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of active storage pools</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of pools found, or -1 on error</td></tr></tbody></table></div><h3><a name="virConnectOpen" id="virConnectOpen"><code>virConnectOpen</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virConnectOpen (const char * name)<br />
+</pre><p>This function should be called first to get a connection to the Hypervisor and xen store</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virConnectOpenAuth" id="virConnectOpenAuth"><code>virConnectOpenAuth</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virConnectOpenAuth (const char * name, <br /> <a href="libvirt-libvirt.html#virConnectAuthPtr">virConnectAuthPtr</a> auth, <br /> int flags)<br />
+</pre><p>This function should be called first to get a connection to the Hypervisor. If necessary, authentication will be performed fetching credentials via the callback</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>auth</tt></i>:</span></td><td>Authenticate callback parameters</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>Open flags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virConnectOpenReadOnly" id="virConnectOpenReadOnly"><code>virConnectOpenReadOnly</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virConnectOpenReadOnly (const char * name)<br />
+</pre><p>This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virDomainAttachDevice" id="virDomainAttachDevice"><code>virDomainAttachDevice</code></a></h3><pre class="programlisting">int virDomainAttachDevice (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * xml)<br />
+</pre><p>Create a virtual device attachment to backend.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>pointer to XML description of one device</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainBlockStats" id="virDomainBlockStats"><code>virDomainBlockStats</code></a></h3><pre class="programlisting">int virDomainBlockStats (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br /> const char * path, <br /> <a href="libvirt-libvirt.html#virDomainBlockStatsPtr">virDomainBlockStatsPtr</a> stats, <br /> size_t size)<br />
+</pre><p>This function returns block device (disk) stats for block devices attached to the domain. The path parameter is the name of the block device. Get this by calling <a href="libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a> and finding the <target dev='...'> attribute within //domain/devices/disk. (For example, "xvda"). Domains may have more than one block device. To get stats for each you should make multiple calls to this function. Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to the domain object</td></tr><tr><td><span class="term"><i><tt>path</tt></i>:</span></td><td>path to the block device</td></tr><tr><td><span class="term"><i><tt>stats</tt></i>:</span></td><td>block device stats (returned)</td></tr><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td>size of stats structure</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainCoreDump" id="virDomainCoreDump"><code>virDomainCoreDump</code></a></h3><pre class="programlisting">int virDomainCoreDump (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * to, <br /> int flags)<br />
+</pre><p>This method will dump the core of a domain on a given file for analysis. Note that for remote Xen Daemon the file path will be interpreted in the remote host.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>to</tt></i>:</span></td><td>path for the core file</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>extra flags, currently unused</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainCreate" id="virDomainCreate"><code>virDomainCreate</code></a></h3><pre class="programlisting">int virDomainCreate (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virDomainCreateLinux" id="virDomainCreateLinux"><code>virDomainCreateLinux</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainCreateLinux (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc, <br /> unsigned int flags)<br />
+</pre><p>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>string containing an XML description of the domain</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>an optional set of virDomainFlags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure</td></tr></tbody></table></div><h3><a name="virDomainDefineXML" id="virDomainDefineXML"><code>virDomainDefineXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainDefineXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml)<br />
+</pre><p>define a domain, but does not start it</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>the XML description for the domain, preferably in UTF-8</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a pointer to the domain otherwise</td></tr></tbody></table></div><h3><a name="virDomainDestroy" id="virDomainDestroy"><code>virDomainDestroy</code></a></h3><pre class="programlisting">int virDomainDestroy (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires privileged access</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainDetachDevice" id="virDomainDetachDevice"><code>virDomainDetachDevice</code></a></h3><pre class="programlisting">int virDomainDetachDevice (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * xml)<br />
+</pre><p>Destroy a virtual device attachment to backend.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>pointer to XML description of one device</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainFree" id="virDomainFree"><code>virDomainFree</code></a></h3><pre class="programlisting">int virDomainFree (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetAutostart" id="virDomainGetAutostart"><code>virDomainGetAutostart</code></a></h3><pre class="programlisting">int virDomainGetAutostart (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int * autostart)<br />
+</pre><p>Provides a boolean value indicating whether the domain configured to be automatically started when the host machine boots.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetConnect" id="virDomainGetConnect"><code>virDomainGetConnect</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virDomainGetConnect (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom)<br />
+</pre><p>Provides the connection pointer associated with a domain. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the domain object together.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to a domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetID" id="virDomainGetID"><code>virDomainGetID</code></a></h3><pre class="programlisting">unsigned int virDomainGetID (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Get the hypervisor ID number for the domain</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the domain ID number or (unsigned int) -1 in case of error</td></tr></tbody></table></div><h3><a name="virDomainGetInfo" id="virDomainGetInfo"><code>virDomainGetInfo</code></a></h3><pre class="programlisting">int virDomainGetInfo (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virDomainInfoPtr">virDomainInfoPtr</a> info)<br />
+</pre><p>Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#virDomainInfo">virDomainInfo</a> structure allocated by the user</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetMaxMemory" id="virDomainGetMaxMemory"><code>virDomainGetMaxMemory</code></a></h3><pre class="programlisting">unsigned long virDomainGetMaxMemory (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Retrieve the maximum amount of physical memory allocated to a domain. If domain is NULL, then this get the amount of memory reserved to Domain0 i.e. the domain where the application runs.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object or NULL</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the memory size in kilobytes or 0 in case of error.</td></tr></tbody></table></div><h3><a name="virDomainGetMaxVcpus" id="virDomainGetMaxVcpus"><code>virDomainGetMaxVcpus</code></a></h3><pre class="programlisting">int virDomainGetMaxVcpus (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Provides the maximum number of virtual CPUs supported for the guest VM. If the guest is inactive, this is basically the same as virConnectGetMaxVcpus. If the guest is running this will reflect the maximum number of virtual CPUs the guest was booted with.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the maximum of virtual CPU or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virDomainGetName" id="virDomainGetName"><code>virDomainGetName</code></a></h3><pre class="programlisting">const char * virDomainGetName (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Get the public name for that domain</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.</td></tr></tbody></table></div><h3><a name="virDomainGetOSType" id="virDomainGetOSType"><code>virDomainGetOSType</code></a></h3><pre class="programlisting">char * virDomainGetOSType (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Get the type of domain operation system.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the new string or NULL in case of error, the string must be freed by the caller.</td></tr></tbody></table></div><h3><a name="virDomainGetSchedulerParameters" id="virDomainGetSchedulerParameters"><code>virDomainGetSchedulerParameters</code></a></h3><pre class="programlisting">int virDomainGetSchedulerParameters (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br /> int * nparams)<br />
+</pre><p>Get the scheduler parameters, the @params array will be filled with the values.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>params</tt></i>:</span></td><td>pointer to scheduler parameter object (return value)</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>pointer to number of scheduler parameter (this value should be same than the returned value nparams of virDomainGetSchedulerType)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success.</td></tr></tbody></table></div><h3><a name="virDomainGetSchedulerType" id="virDomainGetSchedulerType"><code>virDomainGetSchedulerType</code></a></h3><pre class="programlisting">char * virDomainGetSchedulerType (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int * nparams)<br />
+</pre><p>Get the scheduler type.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>number of scheduler parameters(return value)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error. The caller must free the returned string.</td></tr></tbody></table></div><h3><a name="virDomainGetUUID" id="virDomainGetUUID"><code>virDomainGetUUID</code></a></h3><pre class="programlisting">int virDomainGetUUID (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned char * uuid)<br />
+</pre><p>Get the UUID for a domain</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetUUIDString" id="virDomainGetUUIDString"><code>virDomainGetUUIDString</code></a></h3><pre class="programlisting">int virDomainGetUUIDString (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> char * buf)<br />
+</pre><p>Get the UUID for a domain as string. For more information about UUID see RFC4122.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>buf</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetVcpus" id="virDomainGetVcpus"><code>virDomainGetVcpus</code></a></h3><pre class="programlisting">int virDomainGetVcpus (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virVcpuInfoPtr">virVcpuInfoPtr</a> info, <br /> int maxinfo, <br /> unsigned char * cpumaps, <br /> int maplen)<br />
+</pre><p>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer isn't NULL.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer to an array of <a href="libvirt-libvirt.html#virVcpuInfo">virVcpuInfo</a> structures (OUT)</td></tr><tr><td><span class="term"><i><tt>maxinfo</tt></i>:</span></td><td>number of structures in info array</td></tr><tr><td><span class="term"><i><tt>cpumaps</tt></i>:</span></td><td>pointer to an bit map of real CPUs for all vcpus of this domain (in 8-bit bytes) (OUT) If cpumaps is NULL, then no cpumap information is returned by the API. It's assumed there is <maxinfo> cpumap in cpumaps array. The memory allocated to cpumaps must be (maxinfo * maplen) bytes (ie: calloc(maxinfo, maplen)). One cpumap inside cpumaps has the format described in virDomainPinVcpu() API.</td></tr><tr><td><span class="term"><i><tt>maplen</tt></i>:</span></td><td>number of bytes in one cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...).</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of info filled in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetXMLDesc" id="virDomainGetXMLDesc"><code>virDomainGetXMLDesc</code></a></h3><pre class="programlisting">char * virDomainGetXMLDesc (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int flags)<br />
+</pre><p>Provide an XML description of the domain. The description may be reused later to relaunch the domain with virDomainCreateLinux().</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>an OR'ed set of <a href="libvirt-libvirt.html#virDomainXMLFlags">virDomainXMLFlags</a></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div><h3><a name="virDomainInterfaceStats" id="virDomainInterfaceStats"><code>virDomainInterfaceStats</code></a></h3><pre class="programlisting">int virDomainInterfaceStats (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br /> const char * path, <br /> <a href="libvirt-libvirt.html#virDomainInterfaceStatsPtr">virDomainInterfaceStatsPtr</a> stats, <br /> size_t size)<br />
+</pre><p>This function returns network interface stats for interfaces attached to the domain. The path parameter is the name of the network interface. Domains may have more than network interface. To get stats for each you should make multiple calls to this function. Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to the domain object</td></tr><tr><td><span class="term"><i><tt>path</tt></i>:</span></td><td>path to the interface</td></tr><tr><td><span class="term"><i><tt>stats</tt></i>:</span></td><td>network interface stats (returned)</td></tr><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td>size of stats structure</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainLookupByID" id="virDomainLookupByID"><code>virDomainLookupByID</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainLookupByID (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> int id)<br />
+</pre><p>Try to find a domain based on the hypervisor ID number</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>id</tt></i>:</span></td><td>the domain ID number</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure. If the domain cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> error is raised.</td></tr></tbody></table></div><h3><a name="virDomainLookupByName" id="virDomainLookupByName"><code>virDomainLookupByName</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainLookupByName (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)<br />
+</pre><p>Try to lookup a domain on the given hypervisor based on its name.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name for the domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure. If the domain cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> error is raised.</td></tr></tbody></table></div><h3><a name="virDomainLookupByUUID" id="virDomainLookupByUUID"><code>virDomainLookupByUUID</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainLookupByUUID (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)<br />
+</pre><p>Try to lookup a domain on the given hypervisor based on its UUID.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>the raw UUID for the domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure. If the domain cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> error is raised.</td></tr></tbody></table></div><h3><a name="virDomainLookupByUUIDString" id="virDomainLookupByUUIDString"><code>virDomainLookupByUUIDString</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainLookupByUUIDString (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)<br />
+</pre><p>Try to lookup a domain on the given hypervisor based on its UUID.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuidstr</tt></i>:</span></td><td>the string UUID for the domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure. If the domain cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> error is raised.</td></tr></tbody></table></div><h3><a name="virDomainMigrate" id="virDomainMigrate"><code>virDomainMigrate</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainMigrate (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> dconn, <br /> unsigned long flags, <br /> const char * dname, <br /> const char * uri, <br /> unsigned long bandwidth)<br />
+</pre><p>Migrate the domain object from its current host to the destination host given by dconn (a connection to the destination host). Flags may be one of more of the following: <a href="libvirt-libvirt.html#VIR_MIGRATE_LIVE">VIR_MIGRATE_LIVE</a> Attempt a live migration. If a hypervisor supports renaming domains during migration, then you may set the dname parameter to the new name (otherwise it keeps the same name). If this is not supported by the hypervisor, dname must be NULL or else you will get an error. Since typically the two hypervisors connect directly to each other in order to perform the migration, you may need to specify a path from the source to the destination. This is the purpose of the uri parameter. If uri is NULL, then libvirt will try to find the best method. Uri may specify the hostname or IP address of the destination host as seen from the source. Or uri may be a URI giving transport, hostname, user, port, etc. in the usual form. Refer to driver documentation for the particular URIs supported. The maximum bandwidth (in Mbps) that will be used to do migration can be specified with the bandwidth parameter. If set to 0, libvirt will choose a suitable default. Some hypervisors do not support this feature and will return an error if bandwidth is not 0. To see which features are supported by the current hypervisor, see virConnectGetCapabilities, /capabilities/host/migration_features. There are many limitations on migration imposed by the underlying technology - for example it may not be possible to migrate between different processors even with the same architecture, or between different types of hypervisor.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>dconn</tt></i>:</span></td><td>destination host (a connection object)</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags</td></tr><tr><td><span class="term"><i><tt>dname</tt></i>:</span></td><td>(optional) rename domain to this at destination</td></tr><tr><td><span class="term"><i><tt>uri</tt></i>:</span></td><td>(optional) dest hostname/URI as seen from the source host</td></tr><tr><td><span class="term"><i><tt>bandwidth</tt></i>:</span></td><td>(optional) specify migration bandwidth limit in Mbps</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the new domain object if the migration was successful, or NULL in case of error. Note that the new domain object exists in the scope of the destination connection (dconn).</td></tr></tbody></table></div><h3><a name="virDomainPinVcpu" id="virDomainPinVcpu"><code>virDomainPinVcpu</code></a></h3><pre class="programlisting">int virDomainPinVcpu (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int vcpu, <br /> unsigned char * cpumap, <br /> int maplen)<br />
+</pre><p>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>vcpu</tt></i>:</span></td><td>virtual CPU number</td></tr><tr><td><span class="term"><i><tt>cpumap</tt></i>:</span></td><td>pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.</td></tr><tr><td><span class="term"><i><tt>maplen</tt></i>:</span></td><td>number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen < size, missing bytes are set to zero. If maplen > size, failure code is returned.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainReboot" id="virDomainReboot"><code>virDomainReboot</code></a></h3><pre class="programlisting">int virDomainReboot (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int flags)<br />
+</pre><p>Reboot a domain, the domain object is still usable there after but the domain OS is being stopped for a restart. Note that the guest OS may ignore the request.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>extra flags for the reboot operation, not used yet</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainRestore" id="virDomainRestore"><code>virDomainRestore</code></a></h3><pre class="programlisting">int virDomainRestore (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * from)<br />
+</pre><p>This method will restore a domain saved to disk by virDomainSave().</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>from</tt></i>:</span></td><td>path to the</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainResume" id="virDomainResume"><code>virDomainResume</code></a></h3><pre class="programlisting">int virDomainResume (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires privileged access</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSave" id="virDomainSave"><code>virDomainSave</code></a></h3><pre class="programlisting">int virDomainSave (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * to)<br />
+</pre><p>This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this may be a problem). Use virDomainRestore() to restore a domain after saving.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>to</tt></i>:</span></td><td>path for the output file</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSetAutostart" id="virDomainSetAutostart"><code>virDomainSetAutostart</code></a></h3><pre class="programlisting">int virDomainSetAutostart (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int autostart)<br />
+</pre><p>Configure the domain to be automatically started when the host machine boots.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>whether the domain should be automatically started 0 or 1</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainSetMaxMemory" id="virDomainSetMaxMemory"><code>virDomainSetMaxMemory</code></a></h3><pre class="programlisting">int virDomainSetMaxMemory (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned long memory)<br />
+</pre><p>Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function requires privileged access to the hypervisor.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object or NULL</td></tr><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>the memory size in kilobytes</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSetMemory" id="virDomainSetMemory"><code>virDomainSetMemory</code></a></h3><pre class="programlisting">int virDomainSetMemory (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned long memory)<br />
+</pre><p>Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may requires privileged access to the hypervisor.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object or NULL</td></tr><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>the memory size in kilobytes</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSetSchedulerParameters" id="virDomainSetSchedulerParameters"><code>virDomainSetSchedulerParameters</code></a></h3><pre class="programlisting">int virDomainSetSchedulerParameters (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br /> int nparams)<br />
+</pre><p>Change the scheduler parameters</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>params</tt></i>:</span></td><td>pointer to scheduler parameter objects</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>number of scheduler parameter (this value should be same or less than the returned value nparams of virDomainGetSchedulerType)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success.</td></tr></tbody></table></div><h3><a name="virDomainSetVcpus" id="virDomainSetVcpus"><code>virDomainSetVcpus</code></a></h3><pre class="programlisting">int virDomainSetVcpus (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> unsigned int nvcpus)<br />
+</pre><p>Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires privileged access to the hypervisor.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>nvcpus</tt></i>:</span></td><td>the new number of virtual CPUs for this domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainShutdown" id="virDomainShutdown"><code>virDomainShutdown</code></a></h3><pre class="programlisting">int virDomainShutdown (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request. TODO: should we add an option for reboot, knowing it may not be doable in the general case ?</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSuspend" id="virDomainSuspend"><code>virDomainSuspend</code></a></h3><pre class="programlisting">int virDomainSuspend (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires privileged access.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainUndefine" id="virDomainUndefine"><code>virDomainUndefine</code></a></h3><pre class="programlisting">int virDomainUndefine (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>undefine a domain but does not stop it if it is running</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virGetVersion" id="virGetVersion"><code>virGetVersion</code></a></h3><pre class="programlisting">int virGetVersion (unsigned long * libVer, <br /> const char * type, <br /> unsigned long * typeVer)<br />
+</pre><p>Provides two information back, @libVer is the version of the library while @typeVer will be the version of the hypervisor type @type against which the library was compiled. If @type is NULL, "Xen" is assumed, if @type is unknown or not available, an error code will be returned and @typeVer will be 0.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>libVer</tt></i>:</span></td><td>return value for the library version (OUT)</td></tr><tr><td><span class="term"><i><tt>type</tt></i>:</span></td><td>the type of connection/driver looked at</td></tr><tr><td><span class="term"><i><tt>typeVer</tt></i>:</span></td><td>return value for the version of the hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.</td></tr></tbody></table></div><h3><a name="virInitialize" id="virInitialize"><code>virInitialize</code></a></h3><pre class="programlisting">int virInitialize (void)<br />
+</pre><p>Initialize the library. It's better to call this routine at startup in multithreaded applications to avoid potential race when initializing the library.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virNetworkCreate" id="virNetworkCreate"><code>virNetworkCreate</code></a></h3><pre class="programlisting">int virNetworkCreate (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>pointer to a defined network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virNetworkCreateXML" id="virNetworkCreateXML"><code>virNetworkCreateXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkCreateXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc)<br />
+</pre><p>Create and start a new virtual network, based on an XML description similar to the one returned by virNetworkGetXMLDesc()</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>an XML description of the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure</td></tr></tbody></table></div><h3><a name="virNetworkDefineXML" id="virNetworkDefineXML"><code>virNetworkDefineXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkDefineXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml)<br />
+</pre><p>Define a network, but does not create it</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>the XML description for the network, preferably in UTF-8</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a pointer to the network otherwise</td></tr></tbody></table></div><h3><a name="virNetworkDestroy" id="virNetworkDestroy"><code>virNetworkDestroy</code></a></h3><pre class="programlisting">int virNetworkDestroy (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Destroy the network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires privileged access</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virNetworkFree" id="virNetworkFree"><code>virNetworkFree</code></a></h3><pre class="programlisting">int virNetworkFree (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Free the network object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virNetworkGetAutostart" id="virNetworkGetAutostart"><code>virNetworkGetAutostart</code></a></h3><pre class="programlisting">int virNetworkGetAutostart (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int * autostart)<br />
+</pre><p>Provides a boolean value indicating whether the network configured to be automatically started when the host machine boots.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetBridgeName" id="virNetworkGetBridgeName"><code>virNetworkGetBridgeName</code></a></h3><pre class="programlisting">char * virNetworkGetBridgeName (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Provides a bridge interface name to which a domain may connect a network interface in order to join the network.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div><h3><a name="virNetworkGetConnect" id="virNetworkGetConnect"><code>virNetworkGetConnect</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virNetworkGetConnect (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net)<br />
+</pre><p>Provides the connection pointer associated with a network. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the network object together.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>net</tt></i>:</span></td><td>pointer to a network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virNetworkGetName" id="virNetworkGetName"><code>virNetworkGetName</code></a></h3><pre class="programlisting">const char * virNetworkGetName (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Get the public name for that network</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the network object.</td></tr></tbody></table></div><h3><a name="virNetworkGetUUID" id="virNetworkGetUUID"><code>virNetworkGetUUID</code></a></h3><pre class="programlisting">int virNetworkGetUUID (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> unsigned char * uuid)<br />
+</pre><p>Get the UUID for a network</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetUUIDString" id="virNetworkGetUUIDString"><code>virNetworkGetUUIDString</code></a></h3><pre class="programlisting">int virNetworkGetUUIDString (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> char * buf)<br />
+</pre><p>Get the UUID for a network as string. For more information about UUID see RFC4122.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>buf</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetXMLDesc" id="virNetworkGetXMLDesc"><code>virNetworkGetXMLDesc</code></a></h3><pre class="programlisting">char * virNetworkGetXMLDesc (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int flags)<br />
+</pre><p>Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>and OR'ed set of extraction flags, not used yet</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div><h3><a name="virNetworkLookupByName" id="virNetworkLookupByName"><code>virNetworkLookupByName</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkLookupByName (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)<br />
+</pre><p>Try to lookup a network on the given hypervisor based on its name.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name for the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkLookupByUUID" id="virNetworkLookupByUUID"><code>virNetworkLookupByUUID</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkLookupByUUID (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)<br />
+</pre><p>Try to lookup a network on the given hypervisor based on its UUID.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>the raw UUID for the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkLookupByUUIDString" id="virNetworkLookupByUUIDString"><code>virNetworkLookupByUUIDString</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkLookupByUUIDString (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)<br />
+</pre><p>Try to lookup a network on the given hypervisor based on its UUID.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuidstr</tt></i>:</span></td><td>the string UUID for the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkSetAutostart" id="virNetworkSetAutostart"><code>virNetworkSetAutostart</code></a></h3><pre class="programlisting">int virNetworkSetAutostart (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br /> int autostart)<br />
+</pre><p>Configure the network to be automatically started when the host machine boots.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>whether the network should be automatically started 0 or 1</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkUndefine" id="virNetworkUndefine"><code>virNetworkUndefine</code></a></h3><pre class="programlisting">int virNetworkUndefine (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Undefine a network but does not stop it if it is running</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>pointer to a defined network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virNodeGetCellsFreeMemory" id="virNodeGetCellsFreeMemory"><code>virNodeGetCellsFreeMemory</code></a></h3><pre class="programlisting">int virNodeGetCellsFreeMemory (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> unsigned long long * freeMems, <br /> int startCell, <br /> int maxCells)<br />
+</pre><p>This call returns the amount of free memory in one or more NUMA cells. The @freeMems array must be allocated by the caller and will be filled with the amount of free memory in kilobytes for each cell requested, starting with startCell (in freeMems[0]), up to either (startCell + maxCells), or the number of additional cells in the node, whichever is smaller.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>freeMems</tt></i>:</span></td><td>pointer to the array of unsigned long long</td></tr><tr><td><span class="term"><i><tt>startCell</tt></i>:</span></td><td>index of first cell to return freeMems info on.</td></tr><tr><td><span class="term"><i><tt>maxCells</tt></i>:</span></td><td>Maximum number of cells for which freeMems information can be returned.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of entries filled in freeMems, or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virNodeGetFreeMemory" id="virNodeGetFreeMemory"><code>virNodeGetFreeMemory</code></a></h3><pre class="programlisting">unsigned long long virNodeGetFreeMemory (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>provides the free memory available on the Node</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the available free memory in kilobytes or 0 in case of error</td></tr></tbody></table></div><h3><a name="virNodeGetInfo" id="virNodeGetInfo"><code>virNodeGetInfo</code></a></h3><pre class="programlisting">int virNodeGetInfo (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> <a href="libvirt-libvirt.html#virNodeInfoPtr">virNodeInfoPtr</a> info)<br />
+</pre><p>Extract hardware information about the node.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#virNodeInfo">virNodeInfo</a> structure allocated by the user</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virStoragePoolBuild" id="virStoragePoolBuild"><code>virStoragePoolBuild</code></a></h3><pre class="programlisting">int virStoragePoolBuild (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)<br />
+</pre><p>Build the underlying storage pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 upon failure</td></tr></tbody></table></div><h3><a name="virStoragePoolCreate" id="virStoragePoolCreate"><code>virStoragePoolCreate</code></a></h3><pre class="programlisting">int virStoragePoolCreate (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)<br />
+</pre><p>Starts an inactive storage pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be started</td></tr></tbody></table></div><h3><a name="virStoragePoolCreateXML" id="virStoragePoolCreateXML"><code>virStoragePoolCreateXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolCreateXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc, <br /> unsigned int flags)<br />
+</pre><p>Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStoragePoolDefineXML" id="virStoragePoolDefineXML"><code>virStoragePoolDefineXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolDefineXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml, <br /> unsigned int flags)<br />
+</pre><p>Define a new inactive storage pool based on its XML description. The pool is persistent, until explicitly undefined.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStoragePoolDelete" id="virStoragePoolDelete"><code>virStoragePoolDelete</code></a></h3><pre class="programlisting">int virStoragePoolDelete (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)<br />
+</pre><p>Delete the underlying pool resources. This is a non-recoverable operation. The <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object itself is not free'd.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for obliteration process</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be obliterate</td></tr></tbody></table></div><h3><a name="virStoragePoolDestroy" id="virStoragePoolDestroy"><code>virStoragePoolDestroy</code></a></h3><pre class="programlisting">int virStoragePoolDestroy (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Destroy an active storage pool. This will deactivate the pool on the host, but keep any persistent config associated with it. If it has a persistent config it can later be restarted with virStoragePoolCreate(). This does not free the associated <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be destroyed</td></tr></tbody></table></div><h3><a name="virStoragePoolFree" id="virStoragePoolFree"><code>virStoragePoolFree</code></a></h3><pre class="programlisting">int virStoragePoolFree (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Free a storage pool object, releasing all memory associated with it. Does not change the state of the pool on the host.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be free'd.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetAutostart" id="virStoragePoolGetAutostart"><code>virStoragePoolGetAutostart</code></a></h3><pre class="programlisting">int virStoragePoolGetAutostart (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> int * autostart)<br />
+</pre><p>Fetches the value of the autostart flag, which determines whether the pool is automatically started at boot time</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>location in which to store autostart flag</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolGetConnect" id="virStoragePoolGetConnect"><code>virStoragePoolGetConnect</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virStoragePoolGetConnect (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Provides the connection pointer associated with a storage pool. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the pool object together.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to a pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetInfo" id="virStoragePoolGetInfo"><code>virStoragePoolGetInfo</code></a></h3><pre class="programlisting">int virStoragePoolGetInfo (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> <a href="libvirt-libvirt.html#virStoragePoolInfoPtr">virStoragePoolInfoPtr</a> info)<br />
+</pre><p>Get volatile information about the storage pool such as free space / usage summary</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer at which to store info</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on failure.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetName" id="virStoragePoolGetName"><code>virStoragePoolGetName</code></a></h3><pre class="programlisting">const char * virStoragePoolGetName (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Fetch the locally unique name of the storage pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the name of the pool, or NULL on error</td></tr></tbody></table></div><h3><a name="virStoragePoolGetUUID" id="virStoragePoolGetUUID"><code>virStoragePoolGetUUID</code></a></h3><pre class="programlisting">int virStoragePoolGetUUID (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned char * uuid)<br />
+</pre><p>Fetch the globally unique ID of the storage pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>buffer of <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes in size</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error;</td></tr></tbody></table></div><h3><a name="virStoragePoolGetUUIDString" id="virStoragePoolGetUUIDString"><code>virStoragePoolGetUUIDString</code></a></h3><pre class="programlisting">int virStoragePoolGetUUIDString (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> char * buf)<br />
+</pre><p>Fetch the globally unique ID of the storage pool as a string</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>buf</tt></i>:</span></td><td>buffer of <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes in size</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error;</td></tr></tbody></table></div><h3><a name="virStoragePoolGetXMLDesc" id="virStoragePoolGetXMLDesc"><code>virStoragePoolGetXMLDesc</code></a></h3><pre class="programlisting">char * virStoragePoolGetXMLDesc (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)<br />
+</pre><p>Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the <a href="libvirt-libvirt.html#virStoragePoolCreateXML">virStoragePoolCreateXML</a> method.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML format options (set of virDomainXMLFlags)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a XML document, or NULL on error</td></tr></tbody></table></div><h3><a name="virStoragePoolListVolumes" id="virStoragePoolListVolumes"><code>virStoragePoolListVolumes</code></a></h3><pre class="programlisting">int virStoragePoolListVolumes (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> char ** const names, <br /> int maxnames)<br />
+</pre><p>Fetch list of storage volume names, limiting to at most maxnames.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array in which to storage volume names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names fetched, or -1 on error</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByName" id="virStoragePoolLookupByName"><code>virStoragePoolLookupByName</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolLookupByName (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * name)<br />
+</pre><p>Fetch a storage pool based on its unique name</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByUUID" id="virStoragePoolLookupByUUID"><code>virStoragePoolLookupByUUID</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolLookupByUUID (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const unsigned char * uuid)<br />
+</pre><p>Fetch a storage pool based on its globally unique id</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>globally unique id of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByUUIDString" id="virStoragePoolLookupByUUIDString"><code>virStoragePoolLookupByUUIDString</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolLookupByUUIDString (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * uuidstr)<br />
+</pre><p>Fetch a storage pool based on its globally unique id</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuidstr</tt></i>:</span></td><td>globally unique id of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByVolume" id="virStoragePoolLookupByVolume"><code>virStoragePoolLookupByVolume</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolLookupByVolume (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Fetch a storage pool which contains a particular volume</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolNumOfVolumes" id="virStoragePoolNumOfVolumes"><code>virStoragePoolNumOfVolumes</code></a></h3><pre class="programlisting">int virStoragePoolNumOfVolumes (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Fetch the number of storage volumes within a pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of storage pools, or -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolRefresh" id="virStoragePoolRefresh"><code>virStoragePoolRefresh</code></a></h3><pre class="programlisting">int virStoragePoolRefresh (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> unsigned int flags)<br />
+</pre><p>Request that the pool refresh its list of volumes. This may involve communicating with a remote server, and/or initializing new devices at the OS layer</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags to control refresh behaviour (currently unused, use 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if the volume list was refreshed, -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolSetAutostart" id="virStoragePoolSetAutostart"><code>virStoragePoolSetAutostart</code></a></h3><pre class="programlisting">int virStoragePoolSetAutostart (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> int autostart)<br />
+</pre><p>Sets the autostart flag</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>new flag setting</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolUndefine" id="virStoragePoolUndefine"><code>virStoragePoolUndefine</code></a></h3><pre class="programlisting">int virStoragePoolUndefine (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Undefine an inactive storage pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStorageVolCreateXML" id="virStorageVolCreateXML"><code>virStorageVolCreateXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> virStorageVolCreateXML (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> const char * xmldesc, <br /> unsigned int flags)<br />
+</pre><p>Create a storage volume within a pool based on an XML description. Not all pools support creation of volumes</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>xmldesc</tt></i>:</span></td><td>description of volume to create</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for creation (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the storage volume, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolDelete" id="virStorageVolDelete"><code>virStorageVolDelete</code></a></h3><pre class="programlisting">int virStorageVolDelete (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> unsigned int flags)<br />
+</pre><p>Delete the storage volume from the pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><a name="virStorageVolFree" id="virStorageVolFree"><code>virStorageVolFree</code></a></h3><pre class="programlisting">int virStorageVolFree (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Release the storage volume handle. The underlying storage volume contains to exist</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetConnect" id="virStorageVolGetConnect"><code>virStorageVolGetConnect</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virStorageVolGetConnect (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Provides the connection pointer associated with a storage volume. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the volume object together.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to a pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virStorageVolGetInfo" id="virStorageVolGetInfo"><code>virStorageVolGetInfo</code></a></h3><pre class="programlisting">int virStorageVolGetInfo (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> <a href="libvirt-libvirt.html#virStorageVolInfoPtr">virStorageVolInfoPtr</a> info)<br />
+</pre><p>Fetches volatile information about the storage volume such as its current allocation</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer at which to store info</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on failure</td></tr></tbody></table></div><h3><a name="virStorageVolGetKey" id="virStorageVolGetKey"><code>virStorageVolGetKey</code></a></h3><pre class="programlisting">const char * virStorageVolGetKey (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Fetch the storage volume key. This is globally unique, so the same volume will have the same key no matter what host it is accessed from</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the volume key, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetName" id="virStorageVolGetName"><code>virStorageVolGetName</code></a></h3><pre class="programlisting">const char * virStorageVolGetName (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Fetch the storage volume name. This is unique within the scope of a pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the volume name, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetPath" id="virStorageVolGetPath"><code>virStorageVolGetPath</code></a></h3><pre class="programlisting">char * virStorageVolGetPath (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Fetch the storage volume path. Depending on the pool configuration this is either persistent across hosts, or dynamically assigned at pool startup. Consult pool documentation for information on getting the persistent naming</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the storage volume path, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetXMLDesc" id="virStorageVolGetXMLDesc"><code>virStorageVolGetXMLDesc</code></a></h3><pre class="programlisting">char * virStorageVolGetXMLDesc (<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br /> unsigned int flags)<br />
+</pre><p>Fetch an XML document describing all aspects of the storage volume</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML generation (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the XML document, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolLookupByKey" id="virStorageVolLookupByKey"><code>virStorageVolLookupByKey</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> virStorageVolLookupByKey (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * key)<br />
+</pre><p>Fetch a pointer to a storage volume based on its globally unique key</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>key</tt></i>:</span></td><td>globally unique key</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div><h3><a name="virStorageVolLookupByName" id="virStorageVolLookupByName"><code>virStorageVolLookupByName</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> virStorageVolLookupByName (<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br /> const char * name)<br />
+</pre><p>Fetch a pointer to a storage volume based on its name within a pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name of storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div><h3><a name="virStorageVolLookupByPath" id="virStorageVolLookupByPath"><code>virStorageVolLookupByPath</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> virStorageVolLookupByPath (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * path)<br />
+</pre><p>Fetch a pointer to a storage volume based on its locally (host) unique path</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>path</tt></i>:</span></td><td>locally unique path</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div></div><div id="menu"><ul class="l0"><li><a title="Front page of the libvirt website" class="inactive" href="../index.html">Home</a></li><li><a title="Details of new features and bugs fixed in each release" class="inactive" href="../news.html">News</a></li><li><a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="../downloads.html">Downloads</a></li><li><a title="Information for users, administrators and developers" class="active" href="../docs.html">Documentation</a><ul class="l1"><li><a title="Information about deploying and using libvirt" class="inactive" href="../deployment.html">Deployment</a></li><li><a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="../intro.html">Architecture</a></li><li><a title="Description of the XML formats used in libvirt" class="inactive" href="../format.html">XML format</a></li><li><a title="Hypervisor specific driver information" class="inactive" href="../drivers.html">Drivers</a></li><li><a title="Reference manual for the C public API" class="active" href="../html/index.html">API reference</a><ul class="l2"><li><span class="active">libvirt</span></li><li><a title="error handling interfaces for the libvirt library" class="inactive" href="../html/libvirt-virterror.html">virterror</a></li><li><a title="matrix of API support per hypervisor per release" class="inactive" href="../hvsupport.html">Driver support</a></li></ul></li><li><a title="Bindings of the libvirt API for other languages" class="inactive" href="../bindings.html">Language bindings</a></li></ul></li><li><a title="User contributed content" class="inactive" href="../http://wiki.libvirt.org">Wiki</a></li><li><a title="Frequently asked questions" class="inactive" href="../FAQ.html">FAQ</a></li><li><a title="How and where to report bugs and request features" class="inactive" href="../bugs.html">Bug reports</a></li><li><a title="How to contact the developers via email and IRC" class="inactive" href="../contact.html">Contact</a></li><li><a title="Miscellaneous links of interest related to libvirt" class="inactive" href="../relatedlinks.html">Related Links</a></li><li><a title="Overview of all content on the website" class="inactive" href="../sitemap.html">Sitemap</a></li></ul></div></div><div id="footer"><div id="projects"><dl id="p1"><dt><a href="http://augeas.net/">Augeas</a></dt><dd><span>A configuration editing tool and API</span></dd><dt><a href="http://libvirt.org/">libvirt</a></dt><dd><span>The open source virtualization API</span></dd></dl><dl id="p2"><dt><a href="http://cobbler.et.redhat.com/">Cobbler</a></dt><dd><span>OS provisioning and profile management</span></dd><dt><a href="http://ovirt.org/">oVirt</a></dt><dd><span>Virtualization management across the data center</span></dd></dl><dl id="p3"><dt><a href="http://freeipa.org/">FreeIPA</a></dt><dd><span>Identity, policy and audit management</span></dd><dt><a href="http://virt-manager.org/">Virtual Machine Manager</a></dt><dd><span>Virtualization management from the desktop</span></dd></dl></div></div></body></html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Module virterror from libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Module virterror from libvirt</h1><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libvirt-libvirt.html"><img src="left.png" width="24" height="24" border="0" alt="Prev" /></a></td><th align="left"><a href="libvirt-libvirt.html">libvirt</a></th><td><a accesskey="u" href="index.html"><img src="up.png" width="24" height="24" border="0" alt="Up" /></a></td><th align="left"><a href="index.html">API documentation</a></th><td><a accesskey="h" href="../index.html"><img src="home.png" width="24" height="24" border="0" alt="Home" /></a></td><th align="center"><a href="../index.html">The virtualization API</a></th></tr></table><p>Provides the interfaces of the libvirt library to handle errors raised while using the library. </p><h2>Table of Contents</h2><pre class="programlisting">Structure <a href="#virError">virError</a><br />struct _virError
-</pre><pre class="programlisting">Enum <a href="#virErrorDomain">virErrorDomain</a>
-</pre><pre class="programlisting">Enum <a href="#virErrorLevel">virErrorLevel</a>
-</pre><pre class="programlisting">Enum <a href="#virErrorNumber">virErrorNumber</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-virterror.html#virError">virError</a> * <a name="virErrorPtr" id="virErrorPtr">virErrorPtr</a>
-</pre><pre class="programlisting">int <a href="#virConnCopyLastError">virConnCopyLastError</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> <a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> to)</pre>
-<pre class="programlisting"><a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> <a href="#virConnGetLastError">virConnGetLastError</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">void <a href="#virConnResetLastError">virConnResetLastError</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">void <a href="#virConnSetErrorFunc">virConnSetErrorFunc</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> void * userData, <br /> <a href="libvirt-virterror.html#virErrorFunc">virErrorFunc</a> handler)</pre>
-<pre class="programlisting">int <a href="#virCopyLastError">virCopyLastError</a> (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> to)</pre>
-<pre class="programlisting">void <a href="#virDefaultErrorFunc">virDefaultErrorFunc</a> (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> err)</pre>
-<pre class="programlisting">Function type: <a href="#virErrorFunc">virErrorFunc</a>
+<html xmlns="http://www.w3.org/1999/xhtml"><!--
+ This file is autogenerated from html/libvirt-virterror.html.in
+ Do not edit this file. Changes will be lost.
+ --><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../main.css" /><link rel="SHORTCUT ICON" href="../32favicon.png" /><title>libvirt: Module virterror from libvirt</title><meta name="description" content="libvirt, virtualization, virtualization API" /></head><body><div id="header"><div id="headerLogo"></div><div id="headerSearch"><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input id="query" name="query" type="text" size="12" value="" /><input id="submit" name="submit" type="submit" value="Search" /></form></div></div><div id="body"><div id="content"><h1>Module virterror from libvirt</h1><p>Provides the interfaces of the libvirt library to handle errors raised while using the library. </p><h2>Table of Contents</h2><h3><a href="#types">Types</a></h3><pre>typedef struct _virError <a href="#virError">virError</a>
+typedef enum <a href="#virErrorDomain">virErrorDomain</a>
+typedef enum <a href="#virErrorLevel">virErrorLevel</a>
+typedef enum <a href="#virErrorNumber">virErrorNumber</a>
+typedef <a href="libvirt-virterror.html#virError">virError</a> * <a name="virErrorPtr" id="virErrorPtr">virErrorPtr</a>
+</pre><h3><a href="#functions">Functions</a></h3><pre>int <a href="#virConnCopyLastError">virConnCopyLastError</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> <a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> to)
+<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> <a href="#virConnGetLastError">virConnGetLastError</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+void <a href="#virConnResetLastError">virConnResetLastError</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+void <a href="#virConnSetErrorFunc">virConnSetErrorFunc</a> (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> void * userData, <br /> <a href="libvirt-virterror.html#virErrorFunc">virErrorFunc</a> handler)
+int <a href="#virCopyLastError">virCopyLastError</a> (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> to)
+void <a href="#virDefaultErrorFunc">virDefaultErrorFunc</a> (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> err)
+typedef <a href="#virErrorFunc">virErrorFunc</a>
void <a href="#virErrorFunc">virErrorFunc</a> (void * userData, <br /> <a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> error)
-</pre>
-<pre class="programlisting"><a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> <a href="#virGetLastError">virGetLastError</a> (void)</pre>
-<pre class="programlisting">void <a href="#virResetError">virResetError</a> (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> err)</pre>
-<pre class="programlisting">void <a href="#virResetLastError">virResetLastError</a> (void)</pre>
-<pre class="programlisting">void <a href="#virSetErrorFunc">virSetErrorFunc</a> (void * userData, <br /> <a href="libvirt-virterror.html#virErrorFunc">virErrorFunc</a> handler)</pre>
-<h2>Description</h2>
-<h3><a name="virError" id="virError">Structure virError</a></h3><pre class="programlisting">Structure virError<br />struct _virError {
- int code : The error code, a <a href="libvirt-virterror.html#virErrorNumber">virErrorNumber</a>
- int domain : What part of the library raised this er
- char * message : human-readable informative error messag
- <a href="libvirt-virterror.html#virErrorLevel">virErrorLevel</a> level : how consequent is the error
- <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn : the connection if available
- <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom : the domain if available
- char * str1 : extra string information
- char * str2 : extra string information
- char * str3 : extra string information
- int int1 : extra number information
- int int2 : extra number information
- <a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net : the network if available
-}</pre><h3>Enum <a name="virErrorDomain" id="virErrorDomain">virErrorDomain</a></h3><pre class="programlisting">Enum virErrorDomain {
- <a name="VIR_FROM_NONE" id="VIR_FROM_NONE">VIR_FROM_NONE</a> = 0
- <a name="VIR_FROM_XEN" id="VIR_FROM_XEN">VIR_FROM_XEN</a> = 1 : Error at Xen hypervisor layer
- <a name="VIR_FROM_XEND" id="VIR_FROM_XEND">VIR_FROM_XEND</a> = 2 : Error at connection with xend daemon
- <a name="VIR_FROM_XENSTORE" id="VIR_FROM_XENSTORE">VIR_FROM_XENSTORE</a> = 3 : Error at connection with xen store
- <a name="VIR_FROM_SEXPR" id="VIR_FROM_SEXPR">VIR_FROM_SEXPR</a> = 4 : Error in the S-Expression code
- <a name="VIR_FROM_XML" id="VIR_FROM_XML">VIR_FROM_XML</a> = 5 : Error in the XML code
- <a name="VIR_FROM_DOM" id="VIR_FROM_DOM">VIR_FROM_DOM</a> = 6 : Error when operating on a domain
- <a name="VIR_FROM_RPC" id="VIR_FROM_RPC">VIR_FROM_RPC</a> = 7 : Error in the XML-RPC code
- <a name="VIR_FROM_PROXY" id="VIR_FROM_PROXY">VIR_FROM_PROXY</a> = 8 : Error in the proxy code
- <a name="VIR_FROM_CONF" id="VIR_FROM_CONF">VIR_FROM_CONF</a> = 9 : Error in the configuration file handling
- <a name="VIR_FROM_QEMU" id="VIR_FROM_QEMU">VIR_FROM_QEMU</a> = 10 : Error at the QEMU daemon
- <a name="VIR_FROM_NET" id="VIR_FROM_NET">VIR_FROM_NET</a> = 11 : Error when operating on a network
- <a name="VIR_FROM_TEST" id="VIR_FROM_TEST">VIR_FROM_TEST</a> = 12 : Error from test driver
- <a name="VIR_FROM_REMOTE" id="VIR_FROM_REMOTE">VIR_FROM_REMOTE</a> = 13 : Error from remote driver
- <a name="VIR_FROM_OPENVZ" id="VIR_FROM_OPENVZ">VIR_FROM_OPENVZ</a> = 14 : Error from OpenVZ driver
- <a name="VIR_FROM_XENXM" id="VIR_FROM_XENXM">VIR_FROM_XENXM</a> = 15 : Error at Xen XM layer
- <a name="VIR_FROM_STATS_LINUX" id="VIR_FROM_STATS_LINUX">VIR_FROM_STATS_LINUX</a> = 16 : Error in the Linux Stats code
- <a name="VIR_FROM_LXC" id="VIR_FROM_LXC">VIR_FROM_LXC</a> = 17 : Error from Linux Container driver
- <a name="VIR_FROM_STORAGE" id="VIR_FROM_STORAGE">VIR_FROM_STORAGE</a> = 18 : Error from storage driver
+
+<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> <a href="#virGetLastError">virGetLastError</a> (void)
+void <a href="#virResetError">virResetError</a> (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> err)
+void <a href="#virResetLastError">virResetLastError</a> (void)
+void <a href="#virSetErrorFunc">virSetErrorFunc</a> (void * userData, <br /> <a href="libvirt-virterror.html#virErrorFunc">virErrorFunc</a> handler)
+</pre><h2>Description</h2><h3><a name="types" id="types">Types</a></h3><h3><a name="virError" id="virError"><code>virError</code></a></h3><div class="api"><pre>struct virError{
+</pre><table><tr><td>int</td><td>code</td><td> : The error code, a <a href="libvirt-virterror.html#virErrorNumber">virErrorNumber</a></td></tr><tr><td>int</td><td>domain</td><td> : What part of the library raised this error</td></tr><tr><td>char *</td><td>message</td><td> : human-readable informative error message</td></tr><tr><td><a href="libvirt-virterror.html#virErrorLevel">virErrorLevel</a></td><td>level</td><td> : how consequent is the error</td></tr><tr><td><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a></td><td>conn</td><td> : connection if available, see note above</td></tr><tr><td><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a></td><td>dom</td><td> : domain if available, see note above</td></tr><tr><td>char *</td><td>str1</td><td> : extra string information</td></tr><tr><td>char *</td><td>str2</td><td> : extra string information</td></tr><tr><td>char *</td><td>str3</td><td> : extra string information</td></tr><tr><td>int</td><td>int1</td><td> : extra number information</td></tr><tr><td>int</td><td>int2</td><td> : extra number information</td></tr><tr><td><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a></td><td>net</td><td> : network if available, see note above</td></tr></table><pre>
}
-</pre><h3>Enum <a name="virErrorLevel" id="virErrorLevel">virErrorLevel</a></h3><pre class="programlisting">Enum virErrorLevel {
- <a name="VIR_ERR_NONE" id="VIR_ERR_NONE">VIR_ERR_NONE</a> = 0
- <a name="VIR_ERR_WARNING" id="VIR_ERR_WARNING">VIR_ERR_WARNING</a> = 1 : A simple warning
- <a name="VIR_ERR_ERROR" id="VIR_ERR_ERROR">VIR_ERR_ERROR</a> = 2 : An error
-}
-</pre><h3>Enum <a name="virErrorNumber" id="virErrorNumber">virErrorNumber</a></h3><pre class="programlisting">Enum virErrorNumber {
- <a name="VIR_ERR_OK" id="VIR_ERR_OK">VIR_ERR_OK</a> = 0
- <a name="VIR_ERR_INTERNAL_ERROR" id="VIR_ERR_INTERNAL_ERROR">VIR_ERR_INTERNAL_ERROR</a> = 1 : internal error
- <a name="VIR_ERR_NO_MEMORY" id="VIR_ERR_NO_MEMORY">VIR_ERR_NO_MEMORY</a> = 2 : memory allocation failure
- <a name="VIR_ERR_NO_SUPPORT" id="VIR_ERR_NO_SUPPORT">VIR_ERR_NO_SUPPORT</a> = 3 : no support for this function
- <a name="VIR_ERR_UNKNOWN_HOST" id="VIR_ERR_UNKNOWN_HOST">VIR_ERR_UNKNOWN_HOST</a> = 4 : could not resolve hostname
- <a name="VIR_ERR_NO_CONNECT" id="VIR_ERR_NO_CONNECT">VIR_ERR_NO_CONNECT</a> = 5 : can't connect to hypervisor
- <a name="VIR_ERR_INVALID_CONN" id="VIR_ERR_INVALID_CONN">VIR_ERR_INVALID_CONN</a> = 6 : invalid connection object
- <a name="VIR_ERR_INVALID_DOMAIN" id="VIR_ERR_INVALID_DOMAIN">VIR_ERR_INVALID_DOMAIN</a> = 7 : invalid domain object
- <a name="VIR_ERR_INVALID_ARG" id="VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> = 8 : invalid function argument
- <a name="VIR_ERR_OPERATION_FAILED" id="VIR_ERR_OPERATION_FAILED">VIR_ERR_OPERATION_FAILED</a> = 9 : a command to hypervisor failed
- <a name="VIR_ERR_GET_FAILED" id="VIR_ERR_GET_FAILED">VIR_ERR_GET_FAILED</a> = 10 : a HTTP GET command to failed
- <a name="VIR_ERR_POST_FAILED" id="VIR_ERR_POST_FAILED">VIR_ERR_POST_FAILED</a> = 11 : a HTTP POST command to failed
- <a name="VIR_ERR_HTTP_ERROR" id="VIR_ERR_HTTP_ERROR">VIR_ERR_HTTP_ERROR</a> = 12 : unexpected HTTP error code
- <a name="VIR_ERR_SEXPR_SERIAL" id="VIR_ERR_SEXPR_SERIAL">VIR_ERR_SEXPR_SERIAL</a> = 13 : failure to serialize an S-Expr
- <a name="VIR_ERR_NO_XEN" id="VIR_ERR_NO_XEN">VIR_ERR_NO_XEN</a> = 14 : could not open Xen hypervisor control
- <a name="VIR_ERR_XEN_CALL" id="VIR_ERR_XEN_CALL">VIR_ERR_XEN_CALL</a> = 15 : failure doing an hypervisor call
- <a name="VIR_ERR_OS_TYPE" id="VIR_ERR_OS_TYPE">VIR_ERR_OS_TYPE</a> = 16 : unknown OS type
- <a name="VIR_ERR_NO_KERNEL" id="VIR_ERR_NO_KERNEL">VIR_ERR_NO_KERNEL</a> = 17 : missing kernel information
- <a name="VIR_ERR_NO_ROOT" id="VIR_ERR_NO_ROOT">VIR_ERR_NO_ROOT</a> = 18 : missing root device information
- <a name="VIR_ERR_NO_SOURCE" id="VIR_ERR_NO_SOURCE">VIR_ERR_NO_SOURCE</a> = 19 : missing source device information
- <a name="VIR_ERR_NO_TARGET" id="VIR_ERR_NO_TARGET">VIR_ERR_NO_TARGET</a> = 20 : missing target device information
- <a name="VIR_ERR_NO_NAME" id="VIR_ERR_NO_NAME">VIR_ERR_NO_NAME</a> = 21 : missing domain name information
- <a name="VIR_ERR_NO_OS" id="VIR_ERR_NO_OS">VIR_ERR_NO_OS</a> = 22 : missing domain OS information
- <a name="VIR_ERR_NO_DEVICE" id="VIR_ERR_NO_DEVICE">VIR_ERR_NO_DEVICE</a> = 23 : missing domain devices information
- <a name="VIR_ERR_NO_XENSTORE" id="VIR_ERR_NO_XENSTORE">VIR_ERR_NO_XENSTORE</a> = 24 : could not open Xen Store control
- <a name="VIR_ERR_DRIVER_FULL" id="VIR_ERR_DRIVER_FULL">VIR_ERR_DRIVER_FULL</a> = 25 : too many drivers registered
- <a name="VIR_ERR_CALL_FAILED" id="VIR_ERR_CALL_FAILED">VIR_ERR_CALL_FAILED</a> = 26 : not supported by the drivers (DEPRECATED)
- <a name="VIR_ERR_XML_ERROR" id="VIR_ERR_XML_ERROR">VIR_ERR_XML_ERROR</a> = 27 : an XML description is not well formed or broken
- <a name="VIR_ERR_DOM_EXIST" id="VIR_ERR_DOM_EXIST">VIR_ERR_DOM_EXIST</a> = 28 : the domain already exist
- <a name="VIR_ERR_OPERATION_DENIED" id="VIR_ERR_OPERATION_DENIED">VIR_ERR_OPERATION_DENIED</a> = 29 : operation forbidden on read-only connections
- <a name="VIR_ERR_OPEN_FAILED" id="VIR_ERR_OPEN_FAILED">VIR_ERR_OPEN_FAILED</a> = 30 : failed to open a conf file
- <a name="VIR_ERR_READ_FAILED" id="VIR_ERR_READ_FAILED">VIR_ERR_READ_FAILED</a> = 31 : failed to read a conf file
- <a name="VIR_ERR_PARSE_FAILED" id="VIR_ERR_PARSE_FAILED">VIR_ERR_PARSE_FAILED</a> = 32 : failed to parse a conf file
- <a name="VIR_ERR_CONF_SYNTAX" id="VIR_ERR_CONF_SYNTAX">VIR_ERR_CONF_SYNTAX</a> = 33 : failed to parse the syntax of a conf file
- <a name="VIR_ERR_WRITE_FAILED" id="VIR_ERR_WRITE_FAILED">VIR_ERR_WRITE_FAILED</a> = 34 : failed to write a conf file
- <a name="VIR_ERR_XML_DETAIL" id="VIR_ERR_XML_DETAIL">VIR_ERR_XML_DETAIL</a> = 35 : detail of an XML error
- <a name="VIR_ERR_INVALID_NETWORK" id="VIR_ERR_INVALID_NETWORK">VIR_ERR_INVALID_NETWORK</a> = 36 : invalid network object
- <a name="VIR_ERR_NETWORK_EXIST" id="VIR_ERR_NETWORK_EXIST">VIR_ERR_NETWORK_EXIST</a> = 37 : the network already exist
- <a name="VIR_ERR_SYSTEM_ERROR" id="VIR_ERR_SYSTEM_ERROR">VIR_ERR_SYSTEM_ERROR</a> = 38 : general system call failure
- <a name="VIR_ERR_RPC" id="VIR_ERR_RPC">VIR_ERR_RPC</a> = 39 : some sort of RPC error
- <a name="VIR_ERR_GNUTLS_ERROR" id="VIR_ERR_GNUTLS_ERROR">VIR_ERR_GNUTLS_ERROR</a> = 40 : error from a GNUTLS call
- <a name="VIR_WAR_NO_NETWORK" id="VIR_WAR_NO_NETWORK">VIR_WAR_NO_NETWORK</a> = 41 : failed to start network
- <a name="VIR_ERR_NO_DOMAIN" id="VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> = 42 : domain not found or unexpectedly disappeared
- <a name="VIR_ERR_NO_NETWORK" id="VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> = 43 : network not found
- <a name="VIR_ERR_INVALID_MAC" id="VIR_ERR_INVALID_MAC">VIR_ERR_INVALID_MAC</a> = 44 : invalid MAC address
- <a name="VIR_ERR_AUTH_FAILED" id="VIR_ERR_AUTH_FAILED">VIR_ERR_AUTH_FAILED</a> = 45 : authentication failed
- <a name="VIR_ERR_INVALID_STORAGE_POOL" id="VIR_ERR_INVALID_STORAGE_POOL">VIR_ERR_INVALID_STORAGE_POOL</a> = 46 : invalid storage pool object
- <a name="VIR_ERR_INVALID_STORAGE_VOL" id="VIR_ERR_INVALID_STORAGE_VOL">VIR_ERR_INVALID_STORAGE_VOL</a> = 47 : invalid storage vol object
- <a name="VIR_WAR_NO_STORAGE" id="VIR_WAR_NO_STORAGE">VIR_WAR_NO_STORAGE</a> = 48 : failed to start storage
- <a name="VIR_ERR_NO_STORAGE_POOL" id="VIR_ERR_NO_STORAGE_POOL">VIR_ERR_NO_STORAGE_POOL</a> = 49 : storage pool not found
- <a name="VIR_ERR_NO_STORAGE_VOL" id="VIR_ERR_NO_STORAGE_VOL">VIR_ERR_NO_STORAGE_VOL</a> = 50 : storage pool not found
-}
-</pre><h3><a name="virConnCopyLastError" id="virConnCopyLastError"></a>Function: virConnCopyLastError</h3><pre class="programlisting">int virConnCopyLastError (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> <a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> to)<br />
-</pre><p>Copy the content of the last error caught on that connection One will need to free the result with virResetError()</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>to</tt></i>:</span></td><td>target to receive the copy</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no error was found and the error code otherwise and -1 in case of parameter error.</td></tr></tbody></table></div><h3><a name="virConnGetLastError" id="virConnGetLastError"></a>Function: virConnGetLastError</h3><pre class="programlisting"><a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> virConnGetLastError (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provide a pointer to the last error caught on that connection Simpler but may not be suitable for multithreaded accesses, in which case use virConnCopyLastError()</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the last error or NULL if none occurred.</td></tr></tbody></table></div><h3><a name="virConnResetLastError" id="virConnResetLastError"></a>Function: virConnResetLastError</h3><pre class="programlisting">void virConnResetLastError (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Reset the last error caught on that connection</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr></tbody></table></div><h3><a name="virConnSetErrorFunc" id="virConnSetErrorFunc"></a>Function: virConnSetErrorFunc</h3><pre class="programlisting">void virConnSetErrorFunc (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> void * userData, <br /> <a href="libvirt-virterror.html#virErrorFunc">virErrorFunc</a> handler)<br />
-</pre><p>Set a connection error handling function, if @handler is NULL it will reset to default which is to pass error back to the global library handler.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>userData</tt></i>:</span></td><td>pointer to the user data provided in the handler callback</td></tr><tr><td><span class="term"><i><tt>handler</tt></i>:</span></td><td>the function to get called in case of error or NULL</td></tr></tbody></table></div><h3><a name="virCopyLastError" id="virCopyLastError"></a>Function: virCopyLastError</h3><pre class="programlisting">int virCopyLastError (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> to)<br />
-</pre><p>Copy the content of the last error caught at the library level One will need to free the result with virResetError()</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>to</tt></i>:</span></td><td>target to receive the copy</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no error was found and the error code otherwise and -1 in case of parameter error.</td></tr></tbody></table></div><h3><a name="virDefaultErrorFunc" id="virDefaultErrorFunc"></a>Function: virDefaultErrorFunc</h3><pre class="programlisting">void virDefaultErrorFunc (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> err)<br />
-</pre><p>Default routine reporting an error to stderr.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>err</tt></i>:</span></td><td>pointer to the error.</td></tr></tbody></table></div><h3><a name="virErrorFunc" id="virErrorFunc"></a>Function type: virErrorFunc</h3><pre class="programlisting">Function type: virErrorFunc
-void virErrorFunc (void * userData, <br /> <a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> error)
-</pre><p>Signature of a function to use when there is an error raised by the library.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>userData</tt></i>:</span></td><td>user provided data for the error callback</td></tr><tr><td><span class="term"><i><tt>error</tt></i>:</span></td><td>the error being raised.</td></tr></tbody></table></div><br />
-<h3><a name="virGetLastError" id="virGetLastError"></a>Function: virGetLastError</h3><pre class="programlisting"><a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> virGetLastError (void)<br />
-</pre><p>Provide a pointer to the last error caught at the library level Simpler but may not be suitable for multithreaded accesses, in which case use virCopyLastError()</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the last error or NULL if none occurred.</td></tr></tbody></table></div><h3><a name="virResetError" id="virResetError"></a>Function: virResetError</h3><pre class="programlisting">void virResetError (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> err)<br />
-</pre><p>Reset the error being pointed to</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>err</tt></i>:</span></td><td>pointer to the <a href="libvirt-virterror.html#virError">virError</a> to clean up</td></tr></tbody></table></div><h3><a name="virResetLastError" id="virResetLastError"></a>Function: virResetLastError</h3><pre class="programlisting">void virResetLastError (void)<br />
-</pre><p>Reset the last error caught at the library level.</p>
-<h3><a name="virSetErrorFunc" id="virSetErrorFunc"></a>Function: virSetErrorFunc</h3><pre class="programlisting">void virSetErrorFunc (void * userData, <br /> <a href="libvirt-virterror.html#virErrorFunc">virErrorFunc</a> handler)<br />
-</pre><p>Set a library global error handling function, if @handler is NULL, it will reset to default printing on stderr. The error raised there are those for which no handler at the connection level could caught.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>userData</tt></i>:</span></td><td>pointer to the user data provided in the handler callback</td></tr><tr><td><span class="term"><i><tt>handler</tt></i>:</span></td><td>the function to get called in case of error or NULL</td></tr></tbody></table></div></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a href="../html/index.html">API Menu</a></li><li><a href="../examples/index.html">C code examples</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+</pre></div><h3><a name="virErrorDomain" id="virErrorDomain"><code>virErrorDomain</code></a></h3><div class="api"><pre>enum virErrorDomain {
+</pre><table><tr><td><a name="VIR_FROM_NONE" id="VIR_FROM_NONE">VIR_FROM_NONE</a></td><td> = </td><td>0</td></tr><tr><td><a name="VIR_FROM_XEN" id="VIR_FROM_XEN">VIR_FROM_XEN</a></td><td> = </td><td>1</td><td> : Error at Xen hypervisor layer</td></tr><tr><td><a name="VIR_FROM_XEND" id="VIR_FROM_XEND">VIR_FROM_XEND</a></td><td> = </td><td>2</td><td> : Error at connection with xend daemon</td></tr><tr><td><a name="VIR_FROM_XENSTORE" id="VIR_FROM_XENSTORE">VIR_FROM_XENSTORE</a></td><td> = </td><td>3</td><td> : Error at connection with xen store</td></tr><tr><td><a name="VIR_FROM_SEXPR" id="VIR_FROM_SEXPR">VIR_FROM_SEXPR</a></td><td> = </td><td>4</td><td> : Error in the S-Expression code</td></tr><tr><td><a name="VIR_FROM_XML" id="VIR_FROM_XML">VIR_FROM_XML</a></td><td> = </td><td>5</td><td> : Error in the XML code</td></tr><tr><td><a name="VIR_FROM_DOM" id="VIR_FROM_DOM">VIR_FROM_DOM</a></td><td> = </td><td>6</td><td> : Error when operating on a domain</td></tr><tr><td><a name="VIR_FROM_RPC" id="VIR_FROM_RPC">VIR_FROM_RPC</a></td><td> = </td><td>7</td><td> : Error in the XML-RPC code</td></tr><tr><td><a name="VIR_FROM_PROXY" id="VIR_FROM_PROXY">VIR_FROM_PROXY</a></td><td> = </td><td>8</td><td> : Error in the proxy code</td></tr><tr><td><a name="VIR_FROM_CONF" id="VIR_FROM_CONF">VIR_FROM_CONF</a></td><td> = </td><td>9</td><td> : Error in the configuration file handling</td></tr><tr><td><a name="VIR_FROM_QEMU" id="VIR_FROM_QEMU">VIR_FROM_QEMU</a></td><td> = </td><td>10</td><td> : Error at the QEMU daemon</td></tr><tr><td><a name="VIR_FROM_NET" id="VIR_FROM_NET">VIR_FROM_NET</a></td><td> = </td><td>11</td><td> : Error when operating on a network</td></tr><tr><td><a name="VIR_FROM_TEST" id="VIR_FROM_TEST">VIR_FROM_TEST</a></td><td> = </td><td>12</td><td> : Error from test driver</td></tr><tr><td><a name="VIR_FROM_REMOTE" id="VIR_FROM_REMOTE">VIR_FROM_REMOTE</a></td><td> = </td><td>13</td><td> : Error from remote driver</td></tr><tr><td><a name="VIR_FROM_OPENVZ" id="VIR_FROM_OPENVZ">VIR_FROM_OPENVZ</a></td><td> = </td><td>14</td><td> : Error from OpenVZ driver</td></tr><tr><td><a name="VIR_FROM_XENXM" id="VIR_FROM_XENXM">VIR_FROM_XENXM</a></td><td> = </td><td>15</td><td> : Error at Xen XM layer</td></tr><tr><td><a name="VIR_FROM_STATS_LINUX" id="VIR_FROM_STATS_LINUX">VIR_FROM_STATS_LINUX</a></td><td> = </td><td>16</td><td> : Error in the Linux Stats code</td></tr><tr><td><a name="VIR_FROM_LXC" id="VIR_FROM_LXC">VIR_FROM_LXC</a></td><td> = </td><td>17</td><td> : Error from Linux Container driver</td></tr><tr><td><a name="VIR_FROM_STORAGE" id="VIR_FROM_STORAGE">VIR_FROM_STORAGE</a></td><td> = </td><td>18</td><td> : Error from storage driver</td></tr></table><pre>}
+</pre></div><h3><a name="virErrorLevel" id="virErrorLevel"><code>virErrorLevel</code></a></h3><div class="api"><pre>enum virErrorLevel {
+</pre><table><tr><td><a name="VIR_ERR_NONE" id="VIR_ERR_NONE">VIR_ERR_NONE</a></td><td> = </td><td>0</td></tr><tr><td><a name="VIR_ERR_WARNING" id="VIR_ERR_WARNING">VIR_ERR_WARNING</a></td><td> = </td><td>1</td><td> : A simple warning</td></tr><tr><td><a name="VIR_ERR_ERROR" id="VIR_ERR_ERROR">VIR_ERR_ERROR</a></td><td> = </td><td>2</td><td> : An error</td></tr></table><pre>}
+</pre></div><h3><a name="virErrorNumber" id="virErrorNumber"><code>virErrorNumber</code></a></h3><div class="api"><pre>enum virErrorNumber {
+</pre><table><tr><td><a name="VIR_ERR_OK" id="VIR_ERR_OK">VIR_ERR_OK</a></td><td> = </td><td>0</td></tr><tr><td><a name="VIR_ERR_INTERNAL_ERROR" id="VIR_ERR_INTERNAL_ERROR">VIR_ERR_INTERNAL_ERROR</a></td><td> = </td><td>1</td><td> : internal error</td></tr><tr><td><a name="VIR_ERR_NO_MEMORY" id="VIR_ERR_NO_MEMORY">VIR_ERR_NO_MEMORY</a></td><td> = </td><td>2</td><td> : memory allocation failure</td></tr><tr><td><a name="VIR_ERR_NO_SUPPORT" id="VIR_ERR_NO_SUPPORT">VIR_ERR_NO_SUPPORT</a></td><td> = </td><td>3</td><td> : no support for this function</td></tr><tr><td><a name="VIR_ERR_UNKNOWN_HOST" id="VIR_ERR_UNKNOWN_HOST">VIR_ERR_UNKNOWN_HOST</a></td><td> = </td><td>4</td><td> : could not resolve hostname</td></tr><tr><td><a name="VIR_ERR_NO_CONNECT" id="VIR_ERR_NO_CONNECT">VIR_ERR_NO_CONNECT</a></td><td> = </td><td>5</td><td> : can't connect to hypervisor</td></tr><tr><td><a name="VIR_ERR_INVALID_CONN" id="VIR_ERR_INVALID_CONN">VIR_ERR_INVALID_CONN</a></td><td> = </td><td>6</td><td> : invalid connection object</td></tr><tr><td><a name="VIR_ERR_INVALID_DOMAIN" id="VIR_ERR_INVALID_DOMAIN">VIR_ERR_INVALID_DOMAIN</a></td><td> = </td><td>7</td><td> : invalid domain object</td></tr><tr><td><a name="VIR_ERR_INVALID_ARG" id="VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a></td><td> = </td><td>8</td><td> : invalid function argument</td></tr><tr><td><a name="VIR_ERR_OPERATION_FAILED" id="VIR_ERR_OPERATION_FAILED">VIR_ERR_OPERATION_FAILED</a></td><td> = </td><td>9</td><td> : a command to hypervisor failed</td></tr><tr><td><a name="VIR_ERR_GET_FAILED" id="VIR_ERR_GET_FAILED">VIR_ERR_GET_FAILED</a></td><td> = </td><td>10</td><td> : a HTTP GET command to failed</td></tr><tr><td><a name="VIR_ERR_POST_FAILED" id="VIR_ERR_POST_FAILED">VIR_ERR_POST_FAILED</a></td><td> = </td><td>11</td><td> : a HTTP POST command to failed</td></tr><tr><td><a name="VIR_ERR_HTTP_ERROR" id="VIR_ERR_HTTP_ERROR">VIR_ERR_HTTP_ERROR</a></td><td> = </td><td>12</td><td> : unexpected HTTP error code</td></tr><tr><td><a name="VIR_ERR_SEXPR_SERIAL" id="VIR_ERR_SEXPR_SERIAL">VIR_ERR_SEXPR_SERIAL</a></td><td> = </td><td>13</td><td> : failure to serialize an S-Expr</td></tr><tr><td><a name="VIR_ERR_NO_XEN" id="VIR_ERR_NO_XEN">VIR_ERR_NO_XEN</a></td><td> = </td><td>14</td><td> : could not open Xen hypervisor control</td></tr><tr><td><a name="VIR_ERR_XEN_CALL" id="VIR_ERR_XEN_CALL">VIR_ERR_XEN_CALL</a></td><td> = </td><td>15</td><td> : failure doing an hypervisor call</td></tr><tr><td><a name="VIR_ERR_OS_TYPE" id="VIR_ERR_OS_TYPE">VIR_ERR_OS_TYPE</a></td><td> = </td><td>16</td><td> : unknown OS type</td></tr><tr><td><a name="VIR_ERR_NO_KERNEL" id="VIR_ERR_NO_KERNEL">VIR_ERR_NO_KERNEL</a></td><td> = </td><td>17</td><td> : missing kernel information</td></tr><tr><td><a name="VIR_ERR_NO_ROOT" id="VIR_ERR_NO_ROOT">VIR_ERR_NO_ROOT</a></td><td> = </td><td>18</td><td> : missing root device information</td></tr><tr><td><a name="VIR_ERR_NO_SOURCE" id="VIR_ERR_NO_SOURCE">VIR_ERR_NO_SOURCE</a></td><td> = </td><td>19</td><td> : missing source device information</td></tr><tr><td><a name="VIR_ERR_NO_TARGET" id="VIR_ERR_NO_TARGET">VIR_ERR_NO_TARGET</a></td><td> = </td><td>20</td><td> : missing target device information</td></tr><tr><td><a name="VIR_ERR_NO_NAME" id="VIR_ERR_NO_NAME">VIR_ERR_NO_NAME</a></td><td> = </td><td>21</td><td> : missing domain name information</td></tr><tr><td><a name="VIR_ERR_NO_OS" id="VIR_ERR_NO_OS">VIR_ERR_NO_OS</a></td><td> = </td><td>22</td><td> : missing domain OS information</td></tr><tr><td><a name="VIR_ERR_NO_DEVICE" id="VIR_ERR_NO_DEVICE">VIR_ERR_NO_DEVICE</a></td><td> = </td><td>23</td><td> : missing domain devices information</td></tr><tr><td><a name="VIR_ERR_NO_XENSTORE" id="VIR_ERR_NO_XENSTORE">VIR_ERR_NO_XENSTORE</a></td><td> = </td><td>24</td><td> : could not open Xen Store control</td></tr><tr><td><a name="VIR_ERR_DRIVER_FULL" id="VIR_ERR_DRIVER_FULL">VIR_ERR_DRIVER_FULL</a></td><td> = </td><td>25</td><td> : too many drivers registered</td></tr><tr><td><a name="VIR_ERR_CALL_FAILED" id="VIR_ERR_CALL_FAILED">VIR_ERR_CALL_FAILED</a></td><td> = </td><td>26</td><td> : not supported by the drivers (DEPRECATED)</td></tr><tr><td><a name="VIR_ERR_XML_ERROR" id="VIR_ERR_XML_ERROR">VIR_ERR_XML_ERROR</a></td><td> = </td><td>27</td><td> : an XML description is not well formed or broken</td></tr><tr><td><a name="VIR_ERR_DOM_EXIST" id="VIR_ERR_DOM_EXIST">VIR_ERR_DOM_EXIST</a></td><td> = </td><td>28</td><td> : the domain already exist</td></tr><tr><td><a name="VIR_ERR_OPERATION_DENIED" id="VIR_ERR_OPERATION_DENIED">VIR_ERR_OPERATION_DENIED</a></td><td> = </td><td>29</td><td> : operation forbidden on read-only connections</td></tr><tr><td><a name="VIR_ERR_OPEN_FAILED" id="VIR_ERR_OPEN_FAILED">VIR_ERR_OPEN_FAILED</a></td><td> = </td><td>30</td><td> : failed to open a conf file</td></tr><tr><td><a name="VIR_ERR_READ_FAILED" id="VIR_ERR_READ_FAILED">VIR_ERR_READ_FAILED</a></td><td> = </td><td>31</td><td> : failed to read a conf file</td></tr><tr><td><a name="VIR_ERR_PARSE_FAILED" id="VIR_ERR_PARSE_FAILED">VIR_ERR_PARSE_FAILED</a></td><td> = </td><td>32</td><td> : failed to parse a conf file</td></tr><tr><td><a name="VIR_ERR_CONF_SYNTAX" id="VIR_ERR_CONF_SYNTAX">VIR_ERR_CONF_SYNTAX</a></td><td> = </td><td>33</td><td> : failed to parse the syntax of a conf file</td></tr><tr><td><a name="VIR_ERR_WRITE_FAILED" id="VIR_ERR_WRITE_FAILED">VIR_ERR_WRITE_FAILED</a></td><td> = </td><td>34</td><td> : failed to write a conf file</td></tr><tr><td><a name="VIR_ERR_XML_DETAIL" id="VIR_ERR_XML_DETAIL">VIR_ERR_XML_DETAIL</a></td><td> = </td><td>35</td><td> : detail of an XML error</td></tr><tr><td><a name="VIR_ERR_INVALID_NETWORK" id="VIR_ERR_INVALID_NETWORK">VIR_ERR_INVALID_NETWORK</a></td><td> = </td><td>36</td><td> : invalid network object</td></tr><tr><td><a name="VIR_ERR_NETWORK_EXIST" id="VIR_ERR_NETWORK_EXIST">VIR_ERR_NETWORK_EXIST</a></td><td> = </td><td>37</td><td> : the network already exist</td></tr><tr><td><a name="VIR_ERR_SYSTEM_ERROR" id="VIR_ERR_SYSTEM_ERROR">VIR_ERR_SYSTEM_ERROR</a></td><td> = </td><td>38</td><td> : general system call failure</td></tr><tr><td><a name="VIR_ERR_RPC" id="VIR_ERR_RPC">VIR_ERR_RPC</a></td><td> = </td><td>39</td><td> : some sort of RPC error</td></tr><tr><td><a name="VIR_ERR_GNUTLS_ERROR" id="VIR_ERR_GNUTLS_ERROR">VIR_ERR_GNUTLS_ERROR</a></td><td> = </td><td>40</td><td> : error from a GNUTLS call</td></tr><tr><td><a name="VIR_WAR_NO_NETWORK" id="VIR_WAR_NO_NETWORK">VIR_WAR_NO_NETWORK</a></td><td> = </td><td>41</td><td> : failed to start network</td></tr><tr><td><a name="VIR_ERR_NO_DOMAIN" id="VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a></td><td> = </td><td>42</td><td> : domain not found or unexpectedly disappeared</td></tr><tr><td><a name="VIR_ERR_NO_NETWORK" id="VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a></td><td> = </td><td>43</td><td> : network not found</td></tr><tr><td><a name="VIR_ERR_INVALID_MAC" id="VIR_ERR_INVALID_MAC">VIR_ERR_INVALID_MAC</a></td><td> = </td><td>44</td><td> : invalid MAC address</td></tr><tr><td><a name="VIR_ERR_AUTH_FAILED" id="VIR_ERR_AUTH_FAILED">VIR_ERR_AUTH_FAILED</a></td><td> = </td><td>45</td><td> : authentication failed</td></tr><tr><td><a name="VIR_ERR_INVALID_STORAGE_POOL" id="VIR_ERR_INVALID_STORAGE_POOL">VIR_ERR_INVALID_STORAGE_POOL</a></td><td> = </td><td>46</td><td> : invalid storage pool object</td></tr><tr><td><a name="VIR_ERR_INVALID_STORAGE_VOL" id="VIR_ERR_INVALID_STORAGE_VOL">VIR_ERR_INVALID_STORAGE_VOL</a></td><td> = </td><td>47</td><td> : invalid storage vol object</td></tr><tr><td><a name="VIR_WAR_NO_STORAGE" id="VIR_WAR_NO_STORAGE">VIR_WAR_NO_STORAGE</a></td><td> = </td><td>48</td><td> : failed to start storage</td></tr><tr><td><a name="VIR_ERR_NO_STORAGE_POOL" id="VIR_ERR_NO_STORAGE_POOL">VIR_ERR_NO_STORAGE_POOL</a></td><td> = </td><td>49</td><td> : storage pool not found</td></tr><tr><td><a name="VIR_ERR_NO_STORAGE_VOL" id="VIR_ERR_NO_STORAGE_VOL">VIR_ERR_NO_STORAGE_VOL</a></td><td> = </td><td>50</td><td> : storage pool not found</td></tr></table><pre>}
+</pre></div><h3><a name="functions" id="functions">Functions</a></h3><h3><a name="virConnCopyLastError" id="virConnCopyLastError"><code>virConnCopyLastError</code></a></h3><pre class="programlisting">int virConnCopyLastError (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> <a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> to)<br />
+</pre><p>Copy the content of the last error caught on that connection One will need to free the result with virResetError()</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>to</tt></i>:</span></td><td>target to receive the copy</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no error was found and the error code otherwise and -1 in case of parameter error.</td></tr></tbody></table></div><h3><a name="virConnGetLastError" id="virConnGetLastError"><code>virConnGetLastError</code></a></h3><pre class="programlisting"><a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> virConnGetLastError (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provide a pointer to the last error caught on that connection Simpler but may not be suitable for multithreaded accesses, in which case use virConnCopyLastError()</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the last error or NULL if none occurred.</td></tr></tbody></table></div><h3><a name="virConnResetLastError" id="virConnResetLastError"><code>virConnResetLastError</code></a></h3><pre class="programlisting">void virConnResetLastError (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Reset the last error caught on that connection</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr></tbody></table></div><h3><a name="virConnSetErrorFunc" id="virConnSetErrorFunc"><code>virConnSetErrorFunc</code></a></h3><pre class="programlisting">void virConnSetErrorFunc (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> void * userData, <br /> <a href="libvirt-virterror.html#virErrorFunc">virErrorFunc</a> handler)<br />
+</pre><p>Set a connection error handling function, if @handler is NULL it will reset to default which is to pass error back to the global library handler.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>userData</tt></i>:</span></td><td>pointer to the user data provided in the handler callback</td></tr><tr><td><span class="term"><i><tt>handler</tt></i>:</span></td><td>the function to get called in case of error or NULL</td></tr></tbody></table></div><h3><a name="virCopyLastError" id="virCopyLastError"><code>virCopyLastError</code></a></h3><pre class="programlisting">int virCopyLastError (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> to)<br />
+</pre><p>Copy the content of the last error caught at the library level One will need to free the result with virResetError()</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>to</tt></i>:</span></td><td>target to receive the copy</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no error was found and the error code otherwise and -1 in case of parameter error.</td></tr></tbody></table></div><h3><a name="virDefaultErrorFunc" id="virDefaultErrorFunc"><code>virDefaultErrorFunc</code></a></h3><pre class="programlisting">void virDefaultErrorFunc (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> err)<br />
+</pre><p>Default routine reporting an error to stderr.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>err</tt></i>:</span></td><td>pointer to the error.</td></tr></tbody></table></div><h3><a name="virErrorFunc" id="virErrorFunc"><code>virErrorFunc</code></a></h3><pre class="programlisting">typedef void (*virErrorFunc ) (void * userData, <br /> <a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> error)
+</pre><p>Signature of a function to use when there is an error raised by the library.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>userData</tt></i>:</span></td><td>user provided data for the error callback</td></tr><tr><td><span class="term"><i><tt>error</tt></i>:</span></td><td>the error being raised.</td></tr></tbody></table></div><br /><h3><a name="virGetLastError" id="virGetLastError"><code>virGetLastError</code></a></h3><pre class="programlisting"><a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> virGetLastError (void)<br />
+</pre><p>Provide a pointer to the last error caught at the library level Simpler but may not be suitable for multithreaded accesses, in which case use virCopyLastError()</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the last error or NULL if none occurred.</td></tr></tbody></table></div><h3><a name="virResetError" id="virResetError"><code>virResetError</code></a></h3><pre class="programlisting">void virResetError (<a href="libvirt-virterror.html#virErrorPtr">virErrorPtr</a> err)<br />
+</pre><p>Reset the error being pointed to</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>err</tt></i>:</span></td><td>pointer to the <a href="libvirt-virterror.html#virError">virError</a> to clean up</td></tr></tbody></table></div><h3><a name="virResetLastError" id="virResetLastError"><code>virResetLastError</code></a></h3><pre class="programlisting">void virResetLastError (void)<br />
+</pre><p>Reset the last error caught at the library level.</p><h3><a name="virSetErrorFunc" id="virSetErrorFunc"><code>virSetErrorFunc</code></a></h3><pre class="programlisting">void virSetErrorFunc (void * userData, <br /> <a href="libvirt-virterror.html#virErrorFunc">virErrorFunc</a> handler)<br />
+</pre><p>Set a library global error handling function, if @handler is NULL, it will reset to default printing on stderr. The error raised there are those for which no handler at the connection level could caught.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>userData</tt></i>:</span></td><td>pointer to the user data provided in the handler callback</td></tr><tr><td><span class="term"><i><tt>handler</tt></i>:</span></td><td>the function to get called in case of error or NULL</td></tr></tbody></table></div></div><div id="menu"><ul class="l0"><li><a title="Front page of the libvirt website" class="inactive" href="../index.html">Home</a></li><li><a title="Details of new features and bugs fixed in each release" class="inactive" href="../news.html">News</a></li><li><a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="../downloads.html">Downloads</a></li><li><a title="Information for users, administrators and developers" class="active" href="../docs.html">Documentation</a><ul class="l1"><li><a title="Information about deploying and using libvirt" class="inactive" href="../deployment.html">Deployment</a></li><li><a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="../intro.html">Architecture</a></li><li><a title="Description of the XML formats used in libvirt" class="inactive" href="../format.html">XML format</a></li><li><a title="Hypervisor specific driver information" class="inactive" href="../drivers.html">Drivers</a></li><li><a title="Reference manual for the C public API" class="active" href="../html/index.html">API reference</a><ul class="l2"><li><a title="core interfaces for the libvirt library" class="inactive" href="../html/libvirt-libvirt.html">libvirt</a></li><li><span class="active">virterror</span></li><li><a title="matrix of API support per hypervisor per release" class="inactive" href="../hvsupport.html">Driver support</a></li></ul></li><li><a title="Bindings of the libvirt API for other languages" class="inactive" href="../bindings.html">Language bindings</a></li></ul></li><li><a title="User contributed content" class="inactive" href="../http://wiki.libvirt.org">Wiki</a></li><li><a title="Frequently asked questions" class="inactive" href="../FAQ.html">FAQ</a></li><li><a title="How and where to report bugs and request features" class="inactive" href="../bugs.html">Bug reports</a></li><li><a title="How to contact the developers via email and IRC" class="inactive" href="../contact.html">Contact</a></li><li><a title="Miscellaneous links of interest related to libvirt" class="inactive" href="../relatedlinks.html">Related Links</a></li><li><a title="Overview of all content on the website" class="inactive" href="../sitemap.html">Sitemap</a></li></ul></div></div><div id="footer"><div id="projects"><dl id="p1"><dt><a href="http://augeas.net/">Augeas</a></dt><dd><span>A configuration editing tool and API</span></dd><dt><a href="http://libvirt.org/">libvirt</a></dt><dd><span>The open source virtualization API</span></dd></dl><dl id="p2"><dt><a href="http://cobbler.et.redhat.com/">Cobbler</a></dt><dd><span>OS provisioning and profile management</span></dd><dt><a href="http://ovirt.org/">oVirt</a></dt><dd><span>Virtualization management across the data center</span></dd></dl><dl id="p3"><dt><a href="http://freeipa.org/">FreeIPA</a></dt><dd><span>Identity, policy and audit management</span></dd><dt><a href="http://virt-manager.org/">Virtual Machine Manager</a></dt><dd><span>Virtualization management from the desktop</span></dd></dl></div></div></body></html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Hypervisor support</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Hypervisor support</h1><p>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from hvsupport.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Driver support matrix</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Driver support matrix</h1>
+ <p>
This page documents which <a href="html/">libvirt calls</a> work on
-which hypervisors.
-</p><p>
+which libvirt drivers / hypervisors, and which version the API appeared
+in.
+</p>
+ <p>
This information changes frequently. This page was last checked or
updated on <i>2007-08-20</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> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectGetCapabilities </td>
- <td> 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectGetHostname </td>
- <td> 0.3.0 </td>
- <td> ≥ 0.3.0 </td>
- <td> ≥ 0.3.3 </td>
- <td> ≥ 0.3.3 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectGetMaxVcpus </td>
- <td> 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectGetType </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectGetURI </td>
- <td> 0.3.0 </td>
- <td> ≥ 0.3.0 </td>
- <td> ≥ 0.3.0 </td>
- <td> ≥ 0.3.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectGetVersion </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectListDefinedDomains </td>
- <td> 0.1.5 </td>
- <td> ≥ 0.1.9 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectListDomains </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectNumOfDefinedDomains </td>
- <td> 0.1.5 </td>
- <td> ≥ 0.1.9 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectNumOfDomains </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectOpen </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virConnectOpenReadOnly </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainAttachDevice </td>
- <td> 0.1.9 </td>
- <td> ≥ 0.1.9 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainBlockStats </td>
- <td> 0.3.2 </td>
- <td> ≥ 0.3.2 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.2 </td>
-</tr><tr><td> virDomainCoreDump </td>
- <td> 0.1.9 </td>
- <td> ≥ 0.1.9 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainCreate </td>
- <td> 0.1.5 </td>
- <td> ≥ 0.1.9 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainCreateLinux </td>
- <td> All </td>
- <td> ≥ 0.0.5 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainDefineXML </td>
- <td> 0.1.5 </td>
- <td> ≥ 0.1.9 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainDestroy </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainDetachDevice </td>
- <td> 0.1.9 </td>
- <td> ≥ 0.1.9 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainFree </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetAutostart </td>
- <td> 0.2.1 </td>
- <td> x </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 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> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetInfo </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetMaxMemory </td>
- <td> All </td>
- <td> All </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetMaxVcpus </td>
- <td> 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetName </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetOSType </td>
- <td> All </td>
- <td> All </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetSchedulerParameters </td>
- <td> 0.2.3 </td>
- <td> ≥ 0.2.3 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetSchedulerType </td>
- <td> 0.2.3 </td>
- <td> ≥ 0.2.3 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetUUID </td>
- <td> 0.1.10 </td>
- <td> ≥ 0.1.10 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetUUIDString </td>
- <td> 0.1.10 </td>
- <td> ≥ 0.1.10 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainGetVcpus </td>
- <td> 0.1.4 </td>
- <td> ≥ 0.1.4 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainInterfaceStats </td>
- <td> 0.3.2 </td>
- <td> ≥ 0.3.2 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.2 </td>
-</tr><tr><td> virDomainGetXMLDesc </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainLookupByID </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainLookupByName </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainLookupByUUID </td>
- <td> 0.1.10 </td>
- <td> ≥ 0.1.10 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainLookupByUUIDString </td>
- <td> 0.1.10 </td>
- <td> ≥ 0.1.10 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainMigrate </td>
- <td> 0.3.2 </td>
- <td> ≥ 0.3.2 </td>
- <td> x </td>
- <td> x </td>
- <td> 0.3.2 </td>
-</tr><tr><td> virDomainPinVcpu </td>
- <td> 0.1.4 </td>
- <td> ≥ 0.1.4 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainReboot </td>
- <td> 0.1.0 </td>
- <td> ≥ 0.1.0 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainRestore </td>
- <td> All </td>
- <td> All </td>
- <td> x </td>
- <td> ≥ 0.3.2 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainResume </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainSave </td>
- <td> All </td>
- <td> All </td>
- <td> x </td>
- <td> ≥ 0.3.2 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainSetAutostart </td>
- <td> 0.2.1 </td>
- <td> x </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainSetMaxMemory </td>
- <td> All </td>
- <td> All </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainSetMemory </td>
- <td> 0.1.1 </td>
- <td> ≥ 0.1.1 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainSetSchedulerParameters </td>
- <td> 0.2.3 </td>
- <td> ≥ 0.2.3 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainSetVcpus </td>
- <td> 0.1.4 </td>
- <td> ≥ 0.1.4 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainShutdown </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainSuspend </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virDomainUndefine </td>
- <td> 0.1.5 </td>
- <td> ≥ 0.1.9 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 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> ≥ 0.1.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr><tr><td> virNodeGetFreeMemory </td>
- <td> 0.3.3 </td>
- <td> ≥ 0.3.3 </td>
- <td> x </td>
- <td> x </td>
- <td> x </td>
-</tr><tr><td> virNodeGetCellsFreeMemory </td>
- <td> 0.3.3 </td>
- <td> ≥ 0.3.3 </td>
- <td> x </td>
- <td> x </td>
- <td> x </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></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+</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><a href="drvxen.html">Xen</a></th><th><a href="drvqemu.html">QEMU</a></th><th><a href="drvkvm.html">KVM</a></th><th><a href="remote.html">Remote</a></th></tr><tr><td> virConnectClose </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectGetCapabilities </td><td> 0.2.1 </td><td> ≥ 0.2.1 </td><td> ≥ 0.2.1 </td><td> ≥ 0.2.1 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectGetHostname </td><td> 0.3.0 </td><td> ≥ 0.3.0 </td><td> ≥ 0.3.3 </td><td> ≥ 0.3.3 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectGetMaxVcpus </td><td> 0.2.1 </td><td> ≥ 0.2.1 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectGetType </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectGetURI </td><td> 0.3.0 </td><td> ≥ 0.3.0 </td><td> ≥ 0.3.0 </td><td> ≥ 0.3.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectGetVersion </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectListDefinedDomains </td><td> 0.1.5 </td><td> ≥ 0.1.9 </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectListDomains </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectNumOfDefinedDomains </td><td> 0.1.5 </td><td> ≥ 0.1.9 </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectNumOfDomains </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectOpen </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virConnectOpenReadOnly </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainAttachDevice </td><td> 0.1.9 </td><td> ≥ 0.1.9 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainBlockStats </td><td> 0.3.2 </td><td> ≥ 0.3.2 </td><td> x </td><td> x </td><td> ≥ 0.3.2 </td></tr><tr><td> virDomainCoreDump </td><td> 0.1.9 </td><td> ≥ 0.1.9 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainCreate </td><td> 0.1.5 </td><td> ≥ 0.1.9 </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainCreateLinux </td><td> All </td><td> ≥ 0.0.5 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainDefineXML </td><td> 0.1.5 </td><td> ≥ 0.1.9 </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainDestroy </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainDetachDevice </td><td> 0.1.9 </td><td> ≥ 0.1.9 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainFree </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetAutostart </td><td> 0.2.1 </td><td> x </td><td> ≥ 0.2.1 </td><td> ≥ 0.2.1 </td><td> ≥ 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> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetInfo </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetMaxMemory </td><td> All </td><td> All </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetMaxVcpus </td><td> 0.2.1 </td><td> ≥ 0.2.1 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetName </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetOSType </td><td> All </td><td> All </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetSchedulerParameters </td><td> 0.2.3 </td><td> ≥ 0.2.3 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetSchedulerType </td><td> 0.2.3 </td><td> ≥ 0.2.3 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetUUID </td><td> 0.1.10 </td><td> ≥ 0.1.10 </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetUUIDString </td><td> 0.1.10 </td><td> ≥ 0.1.10 </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainGetVcpus </td><td> 0.1.4 </td><td> ≥ 0.1.4 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainInterfaceStats </td><td> 0.3.2 </td><td> ≥ 0.3.2 </td><td> x </td><td> x </td><td> ≥ 0.3.2 </td></tr><tr><td> virDomainGetXMLDesc </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainLookupByID </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainLookupByName </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainLookupByUUID </td><td> 0.1.10 </td><td> ≥ 0.1.10 </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainLookupByUUIDString </td><td> 0.1.10 </td><td> ≥ 0.1.10 </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainMigrate </td><td> 0.3.2 </td><td> ≥ 0.3.2 </td><td> x </td><td> x </td><td> 0.3.2 </td></tr><tr><td> virDomainPinVcpu </td><td> 0.1.4 </td><td> ≥ 0.1.4 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainReboot </td><td> 0.1.0 </td><td> ≥ 0.1.0 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainRestore </td><td> All </td><td> All </td><td> x </td><td> ≥ 0.3.2 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainResume </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainSave </td><td> All </td><td> All </td><td> x </td><td> ≥ 0.3.2 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainSetAutostart </td><td> 0.2.1 </td><td> x </td><td> ≥ 0.2.1 </td><td> ≥ 0.2.1 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainSetMaxMemory </td><td> All </td><td> All </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainSetMemory </td><td> 0.1.1 </td><td> ≥ 0.1.1 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainSetSchedulerParameters </td><td> 0.2.3 </td><td> ≥ 0.2.3 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainSetVcpus </td><td> 0.1.4 </td><td> ≥ 0.1.4 </td><td> x </td><td> x </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainShutdown </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainSuspend </td><td> All </td><td> All </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virDomainUndefine </td><td> 0.1.5 </td><td> ≥ 0.1.9 </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 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> ≥ 0.1.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.2.0 </td><td> ≥ 0.3.0 </td></tr><tr><td> virNodeGetFreeMemory </td><td> 0.3.3 </td><td> ≥ 0.3.3 </td><td> x </td><td> x </td><td> x </td></tr><tr><td> virNodeGetCellsFreeMemory </td><td> 0.3.3 </td><td> ≥ 0.3.3 </td><td> x </td><td> x </td><td> x </td></tr></table>
+ <h3>Network functions</h3>
+ <p>
+Network functions are not hypervisor-specific.They require the libvirtd
+daemon to be running. 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>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="active" href="html/index.html">API reference</a>
+ <ul class="l2"><li>
+ <a title="core interfaces for the libvirt library" class="inactive" href="html/libvirt-libvirt.html">libvirt</a>
+ </li><li>
+ <a title="error handling interfaces for the libvirt library" class="inactive" href="html/libvirt-virterror.html">virterror</a>
+ </li><li>
+ <span class="active">Driver support</span>
+ </li></ul>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1>Driver support matrix</h1>
+ <p>
+This page documents which <a href="html/">libvirt calls</a> work on
+which libvirt drivers / hypervisors, and which version the API appeared
+in.
+</p>
+ <p>
+This information changes frequently. This page was last checked or
+updated on <i>2007-08-20</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><a href="drvxen.html">Xen</a></th>
+ <th><a href="drvqemu.html">QEMU</a></th>
+ <th><a href="drvkvm.html">KVM</a></th>
+ <th><a href="remote.html">Remote</a></th>
+ </tr>
+ <tr>
+ <td> virConnectClose </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectGetCapabilities </td>
+ <td> 0.2.1 </td>
+ <td> ≥ 0.2.1 </td>
+ <td> ≥ 0.2.1 </td>
+ <td> ≥ 0.2.1 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectGetHostname </td>
+ <td> 0.3.0 </td>
+ <td> ≥ 0.3.0 </td>
+ <td> ≥ 0.3.3 </td>
+ <td> ≥ 0.3.3 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectGetMaxVcpus </td>
+ <td> 0.2.1 </td>
+ <td> ≥ 0.2.1 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectGetType </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectGetURI </td>
+ <td> 0.3.0 </td>
+ <td> ≥ 0.3.0 </td>
+ <td> ≥ 0.3.0 </td>
+ <td> ≥ 0.3.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectGetVersion </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectListDefinedDomains </td>
+ <td> 0.1.5 </td>
+ <td> ≥ 0.1.9 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectListDomains </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectNumOfDefinedDomains </td>
+ <td> 0.1.5 </td>
+ <td> ≥ 0.1.9 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectNumOfDomains </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectOpen </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virConnectOpenReadOnly </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainAttachDevice </td>
+ <td> 0.1.9 </td>
+ <td> ≥ 0.1.9 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainBlockStats </td>
+ <td> 0.3.2 </td>
+ <td> ≥ 0.3.2 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.2 </td>
+ </tr>
+ <tr>
+ <td> virDomainCoreDump </td>
+ <td> 0.1.9 </td>
+ <td> ≥ 0.1.9 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainCreate </td>
+ <td> 0.1.5 </td>
+ <td> ≥ 0.1.9 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainCreateLinux </td>
+ <td> All </td>
+ <td> ≥ 0.0.5 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainDefineXML </td>
+ <td> 0.1.5 </td>
+ <td> ≥ 0.1.9 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainDestroy </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainDetachDevice </td>
+ <td> 0.1.9 </td>
+ <td> ≥ 0.1.9 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainFree </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetAutostart </td>
+ <td> 0.2.1 </td>
+ <td> x </td>
+ <td> ≥ 0.2.1 </td>
+ <td> ≥ 0.2.1 </td>
+ <td> ≥ 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> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetInfo </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetMaxMemory </td>
+ <td> All </td>
+ <td> All </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetMaxVcpus </td>
+ <td> 0.2.1 </td>
+ <td> ≥ 0.2.1 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetName </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetOSType </td>
+ <td> All </td>
+ <td> All </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetSchedulerParameters </td>
+ <td> 0.2.3 </td>
+ <td> ≥ 0.2.3 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetSchedulerType </td>
+ <td> 0.2.3 </td>
+ <td> ≥ 0.2.3 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetUUID </td>
+ <td> 0.1.10 </td>
+ <td> ≥ 0.1.10 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetUUIDString </td>
+ <td> 0.1.10 </td>
+ <td> ≥ 0.1.10 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetVcpus </td>
+ <td> 0.1.4 </td>
+ <td> ≥ 0.1.4 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainInterfaceStats </td>
+ <td> 0.3.2 </td>
+ <td> ≥ 0.3.2 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.2 </td>
+ </tr>
+ <tr>
+ <td> virDomainGetXMLDesc </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainLookupByID </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainLookupByName </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainLookupByUUID </td>
+ <td> 0.1.10 </td>
+ <td> ≥ 0.1.10 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainLookupByUUIDString </td>
+ <td> 0.1.10 </td>
+ <td> ≥ 0.1.10 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainMigrate </td>
+ <td> 0.3.2 </td>
+ <td> ≥ 0.3.2 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> 0.3.2 </td>
+ </tr>
+ <tr>
+ <td> virDomainPinVcpu </td>
+ <td> 0.1.4 </td>
+ <td> ≥ 0.1.4 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainReboot </td>
+ <td> 0.1.0 </td>
+ <td> ≥ 0.1.0 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainRestore </td>
+ <td> All </td>
+ <td> All </td>
+ <td> x </td>
+ <td> ≥ 0.3.2 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainResume </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainSave </td>
+ <td> All </td>
+ <td> All </td>
+ <td> x </td>
+ <td> ≥ 0.3.2 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainSetAutostart </td>
+ <td> 0.2.1 </td>
+ <td> x </td>
+ <td> ≥ 0.2.1 </td>
+ <td> ≥ 0.2.1 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainSetMaxMemory </td>
+ <td> All </td>
+ <td> All </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainSetMemory </td>
+ <td> 0.1.1 </td>
+ <td> ≥ 0.1.1 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainSetSchedulerParameters </td>
+ <td> 0.2.3 </td>
+ <td> ≥ 0.2.3 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainSetVcpus </td>
+ <td> 0.1.4 </td>
+ <td> ≥ 0.1.4 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainShutdown </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainSuspend </td>
+ <td> All </td>
+ <td> All </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virDomainUndefine </td>
+ <td> 0.1.5 </td>
+ <td> ≥ 0.1.9 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 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> ≥ 0.1.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.2.0 </td>
+ <td> ≥ 0.3.0 </td>
+ </tr>
+ <tr>
+ <td> virNodeGetFreeMemory </td>
+ <td> 0.3.3 </td>
+ <td> ≥ 0.3.3 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> x </td>
+ </tr>
+ <tr>
+ <td> virNodeGetCellsFreeMemory </td>
+ <td> 0.3.3 </td>
+ <td> ≥ 0.3.3 </td>
+ <td> x </td>
+ <td> x </td>
+ <td> x </td>
+ </tr>
+ </table>
+ <h3>Network functions</h3>
+ <p>
+Network functions are not hypervisor-specific.They require the libvirtd
+daemon to be running. 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>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from index.html.in
+ Do not edit this file. Changes will be lost.
+ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
- <link rel="stylesheet" type="text/css" href="libvirt.css" />
- <link rel="SHORTCUT ICON" href="/32favicon.png" />
- <title>the virtualization API</title>
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: The virtualization API</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
</head>
<body>
- <div id="container">
- <div id="intro">
- <div id="adjustments">
- <p class="p1"></p>
- </div>
- <div id="content">
- <h3>what is <span class="style1">libvirt?</span></h3>
- <p>Libvirt is a C toolkit to interact with the virtualization capabilities
-of recent versions of Linux (and other OSes). It is free software available
-under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
-Lesser General Public License</a>. Virtualization of the Linux Operating
-System means the ability to run multiple instances of Operating Systems
-concurrently on a single hardware system where the basic resources are driven
-by a Linux (or Solaris) instance. The library aims at providing a long term
-stable C API initially for <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen
-paravirtualization</a> but it can also integrate with other
-virtualization mechanisms. It currently also supports <a href="http://fabrice.bellard.free.fr/qemu/">QEMU</a>, <a href="http://kvm.qumranet.com/">KVM</a> and
-<a href="http://openvz.org/">OpenVZ</a>.</p>
- </div>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
</div>
- <div class="linkList">
- <div class="llinks">
- <h3 class="links">
- <span>main menu</span>
- </h3>
- <ul>
- <li>Home</li>
- <li>
- <a href="news.html">Releases</a>
- </li>
- <li>
- <a href="intro.html">Introduction</a>
- </li>
- <li>
- <a href="architecture.html">libvirt architecture</a>
- </li>
- <li>
- <a href="downloads.html">Downloads</a>
- </li>
- <li>
- <a href="format.html">XML Format</a>
- </li>
- <li>
- <a href="python.html">Bindings for other languages</a>
- </li>
- <li>
- <a href="errors.html">Handling of errors</a>
- </li>
- <li>
- <a href="FAQ.html">FAQ</a>
- </li>
- <li>
- <a href="bugs.html">Reporting bugs and getting help</a>
- </li>
- <li>
- <a href="windows.html">Windows support</a>
- </li>
- <li>
- <a href="remote.html">Remote support</a>
- </li>
- <li>
- <a href="auth.html">Access control</a>
- </li>
- <li>
- <a href="uri.html">Connection URIs</a>
- </li>
- <li>
- <a href="hvsupport.html">Hypervisor support</a>
- </li>
- <li>
- <a href="storage.html">Storage Management</a>
- </li>
- <li>
- <a href="html/index.html">API Menu</a>
- </li>
- <li>
- <a href="examples/index.html">C code examples</a>
- </li>
- <li>
- <a href="ChangeLog.html">Recent Changes</a>
- </li>
- </ul>
- </div>
- <div class="llinks">
- <h3 class="links">
- <span>related links</span>
- </h3>
- <ul>
- <li>
- <a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a>
- </li>
- <li>
- <a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a>
- </li>
- <li>
- <a href="http://virt-manager.et.redhat.com/">virt-manager</a>
- </li>
- <li>
- <a href="http://libvirt.org/CIM/">CIM provider</a>
- </li>
- <li>
- <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a>
- </li>
- <li>
- <a href="http://libvirt.org/ocaml/">OCaml bindings</a>
- </li>
- <li>
- <a href="http://libvirt.org/ruby/">Ruby bindings</a>
- </li>
- <li>
- <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a>
- </li>
- <li>
- <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
- <input name="query" type="text" size="12" value="Search..." />
- <input name="submit" type="submit" value="Go" />
- </form>
- </li>
- <li>
- <a href="http://xmlsoft.org/">
- <img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" />
- </a>
- </li>
- </ul>
- <p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p>
- </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>The virtualization API</h1>
+ <h2>libvirt is:</h2>
+ <ul><li>
+ A toolkit to interact with the virtualization capabilities
+ of recent versions of Linux (and other OSes).
+ </li><li>
+ Free software available under the
+ <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
+ Lesser General Public License</a>.
+ </li><li>
+ A long term stable C API
+ </li><li>
+ A set of bindings for common languages
+ </li><li>
+ A <a href="CIM/">CIM provider</a> for the DMTF virtualization schema
+ </li></ul>
+ <h2>libvirt supports:</h2>
+ <ul><li>
+ The <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen</a> hypervisor
+ on Linux and Solaris hosts.
+ </li><li>
+ The <a href="http://fabrice.bellard.free.fr/qemu/">QEMU</a> emulator
+ </li><li>
+ The <a href="http://kvm.qumranet.com/kvmwiki">KVM</a> Linux hypervisor
+ </li><li>
+ The <a href="http://lxc.sourceforge.net/">LXC</a> Linux container system
+ </li><li>
+ The <a href="http://openvz.org/">OpenVZ</a> Linux container system
+ </li><li>
+ Storage on IDE/SCSI/USB disks, FibreChannel, LVM, iSCSI, NFS and filesystems
+ </li></ul>
+ <h2>libvirt provides:</h2>
+ <ul><li>Remote management using TLS encryption and x509 certificates</li><li>Remote management authenticating with Kerberos and SASL</li><li>Local access control using PolicyKit</li><li>Zero-conf discovery using Avahi mulicast-DNS</li><li>Management of virtual machines, virtual networks and storage</li></ul>
+ <p class="image">
+ <img src="libvirtLogo.png" alt="libvirt Logo" /></p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <span class="active">Home</span>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
</div>
- <div id="bottom">
- <p class="p1"></p>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
</div>
</div>
</body>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1>The virtualization API</h1>
+
+ <h2>libvirt is:</h2>
+
+ <ul>
+ <li>
+ A toolkit to interact with the virtualization capabilities
+ of recent versions of Linux (and other OSes).
+ </li>
+ <li>
+ Free software available under the
+ <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
+ Lesser General Public License</a>.
+ </li>
+
+ <li>
+ A long term stable C API
+ </li>
+ <li>
+ A set of bindings for common languages
+ </li>
+ <li>
+ A <a href="CIM/">CIM provider</a> for the DMTF virtualization schema
+ </li>
+ </ul>
+
+ <h2>libvirt supports:</h2>
+
+ <ul>
+ <li>
+ The <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen</a> hypervisor
+ on Linux and Solaris hosts.
+ </li>
+ <li>
+ The <a href="http://fabrice.bellard.free.fr/qemu/">QEMU</a> emulator
+ </li>
+ <li>
+ The <a href="http://kvm.qumranet.com/kvmwiki">KVM</a> Linux hypervisor
+ </li>
+ <li>
+ The <a href="http://lxc.sourceforge.net/">LXC</a> Linux container system
+ </li>
+ <li>
+ The <a href="http://openvz.org/">OpenVZ</a> Linux container system
+ </li>
+ <li>
+ Storage on IDE/SCSI/USB disks, FibreChannel, LVM, iSCSI, NFS and filesystems
+ </li>
+ </ul>
+
+ <h2>libvirt provides:</h2>
+
+ <ul>
+ <li>Remote management using TLS encryption and x509 certificates</li>
+ <li>Remote management authenticating with Kerberos and SASL</li>
+ <li>Local access control using PolicyKit</li>
+ <li>Zero-conf discovery using Avahi mulicast-DNS</li>
+ <li>Management of virtual machines, virtual networks and storage</li>
+ </ul>
+
+ <p class="image">
+ <img src="libvirtLogo.png" alt="libvirt Logo"/>
+ </p>
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Introduction</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Introduction</h1><p>Libvirt is a C toolkit to interact with the virtualization capabilities of
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from intro.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Architecture</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Architecture</h1>
+ <p>Libvirt is a C toolkit to interact with the virtualization capabilities of
recent versions of Linux (and other OSes), but libvirt won't try to provide
-all possible interfaces for interacting with the virtualization features.</p><p>To avoid ambiguity about the terms used here here are the definitions for
-some of the specific concepts used in libvirt documentation:</p><ul><li>a <strong>node</strong> is a single physical machine</li>
- <li>an <strong>hypervisor</strong> is a layer of software allowing to
+all possible interfaces for interacting with the virtualization features.</p>
+ <p>To avoid ambiguity about the terms used here here are the definitions for
+some of the specific concepts used in libvirt documentation:</p>
+ <ul><li>a <strong>node</strong> is a single physical machine</li><li>an <strong>hypervisor</strong> is a layer of software allowing to
virtualize a node in a set of virtual machines with possibly different
- configurations than the node itself</li>
- <li>a <strong>domain</strong> is an instance of an operating system running
- on a virtualized machine provided by the hypervisor</li>
-</ul><p style="text-align: center"><img alt="Hypervisor and domains running on a node" src="node.gif" /></p><p>Now we can define the goal of libvirt: to provide the lowest possible
-generic and stable layer to manage domains on a node.</p><p>This implies the following:</p><ul><li>the API should not be targeted to a single virtualization environment
+ configurations than the node itself</li><li>a <strong>domain</strong> is an instance of an operating system running
+ on a virtualized machine provided by the hypervisor</li></ul>
+ <p class="image">
+ <img alt="Hypervisor and domains running on a node" src="node.gif" /></p>
+ <p>Now we can define the goal of libvirt: to provide the lowest possible
+generic and stable layer to manage domains on a node.</p>
+ <p>This implies the following:</p>
+ <ul><li>the API should not be targeted to a single virtualization environment
though Xen is the current default, which also means that some very
specific capabilities which are not generic enough may not be provided as
- libvirt APIs</li>
- <li>the API should allow to do efficiently and cleanly all the operations
- needed to manage domains on a node</li>
- <li>the API will not try to provide hight level multi-nodes management
+ libvirt APIs</li><li>the API should allow to do efficiently and cleanly all the operations
+ needed to manage domains on a node</li><li>the API will not try to provide hight level multi-nodes management
features like load balancing, though they could be implemented on top of
- libvirt</li>
- <li>stability of the API is a big concern, libvirt should isolate
+ libvirt</li><li>stability of the API is a big concern, libvirt should isolate
applications from the frequent changes expected at the lower level of the
- virtualization framework</li>
-
</ul><p>So libvirt should be a building block for higher level management tools
+ virtualization framework</li></ul>
+
<p>So libvirt should be a building block for higher level management tools
and for applications focusing on virtualization of a single node (the only
exception being domain migration between node capabilities which may need to
be added at the libvirt level). Where possible libvirt should be extendable
to be able to provide the same API for remote nodes, however this is not the
case at the moment, the code currently handle only local node accesses
-(extension for remote access support is being worked on, see <a href="bugs.html">the mailing list</a> discussions about it).</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+(extension for remote access support is being worked on, see <a href="bugs.html">the mailing list</a> discussions about it).</p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <span class="active">Architecture</span>
+ <ul class="l2"><li>
+ <a title="Managing virtual machines" class="inactive" href="archdomain.html">Domains</a>
+ </li><li>
+ <a title="Providing isolated networks and NAT based network connectivity" class="inactive" href="archnetwork.html">Network</a>
+ </li><li>
+ <a title="Managing storage pools and volumes" class="inactive" href="archstorage.html">Storage</a>
+ </li><li>
+ <a title="Enumerating host node devices" class="inactive" href="archnode.html">Node Devices</a>
+ </li></ul>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1>Architecture</h1>
+ <p>Libvirt is a C toolkit to interact with the virtualization capabilities of
+recent versions of Linux (and other OSes), but libvirt won't try to provide
+all possible interfaces for interacting with the virtualization features.</p>
+ <p>To avoid ambiguity about the terms used here here are the definitions for
+some of the specific concepts used in libvirt documentation:</p>
+ <ul>
+ <li>a <strong>node</strong> is a single physical machine</li>
+ <li>an <strong>hypervisor</strong> is a layer of software allowing to
+ virtualize a node in a set of virtual machines with possibly different
+ configurations than the node itself</li>
+ <li>a <strong>domain</strong> is an instance of an operating system running
+ on a virtualized machine provided by the hypervisor</li>
+ </ul>
+ <p class="image">
+ <img alt="Hypervisor and domains running on a node" src="node.gif"/>
+ </p>
+ <p>Now we can define the goal of libvirt: to provide the lowest possible
+generic and stable layer to manage domains on a node.</p>
+ <p>This implies the following:</p>
+ <ul>
+ <li>the API should not be targeted to a single virtualization environment
+ though Xen is the current default, which also means that some very
+ specific capabilities which are not generic enough may not be provided as
+ libvirt APIs</li>
+ <li>the API should allow to do efficiently and cleanly all the operations
+ needed to manage domains on a node</li>
+ <li>the API will not try to provide hight level multi-nodes management
+ features like load balancing, though they could be implemented on top of
+ libvirt</li>
+ <li>stability of the API is a big concern, libvirt should isolate
+ applications from the frequent changes expected at the lower level of the
+ virtualization framework</li>
+ </ul>
+ <p>So libvirt should be a building block for higher level management tools
+and for applications focusing on virtualization of a single node (the only
+exception being domain migration between node capabilities which may need to
+be added at the libvirt level). Where possible libvirt should be extendable
+to be able to provide the same API for remote nodes, however this is not the
+case at the moment, the code currently handle only local node accesses
+(extension for remote access support is being worked on, see <a href="bugs.html">the mailing list</a> discussions about it).</p>
+ </body>
+</html>
+++ /dev/null
-<html>
-<head>
- <meta http-equiv="Content-Type" content="">
- <title>Libvirt the virtualization API</title>
-</head>
-
-<body bgcolor="#ffffff">
-<h1 align="center">Libvirt the virtualization API</h1>
-
-<h1>Note: this is the flat content of the <a href="index.html">web
-site</a></h1>
-
-<h1 style="text-align: center">libvirt</h1>
-
-<h3>what is <span class="style1">libvirt?</span></h3>
-
-<p>Libvirt is a C toolkit to interact with the virtualization capabilities
-of recent versions of Linux (and other OSes). It is free software available
-under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
-Lesser General Public License</a>. Virtualization of the Linux Operating
-System means the ability to run multiple instances of Operating Systems
-concurrently on a single hardware system where the basic resources are driven
-by a Linux (or Solaris) instance. The library aims at providing a long term
-stable C API initially for <a
-href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen
-paravirtualization</a> but it can also integrate with other
-virtualization mechanisms. It currently also supports <a
-href="http://fabrice.bellard.free.fr/qemu/">QEMU</a>, <a
-href="http://kvm.qumranet.com/">KVM</a> and
-<a href="http://openvz.org/">OpenVZ</a>.</p>
-
-<h2><a name="News">Releases</a></h2>
-
-<p>Here is the list of official releases, however since it is early on in the
-development of libvirt, it is preferable when possible to just use the <a
-href="downloads.html">CVS version or snapshot</a>, contact the mailing list
-and check the <a href="ChangeLog.html">ChangeLog</a> to gauge progress.</p>
-
-
-
-<h3>0.4.2: Apr 8 2008</h3>
-<ul>
- <li>New features: memory operation for QEmu/KVM driver (Cole Robinson),
- new routed networking schemas (Mads Olesen)</li>
- <li>Documentation: storage documentation fixes (Atsushi Sakai), many
- typo cleanups (Atsushi Sakai), string fixes (Francesco Tombolini)</li>
- <li>Bug fixes: pointer errors in qemu (Jim Meyering), iSCSI login fix
- (Chris Lalancette), well formedness error in test driver capabilities
- (Cole Robinson), fixes cleanup code when daemon exits (Daniel Berrange),
- CD Rom change on live QEmu/KVM domains (Cole Robinson), setting scheduler
- parameter is forbidden for read-only (Saori Fukuta)i, fixes for TAP
- devices (Daniel Berrange), assorted storage driver fixes (Daniel
- Berrange), Makefile fixes (Jim Meyering), Xen-3.2 hypercall fix,
- fix iptables rules to avoid blocking traffic within virtual network
- (Daniel Berrange), XML output fix for directory pools (Daniel Berrange),
- remove dandling domain/net/conn pointers from error data, do not
- ask polkit auth when root (Daniel Berrange), handling of fork and
- pipe errors when starting the daemon (Richard Jones)</li>
- <li>Improvements: better validation of MAC addresses (Jim Meyering and
- Hiroyuki Kaguchi),
- virsh vcpupin error report (Shigeki Sakamoto), keep boot tag on
- HVM domains (Cole Robinson), virsh non-root should not be limited to read
- only anymore (Daniel Berrange), switch to polkit-auth from polkit-grant
- (Daniel Berrange), better handling of missing SElinux data (Daniel
- Berrange and Jim Meyering), cleanup of the connection opening logic
- (Daniel Berrange), first bits of Linux Containers support (Dave Leskovec),
- scheduler API support via xend (Saori Fukuta), improvement of the
- testing framework and first tests (Jim Meyering), missing error
- messages from virsh parameters validation (Shigeki Sakamoto),
- improve support of older iscsiadm command (Chris Lalancette),
- move linux container support in the daemon (Dan Berrange), older
- awk implementation support (Mike Gerdts), NUMA support in test
- driver (Cole Robinson), xen and hvm added to test driver capabilities
- (Cole Robinson)</li>
- <li>Code cleanup: remove unused getopt header (Jim Meyering), mark more
- strings as translatable (Guido Günther and Jim Meyering), convert
- error strings to something meaningful and translatable (Jim Meyering),
- Linux Containers code cleanup, last error initializer (Guido Günther)</li>
-</ul>
-<h3>0.4.1: Mar 3 2008</h3>
-<ul>
- <li>New features: build on MacOSX (Richard Jones), storage management
- (Daniel Berrange), Xenner - Xen on KVM - support (Daniel Berrange)</li>
- <li>Documentation: Fix of various typos (Atsushi SAKAI), memory and
- vcpu settings details (Richard Jones), ethernet bridging typo
- (Maxwell Bottiger), add storage APIs documentation (Daniel Berrange)</li>
- <li>Bug fixes: OpenVZ code compilation (Mikhail Pokidko), crash in
- policykit auth handling (Daniel Berrange), large config files
- (Daniel Berrange), cpumap hypercall size (Saori Fukuta), crash
- in remote auth (Daniel Berrange), ssh args error (Daniel Berrange),
- preserve vif order from config files (Hiroyuki Kaguchi), invalid
- pointer access (Jim Meyering), virDomainGetXMLDesc flag handling,
- device name conversion on stats (Daniel Berrange), double mutex lock
- (Daniel Berrange), config file reading crashes (Guido Guenther),
- xenUnifiedDomainSuspend bug (Marcus Meissner), do not crash if
- /sys/hypervisor/capabilities is missing (Mark McLoughlin),
- virHashRemoveSet bug (Hiroyuki Kaguchi), close-on-exec flag for
- qemud signal pipe (Daniel Berrange), double free in OpenVZ
- (Anton Protopopov), handle mac without addresses (Shigeki Sakamoto),
- MAC addresses checks (Shigeki Sakamoto and Richard Jones),
- allow to read non-seekable files (Jim Meyering)</li>
- <li>Improvements: Windows build (Richard Jones), KVM/QEmu shutdown
- (Guido Guenther), catch virExec output on debug (Mark McLoughlin),
- integration of iptables and lokkit (Mark McLoughlin), keymap
- parameter for VNC servers (Daniel Hokka Zakrisson), enable debug
- by default using VIR_DEBUG (Daniel Berrange), xen 3.2 fixes
- (Daniel Berrange), Python bindings for VCPU and scheduling
- (Daniel Berrange), framework for automatic code syntax checks
- (Jim Meyering), allow kernel+initrd setup in Xen PV (Daniel Berrange),
- allow change of Disk/NIC of an inactive domains (Shigeki Sakamoto),
- virsh commands to manipulate and create storage(Daniel Berrange),
- update use of PolicyKit APIs, better detection of fedault hypervisor,
- block device statistics for QEmu/KVM (Richard Jones), various improvements
- for Xenner (Daniel Berrange)</li>
- <li>Code cleanups: avoid warnings (Daniel Berrange), virRun helper
- function (Dan Berrange), iptable code fixes (Mark McLoughlin),
- static and const cleanups (Jim Meyering), malloc and python cleanups
- (Jim Meyering), xstrtol_ull and xstrtol_ll functions (Daniel Berrange),
- remove no-op networking from OpenVZ (Daniel Berrange), python generator
- cleanups (Daniel Berrange), cleanup ref counting (Daniel Berrange),
- remove uninitialized warnings (Jim Meyering), cleanup configure
- for RHEL4 (Daniel Berrange), CR/LF cleanups (Richard Jones),
- various automatic code check and associated cleanups (Jim Meyering),
- various memory leaks (Jim Meyering), fix compilation when building
- without Xen (Guido Guenther), mark translatables strings (Jim Meyering),
- use virBufferAddLit for constant strings (Jim Meyering), fix
- make distcheck (Jim Meyering), return values for python bindings (Cole
- Robinson), trailing blanks fixes (Jim Meyering), gcc-4.3.0 fixes
- (Mark McLoughlin), use safe read and write routines (Jim Meyering),
- refactoring of code dealing with hypervisor capabilities (Daniel
- Berrange), qemudReportError to use virErrorMsg (Cole Robinson),
- intemediate library and Makefiles for compiling static and coverage
- rule support (Jim Meyering), cleanup of various leaks (Jim Meyering)</li>
-</ul>
-
-<h3>0.4.0: Dec 18 2007</h3>
-<ul>
- <li>New features: Compilation on Windows cygwin/mingw (Richard Jones),
- Ruby bindings (David Lutterkort), SASL based authentication for
- libvirt remote support (Daniel Berrange), PolicyKit authentication
- (Daniel Berrange)</li>
- <li>Documentation: example files for QEMU and libvirtd configuations
- (Daniel Berrange), english cleanups (Jim Paris), CIM and OpenVZ
- references, document <shareable/>, daemon startup when using
- QEMU/KVM, document HV support for new NUMA calls (Richard Jones),
- various english fixes (Bruce Montague), OCaml docs links (Richard Jones),
- describe the various bindings add Ruby link, Windows support page
- (Richard Jones), authentication documentation updates (Daniel Berrange)
- </li>
- <li>Bug fixes: NUMA topology error handling (Beth Kon), NUMA topology
- cells without CPU (Beth Kon), XML to/from XM bridge config (Daniel
- Berrange), XM processing of vnc parameters (Daniel Berrange), Reset
- migration source after failure (Jim Paris), negative integer in config
- (Tatsuro Enokura), zero terminating string buffer, detect integer
- overflow (Jim Meyering), QEmu command line ending fixes (Daniel Berrange),
- recursion problem in the daemon (Daniel Berrange), HVM domain with CDRom
- (Masayuki Sunou), off by one error in NUMA cpu count (Beth Kon),
- avoid xend errors when adding disks (Masayuki Sunou), compile error
- (Chris Lalancette), transposed fwrite args (Jim Meyering), compile
- without xen and on solaris (Jim Paris), parsing of interface names
- (Richard Jones), overflow for starts on 32bits (Daniel Berrange),
- fix problems in error reporting (Saori Fukuta), wrong call to
- brSetForwardDelay changed to brSetEnableSTP (Richard Jones),
- allow shareable disk in old Xen, fix wrong certificate file (Jim
- Meyering), avoid some startup error when non-root, off-by-1 buffer
- NULL termination (Daniel Berrange), various string allocation fixes
- (Daniel Berrange), avoid problems with vnetXXX interfaces in domain dumps
- (Daniel Berrange), build fixes for RHEL (Daniel Berrange), virsh prompt
- should not depend on uid (Richard Jones), fix scaping of '<' (Richard
- Jones), fix detach-disk on Xen tap devices (Saori Fukuta), CPU
- parameter setting in XM config (Saori Fukuta), credential handling
- fixes (Daniel Berrange), fix compatibility with Xen 3.2.0 (Daniel
- Berrange)
- </li>
- <li>Improvements: /etc/libvirt/qemu.conf configuration for QEMU driver
- (Daniel Berrange), NUMA cpu pinning in config files (DV and Saori Fukuta),
- CDRom media change in KVM/QEMU (Daniel Berrange), tests for
- <shareable/> in configs, pinning inactive domains for Xen 3.0.3
- (Saori Fukuta), use gnulib for portability enhancement (Jim Meyering),
- --without-libvirtd config option (Richard Jones), Python bindings for
- NUMA, add extra utility functions to buffer (Richard Jones),
- separate qparams module for handling query parameters (Richard Jones)
- </li>
- <li>Code cleanups: remove virDomainRestart from API as it was never used
- (Richard Jones), constify params for attach/detach APIs (Daniel Berrange),
- gcc printf attribute checkings (Jim Meyering), refactoring of device
- parsing code and shell escaping (Daniel Berrange), virsh schedinfo
- parameters validation (Masayuki Sunou), Avoid risk of format string abuse
- (Jim Meyering), integer parsing cleanups (Jim Meyering), build out
- of the source tree (Jim Meyering), URI parsing refactoring (Richard
- Jones), failed strdup/malloc handling (Jim Meyering), Make "make
- distcheck" work (Jim Meyering), improve xen internall error reports
- (Richard Jones), cleanup of the daemon remote code (Daniel Berrange),
- rename error VIR_FROM_LINUX to VIR_FROM_STATS_LINUX (Richard Jones),
- don't compile the proxy if without Xen (Richard Jones), fix paths when
- configuring for /usr prefix, improve error reporting code (Jim Meyering),
- detect heap allocation failure (Jim Meyering), disable xen sexpr parsing
- code if Xen is disabled (Daniel Berrange), cleanup of the GetType
- entry point for Xen drivers, move some QEmu path handling to generic
- module (Daniel Berrange), many code cleanups related to the Windows
- port (Richard Jones), disable the proxy if using PolicyKit, readline
- availability detection, test libvirtd's config-processing code (Jim
- Meyering), use a variable name as sizeof argument (Jim Meyering)
- </li>
-</ul>
-
-<h3>0.3.3: Sep 30 2007</h3>
-<ul>
- <li>New features: Avahi mDNS daemon export (Daniel Berrange),
- NUMA support (Beth Kan) </li>
- <li>Documentation: cleanups (Toth Istvan), typos (Eduardo Pereira), </li>
- <li>Bug fixes: memory corruption on large dumps (Masayuki Sunou), fix
- virsh vncdisplay command exit (Masayuki Sunou), Fix network stats
- TX/RX result (Richard Jones), warning on Xen 3.0.3 (Richard Jones),
- missing buffer check in virDomainXMLDevID (Hugh Brock), avoid zombies
- when using remote (Daniel Berrange), xend connection error message
- (Richard Jones), avoid ssh tty prompt (Daniel Berrange), username
- handling for remote URIs (Fabian Deutsch), fix potential crash
- on multiple input XML tags (Daniel Berrange), Solaris Xen hypercalls
- fixup (Mark Johnson)</li>
- <li>Improvements: OpenVZ support (Shuveb Hussain and Anoop Cyriac),
- CD-Rom reload on XEn (Hugh Brock), PXE boot got QEmu/KVM (Daniel
- Berrange), QEmu socket permissions customization (Daniel Berrange),
- more QEmu support (Richard Jones), better path detection for qemu and
- dnsmasq (Richard Jones), QEmu flags are per-Domain (Daniel Berrange),
- virsh freecell command, Solaris portability fixes (Mark Johnson),
- default bootloader support (Daniel Berrange), new virNodeGetFreeMemory
- API, vncpasswd extraction in configuration files if secure (Mark
- Johnson and Daniel Berrange), Python bindings for block and interface
- statistics</li>
- <li>Code cleanups: virDrvOpenRemoteFlags definition (Richard Jones),
- configure tests and output (Daniel Berrange)</li>
-</ul>
-<h3>0.3.2: Aug 21 2007</h3>
-<ul>
- <li>New features: KVM migration and save/restore (Jim Paris),
- added API for migration (Richard Jones), added APIs for block device and
- interface statistic (Richard Jones).</li>
- <li>Documentation: examples for XML network APIs,
- fix typo and schedinfo synopsis in man page (Atsushi SAKAI),
- hypervisor support page update (Richard Jones).</li>
- <li>Bug fixes: remove a couple of leaks in QEmu/KVM backend(Daniel berrange),
- fix GnuTLS 1.0 compatibility (Richard Jones), --config/-f option
- mistake for libvirtd (Richard Jones), remove leak in QEmu backend
- (Jim Paris), fix some QEmu communication bugs (Jim Paris), UUID
- lookup though proxy fix, setvcpus checking bugs (with Atsushi SAKAI),
- int checking in virsh parameters (with Masayuki Sunou), deny devices
- attach/detach for < Xen 3.0.4 (Masayuki Sunou), XenStore query
- memory leak (Masayuki Sunou), virsh schedinfo cleanup (Saori Fukuta).</li>
- <li>Improvement: virsh new ttyconsole command, networking API implementation
- for test driver (Daniel berrange), qemu/kvm feature reporting of
- ACPI/APIC (David Lutterkort), checking of QEmu architectures (Daniel
- berrange), improve devices XML errors reporting (Masayuki Sunou),
- speedup of domain queries on Xen (Daniel berrange), augment XML dumps
- with interface devices names (Richard Jones), internal API to query
- drivers for features (Richard Jones).
- </li>
- <li>Cleanups: Improve virNodeGetInfo implentation (Daniel berrange),
- general UUID code cleanup (Daniel berrange), fix API generator
- file selection. </li>
-</ul>
-
-<h3>0.3.1: Jul 24 2007</h3>
-<ul>
- <li>Documentation: index to remote page, script to test certificates,
- IPv6 remote support docs (Daniel Berrange), document
- VIRSH_DEFAULT_CONNECT_URI in virsh man page (David Lutterkort),
- Relax-NG early grammar for the network XML (David Lutterkort)</li>
- <li>Bug fixes: leaks in disk XML parsing (Masayuki Sunou), hypervisor
- alignment call problems on PPC64 (Christian Ehrhardt), dead client
- registration in daemon event loop (Daniel Berrange), double free
- in error handling (Daniel Berrange), close on exec for log file
- descriptors in the daemon (Daniel Berrange), avoid caching problem
- in remote daemon (Daniel Berrange), avoid crash after QEmu domain
- failure (Daniel Berrange)</li>
- <li>Improvements: checks of x509 certificates and keys (Daniel Berrange),
- error reports in the daemon (Daniel Berrange), checking of Ethernet MAC
- addresses in XML configs (Masayuki Sunou), support for a new
- clock switch between UTC and localtime (Daniel Berrange), early
- version of OpenVZ support (Shuveb Hussain), support for input devices
- on PS/2 and USB buses (Daniel Berrange), more tests especially
- the QEmu support (Daniel Berrange), range check in credit scheduler
- (with Saori Fukuta and Atsushi Sakai), add support for listen VNC
- parameter un QEmu and fix command line arg (Daniel Berrange)</li>
- <li>Cleanups: debug tracing (Richard Jones), removal of --with-qemud-pid-file
- (Richard Jones), remove unused virDeviceMode, new util module for
- code shared between drivers (Shuveb Hussain), xen header location
- detection (Richard Jones)</li>
-</ul>
-<h3>0.3.0: Jul 9 2007</h3>
-<ul>
- <li>Secure Remote support (Richard Jones).
- See <a href="http://libvirt.org/remote.html">the remote page</a>
- of the documentation
- <li>Documentation: remote support (Richard Jones), description of
- the URI connection strings (Richard Jones), update of virsh man
- page, matrix of libvirt API/hypervisor support with version
- information (Richard Jones)</li>
- <li>Bug fixes: examples Makefile.am generation (Richard Jones),
- SetMem fix (Mark Johnson), URI handling and ordering of
- drivers (Daniel Berrange), fix virsh help without hypervisor (Richard
- Jones), id marshalling fix (Daniel Berrange), fix virConnectGetMaxVcpus
- on remote (Richard Jones), avoid a realloc leak (Jim Meyering), scheduler
- parameters handling for Xen (Richard Jones), various early remote
- bug fixes (Richard Jones), remove virsh leaks of domains references
- (Masayuki Sunou), configCache refill bug (Richard Jones), fix
- XML serialization bugs</li>
- <li>Improvements: QEmu switch to XDR-based protocol (Dan Berrange),
- device attach/detach commands (Masayuki Sunou), OCaml bindings
- (Richard Jones), new entry points virDomainGetConnect and
- virNetworkGetConnect useful for bindings (Richard Jones),
- reunitifaction of remote and qemu daemon under a single libvirtd
- with a config file (Daniel Berrange)</li>
- <li>Cleanups: parsing of connection URIs (Richard Jones), messages
- from virsh (Saori Fukuta), Coverage files (Daniel Berrange),
- Solaris fixes (Mark Johnson), avoid [r]index calls (Richard Jones),
- release information in Xen backend, virsh cpupin command cleanups
- (Masayuki Sunou), xen:/// suppport as standard Xen URI (Richard Jones and
- Daniel Berrange), improve driver selection/decline mechanism (Richard
- Jones), error reporting on XML dump (Richard Jones), Remove unused
- virDomainKernel structure (Richard Jones), daemon event loop event
- handling (Daniel Berrange), various unifications cleanup in the daemon
- merging (Daniel Berrange), internal file and timer monitoring API
- (Daniel Berrange), remove libsysfs dependancy, call brctl program
- directly (Daniel Berrange), virBuffer functions cleanups (Richard Jones),
- make init script LSB compliant, error handling on lookup functions
- (Richard Jones), remove internal virGetDomainByID (Richard Jones),
- revamp of xen subdrivers interfaces (Richard Jones)</li>
- <li>Localization updates</li>
-</ul>
-<h3>0.2.3: Jun 8 2007</h3>
-<ul>
- <li>Documentation: documentation for upcoming remote access (Richard Jones),
- virConnectNumOfDefinedDomains doc (Jan Michael), virsh help messages
- for dumpxml and net-dumpxml (Chris Wright), </li>
- <li>Bug fixes: RelaxNG schemas regexp fix (Robin Green), RelaxNG arch bug
- (Mark McLoughlin), large buffers bug fixes (Shigeki Sakamoto), error
- on out of memory condition (Shigeki Sakamoto), virshStrdup fix, non-root
- driver when using Xen bug (Richard Jones), use --strict-order when
- running dnsmasq (Daniel Berrange), virbr0 weirdness on restart (Mark
- McLoughlin), keep connection error messages (Richard Jones), increase
- QEmu read buffer on help (Daniel Berrange), rpm dependance on
- dnsmasq (Daniel Berrange), fix XML boot device syntax (Daniel Berrange),
- QEmu memory bug (Daniel Berrange), memory leak fix (Masayuki Sunou),
- fix compiler flags (Richard Jones), remove type ioemu on recent Xen
- HVM for paravirt drivers (Saori Fukuta), uninitialized string bug
- (Masayuki Sunou), allow init even if the daemon is not running,
- XML to config fix (Daniel Berrange)</li>
- <li>Improvements: add a special error class for the test module (Richard
- Jones), virConnectGetCapabilities on proxy (Richard Jones), allow
- network driver to decline usage (Richard Jones), extend error messages
- for upcoming remote access (Richard Jones), on_reboot support for QEmu
- (Daniel Berrange), save daemon output in a log file (Daniel Berrange),
- xenXMDomainDefineXML can override guest config (Hugh Brock),
- add attach-device and detach-device commands to virsh (Masayuki Sunou
- and Mark McLoughlin and Richard Jones), make virGetVersion case
- insensitive and Python bindings (Richard Jones), new scheduler API
- (Atsushi SAKAI), localizations updates, add logging option for virsh
- (Nobuhiro Itou), allow arguments to be passed to bootloader (Hugh Brock),
- increase the test suite (Daniel Berrange and Hugh Brock)</li>
- <li>Cleanups: Remove VIR_DRV_OPEN_QUIET (Richard Jones), disable xm_internal.c
- for Xen > 3.0.3 (Daniel Berrange), unused fields in _virDomain (Richard
- Jones), export __virGetDomain and __virGetNetwork for libvirtd only
- (Richard Jones), ignore old VNC config for HVM on recent Xen (Daniel
- Berrange), various code cleanups, -Werror cleanup (Hugh Brock)</li>
-</ul>
-<h3>0.2.2: Apr 17 2007</h3>
-<ul>
- <li>Documentation: fix errors due to Amaya (with Simon Hernandez),
- virsh uses kB not bytes (Atsushi SAKAI), add command line help to
- qemud (Richard Jones), xenUnifiedRegister docs (Atsushi SAKAI),
- strings typos (Nikolay Sivov), ilocalization probalem raised by
- Thomas Canniot</li>
- <li>Bug fixes: virsh memory values test (Masayuki Sunou), operations without
- libvirt_qemud (Atsushi SAKAI), fix spec file (Florian La Roche, Jeremy
- Katz, Michael Schwendt),
- direct hypervisor call (Atsushi SAKAI), buffer overflow on qemu
- networking command (Daniel Berrange), buffer overflow in quemud (Daniel
- Berrange), virsh vcpupin bug (Masayuki Sunou), host PAE detections
- and strcuctures size (Richard Jones), Xen PAE flag handling (Daniel
- Berrange), bridged config configuration (Daniel Berrange), erroneous
- XEN_V2_OP_SETMAXMEM value (Masayuki Sunou), memory free error (Mark
- McLoughlin), set VIR_CONNECT_RO on read-only connections (S.Sakamoto),
- avoid memory explosion bug (Daniel Berrange), integer overflow
- for qemu CPU time (Daniel Berrange), QEMU binary path check (Daniel
- Berrange)</li>
- <li>Cleanups: remove some global variables (Jim Meyering), printf-style
- functions checks (Jim Meyering), better virsh error messages, increase
- compiler checkings and security (Daniel Berrange), virBufferGrow usage
- and docs, use calloc instead of malloc/memset, replace all sprintf by
- snprintf, avoid configure clobbering user's CTAGS (Jim Meyering),
- signal handler error cleanup (Richard Jones), iptables internal code
- claenup (Mark McLoughlin), unified Xen driver (Richard Jones),
- cleanup XPath libxml2 calls, IPTables rules tightening (Daniel
- Berrange), </li>
- <li>Improvements: more regression tests on XML (Daniel Berrange), Python
- bindings now generate exception in error cases (Richard Jones),
- Python bindings for vir*GetAutoStart (Daniel Berrange),
- handling of CD-Rom device without device name (Nobuhiro Itou),
- fix hypervisor call to work with Xen 3.0.5 (Daniel Berrange),
- DomainGetOSType for inactive domains (Daniel Berrange), multiple boot
- devices for HVM (Daniel Berrange),
- </li>
-</ul>
-<h3>0.2.1: Mar 16 2007</h3>
-<ul>
- <li>Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin)</li>
- <li>Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt
- config directory (Daniel Berrange and Mark McLoughlin), memory leak
- in qemud (Mark), various fixes on network support (Mark), avoid Xen
- domain zombies on device hotplug errors (Daniel Berrange), various
- fixes on qemud (Mark), args parsing (Richard Jones), virsh -t argument
- (Saori Fukuta), avoid virsh crash on TAB key (Daniel Berrange), detect
- xend operation failures (Kazuki Mizushima), don't listen on null socket
- (Rich Jones), read-only socket cleanup (Rich Jones), use of vnc port 5900
- (Nobuhiro Itou), assorted networking fixes (Daniel Berrange), shutoff and
- shutdown mismatches (Kazuki Mizushima), unlimited memory handling
- (Atsushi SAKAI), python binding fixes (Tatsuro Enokura)</li>
- <li>Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies
- and build (Daniel Berrange), fix xend port detection (Daniel
- Berrange), icompile time warnings (Mark), avoid const related
- compiler warnings (Daniel Berrange), automated builds (Daniel
- Berrange), pointer/int mismatch (Richard Jones), configure time
- selection of drivers, libvirt spec hacking (Daniel Berrange)</li>
- <li>Add support for network autostart and init scripts (Mark McLoughlin)</li>
- <li>New API virConnectGetCapabilities() to detect the virtualization
- capabilities of a host (Richard Jones)</li>
- <li>Minor improvements: qemud signal handling (Mark), don't shutdown or reboot
- domain0 (Kazuki Mizushima), QEmu version autodetection (Daniel Berrange),
- network UUIDs (Mark), speed up UUID domain lookups (Tatsuro Enokura and
- Daniel Berrange), support for paused QEmu CPU (Daniel Berrange), keymap
- VNC attribute support (Takahashi Tomohiro and Daniel Berrange), maximum
- number of virtual CPU (Masayuki Sunou), virtsh --readonly option (Rich
- Jones), python bindings for new functions (Daniel Berrange)</li>
- <li>Documentation updates especially on the XML formats</li>
-</ul>
-
-<h3>0.2.0: Feb 14 2007</h3>
-<ul>
- <li>Various internal cleanups (Mark McLoughlin, Richard Jones,
- Daniel Berrange, Karel Zak)</li>
- <li>Bug fixes: avoid a crash in connect (Daniel Berrange), virsh args
- parsing (Richard Jones)</li>
- <li>Add support for QEmu and KVM virtualization (Daniel Berrange)</li>
- <li>Add support for network configuration (Mark McLoughlin)</li>
- <li>Minor improvements: regression testing (Daniel Berrange),
- localization string updates</li>
-</ul>
-
-<h3>0.1.11: Jan 22 2007</h3>
-<ul>
- <li>Finish XML <-> XM config files support</li>
- <li>Remove memory leak when freeing virConf objects</li>
- <li>Finishing inactive domain support (Daniel Berrange)</li>
- <li>Added a Relax-NG schemas to check XML instances</li>
-</ul>
-
-<h3>0.1.10: Dec 20 2006</h3>
-<ul>
- <li>more localizations</li>
- <li>bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains buffer overflow (Daniel Berrange), reference count bug when creating Xen domains (Daniel Berrange).</li>
- <li>improvements: support graphic framebuffer for Xen paravirt (Daniel Berrange), VNC listen IP range support (Daniel Berrange), support for default Xen config files and inactive domains of 3.0.4 (Daniel Berrange).</li>
-</ul>
-
-<h3>0.1.9: Nov 29 2006</h3>
-<ul>
- <li>python bindings: release interpeter lock when calling C (Daniel Berrange)</li>
- <li>don't raise HTTP error when looking information for a domain</li>
- <li>some refactoring to use the driver for all entry points</li>
- <li>better error reporting (Daniel Berrange)</li>
- <li>fix OS reporting when running as non-root</li>
- <li>provide XML parsing errors</li>
- <li>extension of the test framework (Daniel Berrange)</li>
- <li>fix the reconnect regression test</li>
- <li>python bindings: Domain instances now link to the Connect to avoid garbage collection and disconnect</li>
- <li>separate the notion of maximum memory and current use at the XML level</li>
- <li>Fix a memory leak (Daniel Berrange)</li>
- <li>add support for shareable drives</li>
- <li>add support for non-bridge style networking configs for guests(Daniel Berrange)</li>
- <li>python bindings: fix unsigned long marshalling (Daniel Berrange)</li>
- <li>new config APIs virConfNew() and virConfSetValue() to build configs from scratch</li>
- <li>hot plug device support based on Michel Ponceau patch</li>
- <li>added support for inactive domains, new APIs, various associated cleanup (Daniel Berrange)</li>
- <li>special device model for HVM guests (Daniel Berrange)</li>
- <li>add API to dump core of domains (but requires a patched xend)</li>
- <li>pygrub bootloader information take over <os> information</li>
- <li>updated the localization strings</li>
-</ul>
-<h3>0.1.8: Oct 16 2006</h3>
-<ul>
- <li> Bug for system with page size != 4k</li>
- <li> vcpu number initialization (Philippe Berthault)</li>
- <li> don't label crashed domains as shut off (Peter Vetere)</li>
- <li> fix virsh man page (Noriko Mizumoto)</li>
- <li> blktapdd support for alternate drivers like blktap (Daniel Berrange)</li>
- <li> memory leak fixes (xend interface and XML parsing) (Daniel Berrange)</li>
- <li> compile fix</li>
- <li> mlock/munlock size fixes (Daniel Berrange)</li>
- <li> improve error reporting</li>
-</ul>
-<h3>0.1.7: Sep 29 2006</h3>
-<ul>
- <li> fix a memory bug on getting vcpu information from xend (Daniel Berrange)</li>
- <li> fix another problem in the hypercalls change in Xen changeset
- 86d26e6ec89b when getting domain information (Daniel Berrange)</li>
-</ul>
-<h3>0.1.6: Sep 22 2006</h3>
-<ul>
- <li>Support for localization of strings using gettext (Daniel Berrange)</li>
- <li>Support for new Xen-3.0.3 cdrom and disk configuration (Daniel Berrange)</li>
- <li>Support for setting VNC port when creating domains with new
- xend config files (Daniel Berrange) </li>
- <li>Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig)</li>
- <li>Fix reconnection problem when talking directly to http xend</li>
-</ul>
-<h3>0.1.5: Sep 5 2006</h3>
-<ul>
- <li>Support for new hypercalls change in Xen changeset 86d26e6ec89b</li>
- <li>bug fixes: virParseUUID() was wrong, netwoking for paravirt guestsi
- (Daniel Berrange), virsh on non-existent domains (Daniel Berrange),
- string cast bug when handling error in python (Pete Vetere), HTTP
- 500 xend error code handling (Pete Vetere and Daniel Berrange)</li>
- <li>improvements: test suite for SEXPR <-> XML format conversions (Daniel
- Berrange), virsh output regression suite (Daniel Berrange), new environ
- variable VIRSH_DEFAULT_CONNECT_URI for the default URI when connecting
- (Daniel Berrange), graphical console support for paravirt guests
- (Jeremy Katz), parsing of simple Xen config files (with Daniel Berrange),
- early work on defined (not running) domains (Daniel Berrange),
- virsh output improvement (Daniel Berrange</li>
-</ul>
-
-<h3>0.1.4: Aug 16 2006</h3>
-<ul>
- <li>bug fixes: spec file fix (Mark McLoughlin), error report problem (with
- Hugh Brock), long integer in Python bindings (with Daniel Berrange), XML
- generation bug for CDRom (Daniel Berrange), bug whem using number() XPath
- function (Mark McLoughlin), fix python detection code, remove duplicate
- initialization errors (Daniel Berrange)</li>
- <li>improvements: UUID in XML description (Peter Vetere), proxy code
- cleanup, virtual CPU and affinity support + virsh support (Michel
- Ponceau, Philippe Berthault, Daniel Berrange), port and tty information
- for console in XML (Daniel Berrange), added XML dump to driver and proxy
- support (Daniel Berrange), extention of boot options with support for
- floppy and cdrom (Daniel Berrange), features block in XML to report/ask
- PAE, ACPI, APIC for HVM domains (Daniel Berrange), fail saide-effect
- operations when using read-only connection, large improvements to test
- driver (Daniel Berrange) </li>
- <li>documentation: spelling (Daniel Berrange), test driver examples.</li>
-</ul>
-
-<h3>0.1.3: Jul 11 2006</h3>
-<ul>
- <li>bugfixes: build as non-root, fix xend access when root, handling of
- empty XML elements (Mark McLoughlin), XML serialization and parsing fixes
- (Mark McLoughlin), allow to create domains without disk (Mark
- McLoughlin),</li>
- <li>improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel Berrange),
- support for fully virtualized guest (Jim Fehlig, DV, Mark McLoughlin)</li>
- <li>documentation: augmented to cover hvm domains</li>
-</ul>
-
-<h3>0.1.2: Jul 3 2006</h3>
-<ul>
- <li>headers include paths fixup</li>
- <li>proxy mechanism for unprivileged read-only access by httpu</li>
-</ul>
-
-<h3>0.1.1: Jun 21 2006</h3>
-<ul>
- <li>building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
- Berrange)</li>
- <li>driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
- Berrange)</li>
- <li>Cope with API change introduced in Xen changeset 10277</li>
- <li>new test driver for regression checks (Daniel P. Berrange)</li>
- <li>improvements: added UUID to XML serialization, buffer usage (Karel
- Zak), --connect argument to virsh (Daniel P. Berrange),</li>
- <li>bug fixes: uninitialized memory access in error reporting, S-Expr
- parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO in
- xs_internal.c</li>
- <li>documentation: Python examples (David Lutterkort), new Perl binding
- URL, man page update (Karel Zak)</li>
-</ul>
-
-<h3>0.1.0: Apr 10 2006</h3>
-<ul>
- <li>building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
- build and pkginfo cflag fix (Daniel Berrange)</li>
- <li>enhancement and fixes of the XML description format (David Lutterkort
- and Jim Fehlig)</li>
- <li>new APIs: for Node information and Reboot</li>
- <li>internal code cleanup: refactoring internals into a driver model, more
- error handling, structure sharing, thread safety and ref counting</li>
- <li>bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
- Meyering), virDomainLookupByID (Jim Fehlig),</li>
- <li>documentation: updates on architecture, and format, typo fix (Jim
- Meyering)</li>
- <li>bindings: exception handling in examples (Jim Meyering), perl ones out
- of tree (Daniel Berrange)</li>
- <li>virsh: more options, create, nodeinfo (Karel Zak), renaming of some
- options (Karel Zak), use stderr only for errors (Karel Zak), man page
- (Andrew Puch)</li>
-</ul>
-
-<h3>0.0.6: Feb 28 2006</h3>
-<ul>
- <li>add UUID lookup and extract API</li>
- <li>add error handling APIs both synchronous and asynchronous</li>
- <li>added minimal hook for error handling at the python level, improved the
- python bindings</li>
- <li>augment the documentation and tests to cover error handling</li>
-</ul>
-
-<h3>0.0.5: Feb 23 2006</h3>
-<ul>
- <li>Added XML description parsing, dependance to libxml2, implemented the
- creation API virDomainCreateLinux()</li>
- <li>new APIs to lookup and name domain by UUID</li>
- <li>fixed the XML dump when using the Xend access</li>
- <li>Fixed a few more problem related to the name change</li>
- <li>Adding regression tests in python and examples in C</li>
- <li>web site improvement, extended the documentation to cover the XML
- format and Python API</li>
- <li>Added devhelp help for Gnome/Gtk programmers</li>
-</ul>
-
-<h3>0.0.4: Feb 10 2006</h3>
-<ul>
- <li>Fix various bugs introduced in the name change</li>
-</ul>
-
-<h3>0.0.3: Feb 9 2006</h3>
-<ul>
- <li>Switch name from from 'libvir' to libvirt</li>
- <li>Starting infrastructure to add code examples</li>
- <li>Update of python bindings for completeness</li>
-</ul>
-
-<h3>0.0.2: Jan 29 2006</h3>
-<ul>
- <li>Update of the documentation, web site redesign (Diana Fong)</li>
- <li>integration of HTTP xend RPC based on libxend by Anthony Liquori for
- most operations</li>
- <li>Adding Save and Restore APIs</li>
- <li>extended the virsh command line tool (Karel Zak)</li>
- <li>remove xenstore transactions (Anthony Liguori)</li>
- <li>fix the Python bindings bug when domain and connections where freed</li>
-</ul>
-
-<h3>0.0.1: Dec 19 2005</h3>
-<ul>
- <li>First release</li>
- <li>Basic management of existing Xen domains</li>
- <li>Minimal autogenerated Python bindings</li>
-</ul>
-
-<h2><a name="Introducti">Introduction</a></h2>
-
-<p>Libvirt is a C toolkit to interact with the virtualization capabilities of
-recent versions of Linux (and other OSes), but libvirt won't try to provide
-all possible interfaces for interacting with the virtualization features.</p>
-
-<p>To avoid ambiguity about the terms used here here are the definitions for
-some of the specific concepts used in libvirt documentation:</p>
-<ul>
- <li>a <strong>node</strong> is a single physical machine</li>
- <li>an <strong>hypervisor</strong> is a layer of software allowing to
- virtualize a node in a set of virtual machines with possibly different
- configurations than the node itself</li>
- <li>a <strong>domain</strong> is an instance of an operating system running
- on a virtualized machine provided by the hypervisor</li>
-</ul>
-
-<p style="text-align: center"><img
-alt="Hypervisor and domains running on a node" src="node.gif"></p>
-
-<p>Now we can define the goal of libvirt: to provide the lowest possible
-generic and stable layer to manage domains on a node.</p>
-
-<p>This implies the following:</p>
-<ul>
- <li>the API should not be targeted to a single virtualization environment
- though Xen is the current default, which also means that some very
- specific capabilities which are not generic enough may not be provided as
- libvirt APIs</li>
- <li>the API should allow to do efficiently and cleanly all the operations
- needed to manage domains on a node</li>
- <li>the API will not try to provide hight level multi-nodes management
- features like load balancing, though they could be implemented on top of
- libvirt</li>
- <li>stability of the API is a big concern, libvirt should isolate
- applications from the frequent changes expected at the lower level of the
- virtualization framework</li>
-</ul>
-
-<p>So libvirt should be a building block for higher level management tools
-and for applications focusing on virtualization of a single node (the only
-exception being domain migration between node capabilities which may need to
-be added at the libvirt level). Where possible libvirt should be extendable
-to be able to provide the same API for remote nodes, however this is not the
-case at the moment, the code currently handle only local node accesses
-(extension for remote access support is being worked on, see <a
-href="bugs.html">the mailing list</a> discussions about it).</p>
-
-<h2><a name="architecture">libvirt architecture</a></h2>
-
-<p>Currently libvirt supports 2 kind of virtualization, and its
-internal structure is based on a driver model which simplifies adding new
-engines:</p>
-
-<ul>
- <li><a href="#Xen">Xen hypervisor</a></li>
- <li><a href="#QEmu">QEmu and KVM based virtualization</a></li>
- <li><a href="#drivers">the driver architecture</a></li>
-</ul>
-
-<h3><a name="Xen">Libvirt Xen support</a></h3>
-
-<p>When running in a Xen environment, programs using libvirt have to execute
-in "Domain 0", which is the primary Linux OS loaded on the machine. That OS
-kernel provides most if not all of the actual drivers used by the set of
-domains. It also runs the Xen Store, a database of information shared by the
-hypervisor, the kernels, the drivers and the xen daemon. Xend. The xen daemon
-supervise the control and execution of the sets of domains. The hypervisor,
-drivers, kernels and daemons communicate though a shared system bus
-implemented in the hypervisor. The figure below tries to provide a view of
-this environment:</p>
-<img src="architecture.gif" alt="The Xen architecture">
-
-<p>The library can be initialized in 2 ways depending on the level of
-privilege of the embedding program. If it runs with root access,
-virConnectOpen() can be used, it will use three different ways to connect to
-the Xen infrastructure:</p>
-<ul>
- <li>a connection to the Xen Daemon though an HTTP RPC layer</li>
- <li>a read/write connection to the Xen Store</li>
- <li>use Xen Hypervisor calls</li>
- <li>when used as non-root libvirt connect to a proxy daemon running
- as root and providing read-only support</li>
-</ul>
-
-<p>The library will usually interact with the Xen daemon for any operation
-changing the state of the system, but for performance and accuracy reasons
-may talk directly to the hypervisor when gathering state information at
-least when possible (i.e. when the running program using libvirt has root
-privilege access).</p>
-
-<p>If it runs without root access virConnectOpenReadOnly() should be used to
-connect to initialize the library. It will then fork a libvirt_proxy
-program running as root and providing read_only access to the API, this is
-then only useful for reporting and monitoring.</p>
-
-<h3><a name="QEmu">Libvirt QEmu and KVM support</a></h3>
-
-<p>The model for QEmu and KVM is completely similar, basically KVM is based
-on QEmu for the process controlling a new domain, only small details differs
-between the two. In both case the libvirt API is provided by a controlling
-process forked by libvirt in the background and which launch and control the
-QEmu or KVM process. That program called libvirt_qemud talks though a specific
-protocol to the library, and connects to the console of the QEmu process in
-order to control and report on its status. Libvirt tries to expose all the
-emulations models of QEmu, the selection is done when creating the new
-domain, by specifying the architecture and machine type targeted.</p>
-
-<p>The code controlling the QEmu process is available in the
-<code>qemud/</code> directory.</p>
-
-<h3><a name="drivers">the driver based architecture</a></h3>
-
-<p>As the previous section explains, libvirt can communicate using different
-channels with the current hypervisor, and should also be able to use
-different kind of hypervisor. To simplify the internal design, code, ease
-maintenance and simplify the support of other virtualization engine the
-internals have been structured as one core component, the libvirt.c module
-acting as a front-end for the library API and a set of hypervisor drivers
-defining a common set of routines. That way the Xen Daemon access, the Xen
-Store one, the Hypervisor hypercall are all isolated in separate C modules
-implementing at least a subset of the common operations defined by the
-drivers present in driver.h:</p>
-<ul>
- <li>xend_internal: implements the driver functions though the Xen
- Daemon</li>
- <li>xs_internal: implements the subset of the driver available though the
- Xen Store</li>
- <li>xen_internal: provide the implementation of the functions possible via
- direct hypervisor access</li>
- <li>proxy_internal: provide read-only Xen access via a proxy, the proxy code
- is in the <code>proxy/</code>directory.</li>
- <li>xm_internal: provide support for Xen defined but not running
- domains.</li>
- <li>qemu_internal: implement the driver functions for QEmu and
- KVM virtualization engines. It also uses a qemud/ specific daemon
- which interacts with the QEmu process to implement libvirt API.</li>
- <li>test: this is a test driver useful for regression tests of the
- front-end part of libvirt.</li>
-</ul>
-
-<p>Note that a given driver may only implement a subset of those functions,
-(for example saving a Xen domain state to disk and restoring it is only
-possible though the Xen Daemon), in that case the driver entry points for
-unsupported functions are initialized to NULL.</p>
-
-<p></p>
-
-<h2><a name="Downloads">Downloads</a></h2>
-
-<p>The latest versions of libvirt can be found on the <a
-href="ftp://libvirt.org/libvirt/">libvirt.org</a> server ( <a
-href="http://libvirt.org/sources/">HTTP</a>, <a
-href="ftp://libvirt.org/libvirt/">FTP</a>). You will find there the released
-versions as well as <a
-href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">snapshot
-tarballs</a> updated from CVS head every hour</p>
-
-<p>Anonymous <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a> is also
-available, first register onto the server:</p>
-
-<p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login</code></p>
-
-<p>it will request a password, enter <strong>anoncvs</strong>. Then you can
-checkout the development tree with:</p>
-
-<p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co
-libvirt</code></p>
-
-<p>Use ./autogen.sh to configure the local checkout, then <code>make</code>
-and <code>make install</code>, as usual. All normal cvs commands are now
-available except commiting to the base.</p>
-
-<h2><a name="Format">XML Format</a></h2>
-
-<p>This section describes the XML format used to represent domains, there are
-variations on the format based on the kind of domains run and the options
-used to launch them:</p>
-
-<ul>
- <li><a href="#Normal1">Normal paravirtualized Xen domains</a></li>
- <li><a href="#Fully1">Fully virtualized Xen domains</a></li>
- <li><a href="#KVM1">KVM domains</a></li>
- <li><a href="#Net1">Networking options for QEmu and KVM</a></li>
- <li><a href="#QEmu1">QEmu domains</a></li>
- <li><a href="#Capa1">Discovering virtualization capabilities</a></li>
-</ul>
-
-<p>The formats try as much as possible to follow the same structure and reuse
-elements and attributes where it makes sense.</p>
-
-<h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized Xen
-guests</a>:</h3>
-
-<p>The library use an XML format to describe domains, as input to <a
-href="html/libvirt-libvirt.html#virDomainCreateLinux">virDomainCreateLinux()</a>
-and as the output of <a
-href="html/libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc()</a>,
-the following is an example of the format as returned by the shell command
-<code>virsh xmldump fc4</code> , where fc4 was one of the running domains:</p>
-<pre><domain type='xen' <span style="color: #0071FF; background-color: #FFFFFF">id='18'</span>>
- <name>fc4</name>
- <span style="color: #00B200; background-color: #FFFFFF"><os>
- <type>linux</type>
- <kernel>/boot/vmlinuz-2.6.15-1.43_FC5guest</kernel>
- <initrd>/boot/initrd-2.6.15-1.43_FC5guest.img</initrd>
- <root>/dev/sda1</root>
- <cmdline> ro selinux=0 3</cmdline>
- </os></span>
- <memory>131072</memory>
- <vcpu>1</vcpu>
- <devices>
- <span style="color: #FF0080; background-color: #FFFFFF"><disk type='file'>
- <source file='/u/fc4.img'/>
- <target dev='sda1'/>
- </disk></span>
- <span style="color: #0000FF; background-color: #FFFFFF"><interface type='bridge'>
- <source bridge='xenbr0'/>
- <mac address='</span><span style="color: #0000FF; background-color: #FFFFFF"></span><span style="color: #0000FF; background-color: #FFFFFF">aa:00:00:00:00:11'/>
- <script path='/etc/xen/scripts/vif-bridge'/>
- </interface></span>
- <span style="color: #FF8000; background-color: #FFFFFF"><console tty='/dev/pts/5'/></span>
- </devices>
-</domain></pre>
-
-<p>The root element must be called <code>domain</code> with no namespace, the
-<code>type</code> attribute indicates the kind of hypervisor used, 'xen' is
-the default value. The <code>id</code> attribute gives the domain id at
-runtime (not however that this may change, for example if the domain is saved
-to disk and restored). The domain has a few children whose order is not
-significant:</p>
-<ul>
- <li>name: the domain name, preferably ASCII based</li>
- <li>memory: the maximum memory allocated to the domain in kilobytes</li>
- <li>vcpu: the number of virtual cpu configured for the domain</li>
- <li>os: a block describing the Operating System, its content will be
- dependent on the OS type
- <ul>
- <li>type: indicate the OS type, always linux at this point</li>
- <li>kernel: path to the kernel on the Domain 0 filesystem</li>
- <li>initrd: an optional path for the init ramdisk on the Domain 0
- filesystem</li>
- <li>cmdline: optional command line to the kernel</li>
- <li>root: the root filesystem from the guest viewpoint, it may be
- passed as part of the cmdline content too</li>
- </ul>
- </li>
- <li>devices: a list of <code>disk</code>, <code>interface</code> and
- <code>console</code> descriptions in no special order</li>
-</ul>
-
-<p>The format of the devices and their type may grow over time, but the
-following should be sufficient for basic use:</p>
-
-<p>A <code>disk</code> device indicates a block device, it can have two
-values for the type attribute either 'file' or 'block' corresponding to the 2
-options available at the Xen layer. It has two mandatory children, and one
-optional one in no specific order:</p>
-<ul>
- <li>source with a file attribute containing the path in Domain 0 to the
- file or a dev attribute if using a block device, containing the device
- name ('hda5' or '/dev/hda5')</li>
- <li>target indicates in a dev attribute the device where it is mapped in
- the guest</li>
- <li>readonly an optional empty element indicating the device is
- read-only</li>
- <li>shareable an optional empty element indicating the device
- can be used read/write with other domains</li>
-</ul>
-
-<p>An <code>interface</code> element describes a network device mapped on the
-guest, it also has a type whose value is currently 'bridge', it also have a
-number of children in no specific order:</p>
-<ul>
- <li>source: indicating the bridge name</li>
- <li>mac: the optional mac address provided in the address attribute</li>
- <li>ip: the optional IP address provided in the address attribute</li>
- <li>script: the script used to bridge the interface in the Domain 0</li>
- <li>target: and optional target indicating the device name.</li>
-</ul>
-
-<p>A <code>console</code> element describes a serial console connection to
-the guest. It has no children, and a single attribute <code>tty</code> which
-provides the path to the Pseudo TTY on which the guest console can be
-accessed</p>
-
-<p>Life cycle actions for the domain can also be expressed in the XML format,
-they drive what should be happening if the domain crashes, is rebooted or is
-poweroff. There is various actions possible when this happen:</p>
-<ul>
- <li>destroy: The domain is cleaned up (that's the default normal processing
- in Xen)</li>
- <li>restart: A new domain is started in place of the old one with the same
- configuration parameters</li>
- <li>preserve: The domain will remain in memory until it is destroyed
- manually, it won't be running but allows for post-mortem debugging</li>
- <li>rename-restart: a variant of the previous one but where the old domain
- is renamed before being saved to allow a restart</li>
-</ul>
-
-<p>The following could be used for a Xen production system:</p>
-<pre><domain>
- ...
- <on_reboot>restart</on_reboot>
- <on_poweroff>destroy</on_poweroff>
- <on_crash>rename-restart</on_crash>
- ...
-</domain></pre>
-
-<p>While the format may be extended in various ways as support for more
-hypervisor types and features are added, it is expected that this core subset
-will remain functional in spite of the evolution of the library.</p>
-
-<h3 id="Fully"><a name="Fully1" id="Fully1">Fully virtualized guests</a>
-(added in 0.1.3):</h3>
-
-<p>Here is an example of a domain description used to start a fully
-virtualized (a.k.a. HVM) Xen domain. This requires hardware virtualization
-support at the processor level but allows to run unmodified operating
-systems:</p>
-<pre><domain type='xen' id='3'>
- <name>fv0</name>
- <uuid>4dea22b31d52d8f32516782e98ab3fa0</uuid>
- <os>
- <span style="color: #0000E5; background-color: #FFFFFF"><type>hvm</type></span>
- <span style="color: #0000E5; background-color: #FFFFFF"><loader>/usr/lib/xen/boot/hvmloader</loader></span>
- <span style="color: #0000E5; background-color: #FFFFFF"><boot dev='hd'/></span>
- </os>
- <memory>524288</memory>
- <vcpu>1</vcpu>
- <on_poweroff>destroy</on_poweroff>
- <on_reboot>restart</on_reboot>
- <on_crash>restart</on_crash>
- <features>
- <span style="color: #E50000; background-color: #FFFFFF"><pae/>
- <acpi/>
- <apic/></span>
- </features>
- <span style="color: #0000E5; background-color: #FFFFFF"><clock sync="localtime"/></span>
- <devices>
- <span style="color: #0000E5; background-color: #FFFFFF"><emulator>/usr/lib/xen/bin/qemu-dm</emulator></span>
- <interface type='bridge'>
- <source bridge='xenbr0'/>
- <mac address='00:16:3e:5d:c7:9e'/>
- <script path='vif-bridge'/>
- </interface>
- <disk type='file'>
- <source file='/root/fv0'/>
- <target <span style="color: #0000E5; background-color: #FFFFFF">dev='hda'</span>/>
- </disk>
- <disk type='file' <span style="color: #0000E5; background-color: #FFFFFF">device='cdrom'</span>>
- <source file='/root/fc5-x86_64-boot.iso'/>
- <target <span style="color: #0000E5; background-color: #FFFFFF">dev='hdc'</span>/>
- <readonly/>
- </disk>
- <disk type='file' <span style="color: #0000E5; background-color: #FFFFFF">device='floppy'</span>>
- <source file='/root/fd.img'/>
- <target <span style="color: #0000E5; background-color: #FFFFFF">dev='fda'</span>/>
- </disk>
- <span style="color: #0000E5; background-color: #FFFFFF"><graphics type='vnc' port='5904'/></span>
- </devices>
-</domain></pre>
-
-<p>There is a few things to notice specifically for HVM domains:</p>
-<ul>
- <li>the optional <code><features></code> block is used to enable
- certain guest CPU / system features. For HVM guests the following
- features are defined:
- <ul>
- <li><code>pae</code> - enable PAE memory addressing</li>
- <li><code>apic</code> - enable IO APIC</li>
- <li><code>acpi</code> - enable ACPI bios</li>
- </ul>
- </li>
- <li>the optional <code><clock></code> element is used to specify
- whether the emulated BIOS clock in the guest is synced to either
- <code>localtime</code> or <code>utc</code>. In general Windows will
- want <code>localtime</code> while all other operating systems will
- want <code>utc</code>. The default is thus <code>utc</code></li>
- <li>the <code><os></code> block description is very different, first
- it indicates that the type is 'hvm' for hardware virtualization, then
- instead of a kernel, boot and command line arguments, it points to an os
- boot loader which will extract the boot information from the boot device
- specified in a separate boot element. The <code>dev</code> attribute on
- the <code>boot</code> tag can be one of:
- <ul>
- <li><code>fd</code> - boot from first floppy device</li>
- <li><code>hd</code> - boot from first harddisk device</li>
- <li><code>cdrom</code> - boot from first cdrom device</li>
- </ul>
- </li>
- <li>the <code><devices></code> section includes an emulator entry
- pointing to an additional program in charge of emulating the devices</li>
- <li>the disk entry indicates in the dev target section that the emulation
- for the drive is the first IDE disk device hda. The list of device names
- supported is dependent on the Hypervisor, but for Xen it can be any IDE
- device <code>hda</code>-<code>hdd</code>, or a floppy device
- <code>fda</code>, <code>fdb</code>. The <code><disk></code> element
- also supports a 'device' attribute to indicate what kinda of hardware to
- emulate. The following values are supported:
- <ul>
- <li><code>floppy</code> - a floppy disk controller</li>
- <li><code>disk</code> - a generic hard drive (the default it
- omitted)</li>
- <li><code>cdrom</code> - a CDROM device</li>
- </ul>
- For Xen 3.0.2 and earlier a CDROM device can only be emulated on the
- <code>hdc</code> channel, while for 3.0.3 and later, it can be emulated
- on any IDE channel.</li>
- <li>the <code><devices></code> section also include at least one
- entry for the graphic device used to render the os. Currently there is
- just 2 types possible 'vnc' or 'sdl'. If the type is 'vnc', then an
- additional <code>port</code> attribute will be present indicating the TCP
- port on which the VNC server is accepting client connections.</li>
-</ul>
-
-<p>It is likely that the HVM description gets additional optional elements
-and attributes as the support for fully virtualized domain expands,
-especially for the variety of devices emulated and the graphic support
-options offered.</p>
-
-<h3><a name="KVM1">KVM domain (added in 0.2.0)</a></h3>
-
-<p>Support for the <a href="http://kvm.qumranet.com/">KVM virtualization</a>
-is provided in recent Linux kernels (2.6.20 and onward). This requires
-specific hardware with acceleration support and the availability of the
-special version of the <a
-href="http://fabrice.bellard.free.fr/qemu/">QEmu</a> binary. Since this
-relies on QEmu for the machine emulation like fully virtualized guests the
-XML description is quite similar, here is a simple example:</p>
-<pre><domain <span style="color: #FF0000; background-color: #FFFFFF">type='kvm'</span>>
- <name>demo2</name>
- <uuid>4dea24b3-1d52-d8f3-2516-782e98a23fa0</uuid>
- <memory>131072</memory>
- <vcpu>1</vcpu>
- <os>
- <type>hvm</type>
- </os>
- <span style="color: #0000E5; background-color: #FFFFFF"><clock sync="localtime"/></span>
- <devices>
- <span style="color: #FF0000; background-color: #FFFFFF"><emulator>/home/user/usr/kvm-devel/bin/qemu-system-x86_64</emulator></span>
- <disk type='file' device='disk'>
- <source file='/home/user/fedora/diskboot.img'/>
- <target dev='hda'/>
- </disk>
- <interface <span style="color: #FF0000; background-color: #FFFFFF">type='user'</span>>
- <mac address='24:42:53:21:52:45'/>
- </interface>
- <graphics type='vnc' port='-1'/>
- </devices>
-</domain></pre>
-
-<p>The specific points to note if using KVM are:</p>
-<ul>
- <li>the top level domain element carries a type of 'kvm'</li>
- <li>the <clock> optional is supported as with Xen HVM</li>
- <li>the <devices> emulator points to the special qemu binary required
- for KVM</li>
- <li>networking interface definitions definitions are somewhat different due
- to a different model from Xen see below</li>
-</ul>
-
-<p>except those points the options should be quite similar to Xen HVM
-ones.</p>
-
-<h3><a name="Net1">Networking options for QEmu and KVM (added in 0.2.0)</a></h3>
-
-<p>The networking support in the QEmu and KVM case is more flexible, and
-support a variety of options:</p>
-<ol>
- <li>Userspace SLIRP stack
- <p>Provides a virtual LAN with NAT to the outside world. The virtual
- network has DHCP & DNS services and will give the guest VM addresses
- starting from <code>10.0.2.15</code>. The default router will be
- <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
- This networking is the only option for unprivileged users who need their
- VMs to have outgoing access. Example configs are:</p>
- <pre><interface type='user'/></pre>
- <pre>
-<interface type='user'>
- <mac address="11:22:33:44:55:66"/>
-</interface>
- </pre>
- </li>
- <li>Virtual network
- <p>Provides a virtual network using a bridge device in the host.
- Depending on the virtual network configuration, the network may be
- totally isolated, NAT'ing to an explicit network device, or NAT'ing to
- the default route. DHCP and DNS are provided on the virtual network in
- all cases and the IP range can be determined by examining the virtual
- network config with '<code>virsh net-dumpxml <network
- name></code>'. There is one virtual network called 'default' setup out
- of the box which does NAT'ing to the default route and has an IP range of
- <code>192.168.22.0/255.255.255.0</code>. Each guest will have an
- associated tun device created with a name of vnetN, which can also be
- overridden with the <target> element. Example configs are:</p>
- <pre><interface type='network'>
- <source network='default'/>
-</interface>
-
-<interface type='network'>
- <source network='default'/>
- <target dev='vnet7'/>
- <mac address="11:22:33:44:55:66"/>
-</interface>
- </pre>
- </li>
- <li>Bridge to to LAN
- <p>Provides a bridge from the VM directly onto the LAN. This assumes
- there is a bridge device on the host which has one or more of the hosts
- physical NICs enslaved. The guest VM will have an associated tun device
- created with a name of vnetN, which can also be overridden with the
- <target> element. The tun device will be enslaved to the bridge.
- The IP range / network configuration is whatever is used on the LAN. This
- provides the guest VM full incoming & outgoing net access just like a
- physical machine. Examples include:</p>
- <pre><interface type='bridge'>
- <source bridge='br0'/>
-</interface>
-
-<interface type='bridge'>
- <source bridge='br0'/>
- <target dev='vnet7'/>
- <mac address="11:22:33:44:55:66"/>
-</interface></pre>
- </li>
- <li>Generic connection to LAN
- <p>Provides a means for the administrator to execute an arbitrary script
- to connect the guest's network to the LAN. The guest will have a tun
- device created with a name of vnetN, which can also be overridden with the
- <target> element. After creating the tun device a shell script will
- be run which is expected to do whatever host network integration is
- required. By default this script is called /etc/qemu-ifup but can be
- overridden.</p>
- <pre><interface type='ethernet'/>
-
-<interface type='ethernet'>
- <target dev='vnet7'/>
- <script path='/etc/qemu-ifup-mynet'/>
-</interface></pre>
- </li>
- <li>Multicast tunnel
- <p>A multicast group is setup to represent a virtual network. Any VMs
- whose network devices are in the same multicast group can talk to each
- other even across hosts. This mode is also available to unprivileged
- users. There is no default DNS or DHCP support and no outgoing network
- access. To provide outgoing network access, one of the VMs should have a
- 2nd NIC which is connected to one of the first 4 network types and do the
- appropriate routing. The multicast protocol is compatible with that used
- by user mode linux guests too. The source address used must be from the
- multicast address block.</p>
- <pre><interface type='mcast'>
- <source address='230.0.0.1' port='5558'/>
-</interface></pre>
- </li>
- <li>TCP tunnel
- <p>A TCP client/server architecture provides a virtual network. One VM
- provides the server end of the network, all other VMS are configured as
- clients. All network traffic is routed between the VMs via the server.
- This mode is also available to unprivileged users. There is no default
- DNS or DHCP support and no outgoing network access. To provide outgoing
- network access, one of the VMs should have a 2nd NIC which is connected
- to one of the first 4 network types and do the appropriate routing.</p>
- <p>Example server config:</p>
- <pre><interface type='server'>
- <source address='192.168.0.1' port='5558'/>
-</interface></pre>
- <p>Example client config:</p>
- <pre><interface type='client'>
- <source address='192.168.0.1' port='5558'/>
-</interface></pre>
- </li>
-</ol>
-
-<p>To be noted, options 2, 3, 4 are also supported by Xen VMs, so it is
-possible to use these configs to have networking with both Xen &
-QEMU/KVMs connected to each other.</p>
-
-<h3>Q<a name="QEmu1">Emu domain (added in 0.2.0)</a></h3>
-
-<p>Libvirt support for KVM and QEmu is the same code base with only minor
-changes. The configuration is as a result nearly identical, the only changes
-are related to QEmu ability to emulate <a
-href="http://www.qemu.org/status.html">various CPU type and hardware
-platforms</a>, and kqemu support (QEmu own kernel accelerator when the
-emulated CPU is i686 as well as the target machine):</p>
-<pre><domain <span style="color: #FF0000; background-color: #FFFFFF">type='qemu'</span>>
- <name>QEmu-fedora-i686</name>
- <uuid>c7a5fdbd-cdaf-9455-926a-d65c16db1809</uuid>
- <memory>219200</memory>
- <currentMemory>219200</currentMemory>
- <vcpu>2</vcpu>
- <os>
- <span style="color: #FF0000; background-color: #FFFFFF"><type arch='i686' machine='pc'>hvm</type></span>
- <boot dev='cdrom'/>
- </os>
- <devices>
- <span style="color: #FF0000; background-color: #FFFFFF"><emulator>/usr/bin/qemu</emulator></span>
- <disk type='file' device='cdrom'>
- <source file='/home/user/boot.iso'/>
- <target dev='hdc'/>
- <readonly/>
- </disk>
- <disk type='file' device='disk'>
- <source file='/home/user/fedora.img'/>
- <target dev='hda'/>
- </disk>
- <interface type='network'>
- <source name='default'/>
- </interface>
- <graphics type='vnc' port='-1'/>
- </devices>
-</domain></pre>
-
-<p>The difference here are:</p>
-<ul>
- <li>the value of type on top-level domain, it's 'qemu' or kqemu if asking
- for <a href="http://www.qemu.org/kqemu-tech.html">kernel assisted
- acceleration</a></li>
- <li>the os type block defines the architecture to be emulated, and
- optionally the machine type, see the discovery API below</li>
- <li>the emulator string must point to the right emulator for that
- architecture</li>
-</ul>
-
-<h3><a name="Capa1">Discovering virtualization capabilities (Added in 0.2.1)</a></h3>
-
-<p>As new virtualization engine support gets added to libvirt, and to handle
-cases like QEmu supporting a variety of emulations, a query interface has
-been added in 0.2.1 allowing to list the set of supported virtualization
-capabilities on the host:</p>
-<pre> char * virConnectGetCapabilities (virConnectPtr conn);</pre>
-
-<p>The value returned is an XML document listing the virtualization
-capabilities of the host and virtualization engine to which
-<code>@conn</code> is connected. One can test it using <code>virsh</code>
-command line tool command '<code>capabilities</code>', it dumps the XML
-associated to the current connection. For example in the case of a 64 bits
-machine with hardware virtualization capabilities enabled in the chip and
-BIOS you will see</p>
-<pre><capabilities>
- <span style="color: #E50000; background-color: #FFFFFF"><host>
- <cpu>
- <arch>x86_64</arch>
- <features>
- <vmx/>
- </features>
- </cpu>
- </host></span>
-
- <!-- xen-3.0-x86_64 -->
- <span style="color: #0000E5; background-color: #FFFFFF"><guest>
- <os_type>xen</os_type>
- <arch name="x86_64">
- <wordsize>64</wordsize>
- <domain type="xen"></domain>
- <emulator>/usr/lib64/xen/bin/qemu-dm</emulator>
- </arch>
- <features>
- </features>
- </guest></span>
-
- <!-- hvm-3.0-x86_32 -->
- <span style="color: #00B200; background-color: #FFFFFF"><guest>
- <os_type>hvm</os_type>
- <arch name="i686">
- <wordsize>32</wordsize>
- <domain type="xen"></domain>
- <emulator>/usr/lib/xen/bin/qemu-dm</emulator>
- <machine>pc</machine>
- <machine>isapc</machine>
- <loader>/usr/lib/xen/boot/hvmloader</loader>
- </arch>
- <features>
- </features>
- </guest></span>
- ...
-</capabilities></pre>
-
-<p>The first block (in red) indicates the host hardware capabilities, currently
-it is limited to the CPU properties but other information may be available,
-it shows the CPU architecture, and the features of the chip (the feature
-block is similar to what you will find in a Xen fully virtualized domain
-description).</p>
-
-<p>The second block (in blue) indicates the paravirtualization support of the
-Xen support, you will see the os_type of xen to indicate a paravirtual
-kernel, then architecture information and potential features.</p>
-
-<p>The third block (in green) gives similar information but when running a
-32 bit OS fully virtualized with Xen using the hvm support.</p>
-
-<p>This section is likely to be updated and augmented in the future, see <a
-href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the
-discussion</a> which led to the capabilities format in the mailing-list
-archives.</p>
-
-<h2><a name="Python" id="Python">Bindings for other languages</a></h2>
-
-<p>Libvirt comes with bindings to support other languages than
-pure C. First the headers embeds the necessary declarations to
-allow direct acces from C++ code, but also we have bindings for
-higher level kind of languages:</p>
-<ul>
- <li>Python: Libvirt comes with direct support for the Python language
- (just make sure you installed the libvirt-python package if not
- compiling from sources). See below for more information about
- using libvirt with python</li>
- <li>Perl: Daniel Berrange provides <a
- href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">bindings for
- Perl</a>.</li>
- <li>OCaml: Richard Jones supplies <a
- href="http://libvirt.org/ocaml/">bindings for OCaml</a>.</li>
- <li>Ruby: David Lutterkork provides <a
- href= "http://libvirt.org/ruby/">bindings for Ruby</a>.</li>
-</ul>
-
-<p>Support, requests or help for libvirt bindings are welcome on
-the <a href="https://www.redhat.com/mailman/listinfo/libvir-list/">mailing
-list</a>, as usual try to provide enough background information
-and make sure you use recent version, see the <a href="bugs.html">help
-page</a>.</p>
-
-<p>The remaining of this page focuses on the Python bindings.</p>
-
-<p>The Python binding should be complete and are mostly automatically
-generated from the formal description of the API in xml. The bindings are
-articulated around 2 classes <code>virConnect</code> and virDomain mapping to
-the C types. Functions in the C API taking either type as argument then
-becomes methods for the classes, their name is just stripped from the
-virConnect or virDomain(Get) prefix and the first letter gets converted to
-lower case, for example the C functions:</p>
-
-<p><code>int <a
-href="html/libvirt-libvirt.html#virConnectNumOfDomains">virConnectNumOfDomains</a>
-(virConnectPtr conn);</code></p>
-
-<p><code>int <a
-href="html/libvirt-libvirt.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a>
-(virDomainPtr domain, unsigned long memory);</code></p>
-
-<p>become</p>
-
-<p><code>virConn::numOfDomains(self)</code></p>
-
-<p><code>virDomain::setMaxMemory(self, memory)</code></p>
-
-<p>This process is fully automated, you can get a summary of the conversion
-in the file libvirtclass.txt present in the python dir or in the docs.There
-is a couple of function who don't map directly to their C counterparts due to
-specificities in their argument conversions:</p>
-<ul>
- <li><code><a
- href="html/libvirt-libvirt.html#virConnectListDomains">virConnectListDomains</a></code>
- is replaced by <code>virDomain::listDomainsID(self)</code> which returns
- a list of the integer ID for the currently running domains</li>
- <li><code><a
- href="html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a></code>
- is replaced by <code>virDomain::info()</code> which returns a list of
- <ol>
- <li>state: one of the state values (virDomainState)</li>
- <li>maxMemory: the maximum memory used by the domain</li>
- <li>memory: the current amount of memory used by the domain</li>
- <li>nbVirtCPU: the number of virtual CPU</li>
- <li>cpuTime: the time used by the domain in nanoseconds</li>
- </ol>
- </li>
-</ul>
-
-<p>So let's look at a simple example inspired from the <code>basic.py</code>
-test found in <code>python/tests/</code> in the source tree:</p>
-<pre>import <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>
-import sys
-
-conn = <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>.openReadOnly(None)
-if conn == None:
- print 'Failed to open connection to the hypervisor'
- sys.exit(1)
-
-try:
- dom0 = conn.<span style="color: #007F00; background-color: #FFFFFF">lookupByName</span>("Domain-0")
-except:
- print 'Failed to find the main domain'
- sys.exit(1)
-
-print "Domain 0: id %d running %s" % (dom0.<span style="color: #FF0080; background-color: #FFFFFF">ID</span>(), dom0.<span style="color: #FF0080; background-color: #FFFFFF">OSType</span>())
-print dom0.<span style="color: #FF0080; background-color: #FFFFFF">info</span>()</pre>
-
-<p>There is not much to comment about it, it really is a straight mapping
-from the C API, the only points to notice are:</p>
-<ul>
- <li>the import of the module called <code><span
- style="color: #0071FF; background-color: #FFFFFF">libvirt</span></code></li>
- <li>getting a connection to the hypervisor, in that case using the
- openReadOnly function allows the code to execute as a normal user.</li>
- <li>getting an object representing the Domain 0 using <span
- style="color: #007F00; background-color: #FFFFFF">lookupByName</span></li>
- <li>if the domain is not found a libvirtError exception will be raised</li>
- <li>extracting and printing some information about the domain using
- various <span
- style="color: #E50073; background-color: #FFFFFF">methods</span>
- associated to the virDomain class.</li>
-</ul>
-
-<h2><a name="Errors" id="Errors">Handling of errors</a></h2>
-
-<p>The main goals of libvirt when it comes to error handling are:</p>
-<ul>
- <li>provide as much detail as possible</li>
- <li>provide the information as soon as possible</li>
- <li>dont force the library user into one style of error handling</li>
-</ul>
-
-<p>As result the library provide both synchronous, callback based and
-asynchronous error reporting. When an error happens in the library code the
-error is logged, allowing to retrieve it later and if the user registered an
-error callback it will be called synchronously. Once the call to libvirt ends
-the error can be detected by the return value and the full information for
-the last logged error can be retrieved.</p>
-
-<p>To avoid as much as possible troubles with a global variable in a
-multithreaded environment, libvirt will associate when possible the errors to
-the current connection they are related to, that way the error is stored in a
-dynamic structure which can be made thread specific. Error callback can be
-set specifically to a connection with</p>
-
-<p>So error handling in the code is the following:</p>
-<ol>
- <li>if the error can be associated to a connection for example when failing
- to look up a domain
- <ol>
- <li>if there is a callback associated to the connection set with <a
- href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
- call it with the error information</li>
- <li>otherwise if there is a global callback set with <a
- href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
- call it with the error information</li>
- <li>otherwise call <a
- href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
- which is the default error function of the library issuing the error
- on stderr</li>
- <li>save the error in the connection for later retrieval with <a
- href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li>
- </ol>
- </li>
- <li>otherwise like when failing to create an hypervisor connection:
- <ol>
- <li>if there is a global callback set with <a
- href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
- call it with the error information</li>
- <li>otherwise call <a
- href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
- which is the default error function of the library issuing the error
- on stderr</li>
- <li>save the error in the connection for later retrieval with <a
- href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li>
- </ol>
- </li>
-</ol>
-
-<p>In all cases the error information is provided as a <a
-href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a> pointer to
-read-only structure <a
-href="html/libvirt-virterror.html#virError">virError</a> containing the
-following fields:</p>
-<ul>
- <li>code: an error number from the <a
- href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>
- enum</li>
- <li>domain: an enum indicating which part of libvirt raised the error see
- <a
- href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li>
- <li>level: the error level, usually VIR_ERR_ERROR, though there is room for
- warnings like VIR_ERR_WARNING</li>
- <li>message: the full human-readable formatted string of the error</li>
- <li>conn: if available a pointer to the <a
- href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>
- connection to the hypervisor where this happened</li>
- <li>dom: if available a pointer to the <a
- href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain
- targeted in the operation</li>
-</ul>
-
-<p>and then extra raw information about the error which may be initialized
-to 0 or NULL if unused</p>
-<ul>
- <li>str1, str2, str3: string information, usually str1 is the error
- message format</li>
- <li>int1, int2: integer information</li>
-</ul>
-
-<p>So usually, setting up specific error handling with libvirt consist of
-registering an handler with with <a
-href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a> or
-with <a
-href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
-check the value of the code value, take appropriate action, if needed let
-libvirt print the error on stderr by calling <a
-href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>.
-For asynchronous error handing, set such a function doing nothing to avoid
-the error being reported on stderr, and call virConnGetLastError or
-virGetLastError when an API call returned an error value. It can be a good
-idea to use <a
-href="html/libvirt-virterror.html#virResetLastError">virResetError</a> or <a
-href="html/libvirt-virterror.html#virConnResetLastError">virConnResetLastError</a>
-once an error has been processed fully.</p>
-
-<p>At the python level, there only a global reporting callback function at
-this point, see the error.py example about it:</p>
-<pre>def handler(ctxt, err):
- global errno
-
- #print "handler(%s, %s)" % (ctxt, err)
- errno = err
-
-libvirt.registerErrorHandler(handler, 'context') </pre>
-
-<p>the second argument to the registerErrorHandler function is passed as the
-first argument of the callback like in the C version. The error is a tuple
-containing the same field as a virError in C, but cast to Python.</p>
-
-<h2><a name="FAQ" id="FAQ">FAQ</a></h2>
-
-<p>Table of Contents:</p>
-<ul>
- <li><a href="FAQ.html#License">License(s)</a></li>
- <li><a href="FAQ.html#Installati">Installation</a></li>
- <li><a href="FAQ.html#Compilatio">Compilation</a></li>
- <li><a href="FAQ.html#Developer">Developer corner</a></li>
-</ul>
-
-<h3><a name="License">License</a>(s)</h3>
-<ol>
- <li><em>Licensing Terms for libvirt</em>
- <p>libvirt is released under the <a
- href="http://www.opensource.org/licenses/lgpl-license.html">GNU Lesser
- General Public License</a>, see the file COPYING.LIB in the distribution
- for the precise wording. The only library that libvirt depends upon is
- the Xen store access library which is also licenced under the LGPL.</p>
- </li>
- <li><em>Can I embed libvirt in a proprietary application ?</em>
- <p>Yes. The LGPL allows you to embed libvirt into a proprietary
- application. It would be graceful to send-back bug fixes and improvements
- as patches for possible incorporation in the main development tree. It
- will decrease your maintenance costs anyway if you do so.</p>
- </li>
-</ol>
-
-<h3><a name="Installati">Installation</a></h3>
-<ol>
- <li><em>Where can I get libvirt</em> ?
- <p>The original distribution comes from <a
- href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/</a>.</p>
- </li>
- <li><em>I can't install the libvirt/libvirt-devel RPM packages due to
- failed dependencies</em>
- <p>The most generic solution is to re-fetch the latest src.rpm , and
- rebuild it locally with</p>
- <p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p>
- <p>If everything goes well it will generate two binary rpm packages (one
- providing the shared libs and virsh, and the other one, the -devel
- package, providing includes, static libraries and scripts needed to build
- applications with libvirt that you can install locally.</p>
- <p>One can also rebuild the RPMs from a tarball:</p>
- <p><code>rpmbuild -ta libdir-xxx.tar.gz</code></p>
- <p>Or from a configured tree with:</p>
- <p><code>make rpm</code></p>
- </li>
- <li><em>Failure to use the API for non-root users</em>
- <p>Large parts of the API may only be accessible with root privileges,
- however the read only access to the xenstore data doesnot have to be
- forbidden to user, at least for monitoring purposes. If "virsh dominfo"
- fails to run as an user, change the mode of the xenstore read-only socket
- with:</p>
- <p><code>chmod 666 /var/run/xenstored/socket_ro</code></p>
- <p>and also make sure that the Xen Daemon is running correctly with local
- HTTP server enabled, this is defined in
- <code>/etc/xen/xend-config.sxp</code> which need the following line to be
- enabled:</p>
- <p><code>(xend-http-server yes)</code></p>
- <p>If needed restart the xend daemon after making the change with the
- following command run as root:</p>
- <p><code>service xend restart</code></p>
- </li>
-</ol>
-
-<h3><a name="Compilatio">Compilation</a></h3>
-<ol>
- <li><em>What is the process to compile libvirt ?</em>
- <p>As most UNIX libraries libvirt follows the "standard":</p>
- <p><code>gunzip -c libvirt-xxx.tar.gz | tar xvf -</code></p>
- <p><code>cd libvirt-xxxx</code></p>
- <p><code>./configure --help</code></p>
- <p>to see the options, then the compilation/installation proper</p>
- <p><code>./configure [possible options]</code></p>
- <p><code>make</code></p>
- <p><code>make install</code></p>
- <p>At that point you may have to rerun ldconfig or a similar utility to
- update your list of installed shared libs.</p>
- </li>
- <li><em>What other libraries are needed to compile/install libvirt ?</em>
- <p>Libvirt requires libxenstore, which is usually provided by the xen
- packages as well as the public headers to compile against libxenstore.</p>
- </li>
- <li><em>I use the CVS version and there is no configure script</em>
- <p>The configure script (and other Makefiles) are generated. Use the
- autogen.sh script to regenerate the configure script and Makefiles,
- like:</p>
- <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
- </li>
-</ol>
-
-<h3><a name="Developer">Developer</a> corner</h3>
-<ol>
- <li><em>Troubles compiling or linking programs using libvirt</em>
- <p>To simplify the process of reusing the library, libvirt comes with
- pkgconfig support, which can be used directly from autoconf support or
- via the pkg-config command line tool, like:</p>
- <p><code>pkg-config libvirt --libs</code></p>
- </li>
-</ol>
-
-<h2><a name="Reporting">Reporting bugs and getting help</a></h2>
-
-<p>There is a mailing-list <a
-href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a> for libvirt,
-with an <a href="https://www.redhat.com/archives/libvir-list/">on-line
-archive</a>. Please subscribe to this list before posting by visiting the <a
-href="https://www.redhat.com/mailman/listinfo/libvir-list">associated Web</a>
-page and follow the instructions. Patches with explanations and provided as
-attachments are really appreciated and will be discussed on the mailing list.
-If possible generate the patches by using cvs diff -u in a CVS checkout.</p>
-
-<p>We use Red Hat Bugzilla to track bugs and new feature requests to libvirt.
-If you want to report a bug or ask for a feature, please check <a href="http://bugzilla.redhat.com/bugzilla/buglist.cgi?component=libvirt&component=libvirt-devel&component=libvirt-python&bug_status=ASSIGNED&bug_status=INVESTIGATE&bug_status=NEW&bug_status=REOPENED&bug_status=VERIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr&long_desc=&Search=Search">the existing open bugs</a>, then if yours isn't a duplicate of
-an existing bug:</p>
-<ul>
-<li>If you are using official binaries from Fedora: <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&component=libvirt">log a new bug for Fedora</a></li>
-<li>If you are using official binaries from Red Hat Enterprise Linux 5: <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&component=Red%20Hat%20Enterprise%20Linux%205">log a new bug for RHEL</a></li>
-<li>Otherwise: <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&component=Virtualization%20Tools">log a new bug here</a></li>
-</ul>
-<p> Don't forget to attach any patch or extra data that you may have available. It is always a good idea to also
-to post to the <a href="mailto:libvir-list@redhat.com">mailing-list</a>
-too, so that everybody working on the project can see it, thanks !</p>
-
-<p>Some of the libvirt developers may be found on IRC on the OFTC
-network. Use the settings:</p>
-<ul>
- <li>server: irc.oftc.net</li>
- <li>port: 6667 (the usual IRC port)</li>
- <li>channel: #virt</li>
-</ul>
-<p> But there is no guarantee that someone will be watching or able to reply,
-use the mailing-list if you don't get an answer there.</p>
-
-<h2><a name="Windows" id="Windows">Windows support</a></h2>
-
-<p>
-Instructions for compiling and installing libvirt on Windows.
-</p>
-
-<ul>
- <li><a href="#Windows_binaries">Binaries</a></li>
- <li><a href="#Windows_compiling">Compiling from source</a></li>
-</ul>
-
-<h3><a name="Windows_binaries">Binaries</a></h3>
-
-<p>
-Binaries will be available from
-<a href="ftp://libvirt.org/libvirt/win32">the download area</a>
-(but we don't have binaries at the moment).
-</p>
-
-<h3><a name="Windows_compiling">Compiling from source</a></h3>
-
-<p>
-These are the steps to compile libvirt and the other
-tools from source on Windows.
-</p>
-
-<p>
-You will need:
-</p>
-
-<ol>
-<li> MS Windows. Microsoft makes free (as beer) versions
-of some of its operating systems available to
-<a href="http://msdn.microsoft.com/">MSDN subscribers</a>.
-We used Windows 2008 Server for testing, virtualized under
-Linux using KVM-53 (earlier versions of KVM and QEMU won't
-run recent versions of Windows because of lack of full ACPI
-support, so make sure you have the latest KVM).
-</li>
-
-<li> <a href="http://www.cygwin.com/">Cygwin</a>'s
-<a href="http://www.cygwin.com/setup.exe">setup.exe</a>.
-</li>
-
-<li> A large amount of free disk space to install Cygwin.
-Make sure you have 10 GB free to install most Cygwin packages,
-although if you pare down the list of dependencies you may
-get away with much less. </li>
-
-<li> A network connection for Windows, since Cygwin downloads packages
-from the net as it installs. </li>
-
-<li> <a href="http://www.libvirt.org/downloads.html">Libvirt
-latest version from CVS</a> </li>
-
-<li> The latest source patch from
-<a href="ftp://libvirt.org/libvirt/win32">the download area</a>. </li>
-
-<li> A version of Cygwin sunrpc, patched to support building
- <code>librpc.dll</code>.
- A patch and a binary package are available from
- <a href="ftp://libvirt.org/libvirt/win32">the download area</a>. </li>
-</ol>
-
-<p>
-These are the steps to take to compile libvirt from
-source on Windows:
-</p>
-
-<ol>
-<li>
- <p>Run Cygwin
- <a href="http://www.cygwin.com/setup.exe">setup.exe</a>.
- When it starts up it will show a dialog like this:
- </p>
-
- <img src="windows-cygwin-1.png" width="504" height="388"
- alt="Cygwin Net Release Setup Program" />
-</li>
-
-<li>
- <p>Step through the setup program accepting defaults
- or making choices as appropriate, until you get to the
- screen for selecting packages:</p>
-
- <img src="windows-cygwin-2.png" width="505" height="388"
- alt="Cygwin Select Packages screen" />
-
- <p>
- The user interface here is very confusing. You have to
- click the "recycling icon" as shown by the arrow:
- </p>
-
- <img src="windows-cygwin-3.png" width="298" height="200"
- alt="Cygwin Recycling Icon" />
-
- <p>
- which takes the package (and all packages in the subtree)
- through several states such as "Install", "Reinstall", "Keep",
- "Skip", "Uninstall", etc.
- </p>
-
-</li>
-
-<li>
- <p>You can install "All" (everything) or better select
- just the groups and packages needed. Select the following
- groups and packages for installation:
- </p>
-
- <table>
- <tr>
- <th valign="top" align="right"> Groups </th>
- <td>
- Archive <br/>
- Base <br/>
- Devel <br/>
- Editors <br/>
- Mingw <br/>
- Perl <br/>
- Python <br/>
- Shells <br/>
- </td>
- </tr>
- <tr>
- <th valign="top" align="right"> Packages </th>
- <td>
- openssh <br/>
- sunrpc ≥ 4.0-4 (see below) <br/>
- </td>
- </tr>
- </table>
-</li>
-
-<li>
- <p> Once Cygwin has finished installing, start a Cygwin bash shell
- (either click on the desktop icon or look for Cygwin bash shell
- in the Start menu). </p>
-
- <p> The very first time you start the Cygwin bash shell, you may
- find you need to run the <code>mkpasswd</code> and <code>mkgroup</code>
- commands in order to create <code>/etc/passwd</code> and
- <code>/etc/group</code> files from Windows users. If this
- is needed then a message is printed in the shell.
- Note that you need to do this as Windows Administrator. </p>
-</li>
-
-<li>
- <p> Install Cygwin sunrpc ≥ 4.0-4 package, patched to include
- <code>librpc.dll</code>.
- To do this, first check to see whether <code>/usr/lib/librpc.dll</code>
- exists. If it does, you're good to go and can skip to the next
- step. </p>
-
- <p>
- If you don't have this file, either install the binary package
- <a href="ftp://libvirt.org/libvirt/win32/sunrpc-4.0-4.tar.bz2">sunrpc-4.0-4.tar.bz2</a> (just unpack it, as Administrator, in the Cygwin root directory).
- Or you can download the
- <a href="ftp://libvirt.org/libvirt/win32/sunrpc-4.0-dll.patch">source patch</a>
- and apply it by hand to the Cygwin sunrpc package (eg. using
- cygport).
- </p>
-</li>
-
-<li>
- <p>
- Check out
- <a href="http://www.libvirt.org/downloads.html">Libvirt from CVS</a> and
- <a href="ftp://libvirt.org/libvirt/win32">apply the latest Windows patch</a>
- to the source.
- </p>
-</li>
-
-<li>
- <p> Configure libvirt by doing: </p>
-<pre>
-autoreconf
-./configure --without-xen --without-qemu
-</pre>
- <p> (The autoreconf step is probably optional). </p>
- <p> The configure step will tell you if you have all the
- required parts installed. If something is missing you
- will need to go back through Cygwin setup and install it.
- </p>
-</li>
-
-<li>
- <p> Rebuild the XDR structures: </p>
-<pre>
-rm qemud/remote_protocol.[ch] qemud/remote_dispatch_*.h
-make -C qemud remote_protocol.c
-</pre>
-</li>
-
-<li>
- <p> Build: </p>
-<pre>
-make
-</pre>
- <p> If this step is not successful, you should post a full
- report <i>including complete messages</i> to
- <a href="http://www.redhat.com/mailman/listinfo/libvir-list">the
- libvirt mailing list</a>.
- </p>
-</li>
-
-<li>
- <p> Test it. If you have access to a remote machine
- running Xen or QEMU/KVM, and the libvirt daemon (<code>libvirtd</code>)
- then you should be able to connect to it and display
- domains using, eg:
- </p>
-<pre>
-src/virsh.exe <a href="http://libvirt.org/uri.html">-c qemu://remote/system</a> list --all
-</pre>
- <p>
- Please read more about <a href="http://libvirt.org/remote.html">remote
- support</a> before sending bug reports, to make sure that
- any problems are really Windows and not just with remote
- configuration / security.
- </p>
-</li>
-
-<li>
- <p>
- You may want to install the library and programs by doing:
- </p>
-<pre>
-make install
-</pre>
-</li>
-
-<li>
- <p>
- The above steps should also build and install Python modules.
- However for reasons which I don't fully understand, Python won't
- look in the
- non-standard <code>/usr/local/lib/python*/site-packages/</code>
- directory by default so you may need to set the environment
- variable PYTHONPATH:
- </p>
-
-<pre>
-export PYTHONPATH=/usr/local/lib/python2.5/site-packages
-</pre>
-
- <p>
- (Change the version number to your version of Python). You
- can test Python support from the command line:
- </p>
-
-<pre>
-python
->>> import libvirt
->>> conn = libvirt.open ("test:///default")
->>> conn.listDomainsID ()
-[1]
->>> dom = conn.lookupByID (1)
->>> dom.XMLDesc (0)
-"<domain type='test' id='1'> ..."
-</pre>
-
- <p>
- The most common failure will be with <code>import libvirt</code>
- which usually indicates that either <code>PYTHONPATH</code> is
- wrong or a DLL cannot be loaded.
- </p>
-</li>
-
-</ol>
-
-<h2><a name="Remote">Remote support</a></h2>
-
-<p>
-Libvirt allows you to access hypervisors running on remote
-machines through authenticated and encrypted connections.
-</p>
-<ul>
- <li><a href="#Remote_basic_usage">Basic usage</a></li>
- <li><a href="#Remote_transports">Transports</a></li>
- <li><a href="#Remote_URI_reference">Remote URIs</a>
- <ul>
- <li><a href="#Remote_URI_parameters">Extra parameters</a></li>
- </ul></li>
- <li><a href="#Remote_certificates">Generating TLS certificates</a>
- <ul>
- <li><a href="#Remote_PKI">Public Key Infrastructure set up</a></li>
- <li><a href="#Remote_TLS_background">Background to TLS certificates</a></li>
- <li><a href="#Remote_TLS_CA">Setting up a Certificate Authority (CA)</a></li>
- <li><a href="#Remote_TLS_server_certificates">Issuing server certificates</a></li>
- <li><a href="#Remote_TLS_client_certificates">Issuing client certificates</a></li>
- <li><a href="#Remote_TLS_troubleshooting">Troubleshooting TLS certificate problems</a></li>
- </ul></li>
- <li><a href="#Remote_libvirtd_configuration">libvirtd configuration file</a></li>
- <li><a href="#Remote_IPv6">IPv6 support</a></li>
- <li><a href="#Remote_limitations">Limitations</a></li>
- <li><a href="#Remote_implementation_notes">Implementation notes</a></li>
-</ul>
-
-<h3><a name="Remote_basic_usage">Basic usage</a></h3>
-
-<p>
-On the remote machine, <code>libvirtd</code> should be running.
-See <a href="#Remote_libvirtd_configuration">the section
-on configuring libvirtd</a> for more information.
-</p>
-
-<p>
-To tell libvirt that you want to access a remote resource,
-you should supply a hostname in the normal <a href="uri.html">URI</a> that is passed
-to <code>virConnectOpen</code> (or <code>virsh -c ...</code>).
-For example, if you normally use <code>qemu:///system</code>
-to access the system-wide QEMU daemon, then to access
-the system-wide QEMU daemon on a remote machine called
-<code>oirase</code> you would use <code>qemu://oirase/system</code>.
-</p>
-
-<p>
-The <a href="#Remote_URI_reference">section on remote URIs</a>
-describes in more detail these remote URIs.
-</p>
-
-<p>
-From an API point of view, apart from the change in URI, the
-API should behave the same. For example, ordinary calls
-are routed over the remote connection transparently, and
-values or errors from the remote side are returned to you
-as if they happened locally. Some differences you may notice:
-</p>
-
-<ul>
-<li> Additional errors can be generated, specifically ones
-relating to failures in the remote transport itself. </li>
-<li> Remote calls are handled synchronously, so they will be
-much slower than, say, direct hypervisor calls. </li>
-</ul>
-
-<h3><a name="Remote_transports">Transports</a></h3>
-
-<p>
-Remote libvirt supports a range of transports:
-</p>
-
-<dl>
-<dt> tls </dt>
-<dd> <a href="http://en.wikipedia.org/wiki/Transport_Layer_Security"
- title="Transport Layer Security">TLS</a>
- 1.0 (SSL 3.1) authenticated and encrypted TCP/IP socket, usually
- listening on a public port number. To use this you will need to
- <a href="#Remote_certificates"
- title="Generating TLS certificates">generate client and
- server certificates</a>.
- The standard port is 16514.
- </dd>
-
-<dt> unix </dt>
-<dd> Unix domain socket. Since this is only accessible on the
- local machine, it is not encrypted, and uses Unix permissions or
- SELinux for authentication.
- The standard socket names are
- <code>/var/run/libvirt/libvirt-sock</code> and
- <code>/var/run/libvirt/libvirt-sock-ro</code> (the latter
- for read-only connections).
- </dd>
-
-<dt> ssh </dt>
-<dd> Transported over an ordinary
- <a href="http://www.openssh.com/" title="OpenSSH homepage">ssh
- (secure shell)</a> connection.
- Requires <a href="http://netcat.sourceforge.net/">Netcat (nc)</a>
- installed and libvirtd should be running
- on the remote machine. You should use some sort of
- ssh key management (eg.
- <a href="http://mah.everybody.org/docs/ssh"
- title="Using ssh-agent with ssh">ssh-agent</a>)
- otherwise programs which use
- this transport will stop to ask for a password. </dd>
-
-<dt> ext </dt>
-<dd> Any external program which can make a connection to the
- remote machine by means outside the scope of libvirt. </dd>
-
-<dt> tcp </dt>
-<dd> Unencrypted TCP/IP socket. Not recommended for production
- use, this is normally disabled, but an administrator can enable
- it for testing or use over a trusted network.
- The standard port is 16509.
- </dd>
-</dl>
-
-<p>
-The default transport, if no other is specified, is <code>tls</code>.
-</p>
-
-<h3><a name="Remote_URI_reference">Remote URIs</a></h3>
-
-<p>
-See also: <a href="uri.html">documentation on ordinary ("local") URIs</a>.
-</p>
-
-<p>
-Remote URIs have the general form ("[...]" meaning an optional part):
-</p>
-
-<p>
-<code>driver</code>[<code>+transport</code>]<code>://</code>[<code>username@</code>][<code>hostname</code>][<code>:port</code>]<code>/</code>[<code>path</code>][<code>?extraparameters</code>]
-</p>
-
-<p>
-Either the transport or the hostname must be given in order
-to distinguish this from a local URI.
-</p>
-
-<p>
-Some examples:
-</p>
-
-<ul>
-<li> <code>xen+ssh://rjones@towada/</code> <br/> — Connect to a
-remote Xen hypervisor on host <code>towada</code> using ssh transport and ssh
-username <code>rjones</code>.
-</li>
-
-<li> <code>xen://towada/</code> <br/> — Connect to a
-remote Xen hypervisor on host <code>towada</code> using TLS.
-</li>
-
-<li> <code>xen://towada/?no_verify=1</code> <br/> — Connect to a
-remote Xen hypervisor on host <code>towada</code> using TLS. Do not verify
-the server's certificate.
-</li>
-
-<li> <code>qemu+unix:///system?socket=/opt/libvirt/run/libvirt/libvirt-sock</code> <br/> —
-Connect to the local qemu instances over a non-standard
-Unix socket (the full path to the Unix socket is
-supplied explicitly in this case).
-</li>
-
-<li> <code>test+tcp://localhost:5000/default</code> <br/> —
-Connect to a libvirtd daemon offering unencrypted TCP/IP connections
-on localhost port 5000 and use the test driver with default
-settings.
-</li>
-
-</ul>
-
-<h4><a name="Remote_URI_parameters">Extra parameters</a></h4>
-
-<p>
-Extra parameters can be added to remote URIs as part
-of the query string (the part following <q><code>?</code></q>).
-Remote URIs understand the extra parameters shown below.
-Any others are passed unmodified through to the back end.
-Note that parameter values must be
-<a href="http://xmlsoft.org/html/libxml-uri.html#xmlURIEscapeStr">URI-escaped</a>.
-</p>
-
-<table class="top_table">
-<tr>
-<th> Name </th>
-<th> Transports </th>
-<th> Meaning </th>
-</tr>
-
-<tr>
-<td> <code>name</code> </td>
-<td> <i>any transport</i> </td>
-<td>
- The name passed to the remote virConnectOpen function. The
- name is normally formed by removing transport, hostname, port
- number, username and extra parameters from the remote URI, but in certain
- very complex cases it may be better to supply the name explicitly.
-</td>
-</tr>
-<tr> <td colspan="2"></td>
-<td> Example: <code>name=qemu:///system</code> </td>
-</tr>
-
-<tr>
-<td> <code>command</code> </td>
-<td> ssh, ext </td>
-<td>
- The external command. For ext transport this is required.
- For ssh the default is <code>ssh</code>.
- The PATH is searched for the command.
-</td>
-</tr>
-<tr> <td colspan="2"></td>
-<td> Example: <code>command=/opt/openssh/bin/ssh</code> </td>
-</tr>
-
-<tr>
-<td> <code>socket</code> </td>
-<td> unix, ssh </td>
-<td>
- The path to the Unix domain socket, which overrides the
- compiled-in default. For ssh transport, this is passed to
- the remote netcat command (see next).
-</td>
-</tr>
-<tr> <td colspan="2"></td>
-<td> Example: <code>socket=/opt/libvirt/run/libvirt/libvirt-sock</code> </td>
-</tr>
-
-<tr>
-<td> <code>netcat</code> </td>
-<td> ssh </td>
-<td>
- The name of the netcat command on the remote machine.
- The default is <code>nc</code>. For ssh transport, libvirt
- constructs an ssh command which looks like:
-
-<pre>
-<i>command</i> -p <i>port</i> [-l <i>username</i>] <i>hostname</i> <i>netcat</i> -U <i>socket</i>
-</pre>
-
- where <i>port</i>, <i>username</i>, <i>hostname</i> can be
- specified as part of the remote URI, and <i>command</i>, <i>netcat</i>
- and <i>socket</i> come from extra parameters (or
- sensible defaults).
-
-</td>
-</tr>
-<tr> <td colspan="2"></td>
-<td> Example: <code>netcat=/opt/netcat/bin/nc</code> </td>
-</tr>
-
-<tr>
-<td> <code>no_verify</code> </td>
-<td> tls </td>
-<td>
- If set to a non-zero value, this disables client checks of the
- server's certificate. Note that to disable server checks of
- the client's certificate or IP address you must
- <a href="#Remote_libvirtd_configuration">change the libvirtd
- configuration</a>.
-</td>
-</tr>
-<tr> <td colspan="2"></td>
-<td> Example: <code>no_verify=1</code> </td>
-</tr>
-
-<tr>
-<td> <code>no_tty</code> </td>
-<td> ssh </td>
-<td>
- If set to a non-zero value, this stops ssh from asking for
- a password if it cannot log in to the remote machine automatically
- (eg. using ssh-agent etc.). Use this when you don't have access
- to a terminal - for example in graphical programs which use libvirt.
-</td>
-</tr>
-<tr> <td colspan="2"></td>
-<td> Example: <code>no_tty=1</code> </td>
-</tr>
-
-</table>
-
-<h3><a name="Remote_certificates">Generating TLS certificates</a></h3>
-
-<h4><a name="Remote_PKI">Public Key Infrastructure set up</a></h4>
-
-<p>
-If you are unsure how to create TLS certificates, skip to the
-next section.
-</p>
-
-<table class="top_table">
-<tr>
-<th> Location </th>
-<th> Machine </th>
-<th> Description </th>
-<th> Required fields </th>
-</tr>
-
-<tr>
-<td> <code>/etc/pki/CA/cacert.pem</code> </td>
-<td> Installed on all clients and servers </td>
-<td> CA's certificate (<a href="#Remote_TLS_CA">more info</a>)</td>
-<td> n/a </td>
-</tr>
-
-<tr>
-<td> <code>/etc/pki/libvirt/ private/serverkey.pem</code> </td>
-<td> Installed on the server </td>
-<td> Server's private key (<a href="#Remote_TLS_server_certificates">more info</a>)</td>
-<td> n/a </td>
-</tr>
-
-<tr>
-<td> <code>/etc/pki/libvirt/ servercert.pem</code> </td>
-<td> Installed on the server </td>
-<td> Server's certificate signed by the CA.
- (<a href="#Remote_TLS_server_certificates">more info</a>) </td>
-<td> CommonName (CN) must be the hostname of the server as it
- is seen by clients. </td>
-</tr>
-
-<tr>
-<td> <code>/etc/pki/libvirt/ private/clientkey.pem</code> </td>
-<td> Installed on the client </td>
-<td> Client's private key. (<a href="#Remote_TLS_client_certificates">more info</a>) </td>
-<td> n/a </td>
-</tr>
-
-<tr>
-<td> <code>/etc/pki/libvirt/ clientcert.pem</code> </td>
-<td> Installed on the client </td>
-<td> Client's certificate signed by the CA
- (<a href="#Remote_TLS_client_certificates">more info</a>) </td>
-<td> Distinguished Name (DN) can be checked against an access
- control list (<code>tls_allowed_dn_list</code>).
- </td>
-</tr>
-</table>
-
-
-<h4><a name="Remote_TLS_background">Background to TLS certificates</a></h4>
-
-<p>
-Libvirt supports TLS certificates for verifying the identity
-of the server and clients. There are two distinct checks involved:
-</p>
-
-<ul>
-<li> The client should know that it is connecting to the right
-server. Checking done by client by matching the certificate that
-the server sends to the server's hostname. May be disabled by adding
-<code>?no_verify=1</code> to the
-<a href="#Remote_URI_parameters">remote URI</a>.
-</li>
-
-<li> The server should know that only permitted clients are
-connecting. This can be done based on client's IP address, or on
-client's IP address and client's certificate. Checking done by the
-server. May be enabled and disabled in the <a
-href="#Remote_libvirtd_configuration">libvirtd.conf file</a>.
-</li>
-</ul>
-
-<p>
-For full certificate checking you will need to have certificates
-issued by a recognised <a
-href="http://en.wikipedia.org/wiki/Certificate_authority">Certificate
-Authority (CA)</a> for your server(s) and all clients. To avoid the
-expense of getting certificates from a commercial CA, you can set up
-your own CA and tell your server(s) and clients to trust certificates
-issues by your own CA. Follow the instructions in the next section.
-</p>
-
-<p>
-Be aware that the <a href="#Remote_libvirtd_configuration">default
-configuration for libvirtd</a> allows any client to connect provided
-they have a valid certificate issued by the CA for their own IP
-address. You may want to change this to make it less (or more)
-permissive, depending on your needs.
-</p>
-
-<h4><a name="Remote_TLS_CA">Setting up a Certificate Authority (CA)</a></h4>
-
-<p>
-You will need the <a
-href="http://www.gnu.org/software/gnutls/manual/html_node/Invoking-certtool.html">GnuTLS
-certtool program documented here</a>. In Fedora, it is in the
-<code>gnutls-utils</code> package.
-</p>
-
-<p>
-Create a private key for your CA:
-</p>
-
-<pre>
-certtool --generate-privkey > cakey.pem
-</pre>
-
-<p>
-and self-sign it by creating a file with the
-signature details called
-<code>ca.info</code> containing:
-</p>
-
-<pre>
-cn = <i>Name of your organization</i>
-ca
-cert_signing_key
-</pre>
-
-and sign:
-
-<pre>
-certtool --generate-self-signed --load-privkey cakey.pem \
- --template ca.info --outfile cacert.pem
-</pre>
-
-<p>
-(You can delete <code>ca.info</code> file now if you
-want).
-</p>
-
-<p>
-Now you have two files which matter:
-</p>
-
-<ul>
-<li>
-<code>cakey.pem</code> - Your CA's private key (keep this very secret!)
-</li>
-<li>
-<code>cacert.pem</code> - Your CA's certificate (this is public).
-</li>
-</ul>
-
-<p>
-<code>cacert.pem</code> has to be installed on clients and
-server(s) to let them know that they can trust certificates issued by
-your CA.
-</p>
-
-<p>
-The normal installation directory for <code>cacert.pem</code>
-is <code>/etc/pki/CA/cacert.pem</code> on all clients and servers.
-</p>
-
-<p>
-To see the contents of this file, do:
-</p>
-
-<pre>
-<b>certtool -i --infile cacert.pem</b>
-
-X.509 certificate info:
-
-Version: 3
-Serial Number (hex): 00
-Subject: CN=Red Hat Emerging Technologies
-Issuer: CN=Red Hat Emerging Technologies
-Signature Algorithm: RSA-SHA
-Validity:
- Not Before: Mon Jun 18 16:22:18 2007
- Not After: Tue Jun 17 16:22:18 2008
-<i>[etc]</i>
-</pre>
-
-<p>
-This is all that is required to set up your CA. Keep the CA's private
-key carefully as you will need it when you come to issue certificates
-for your clients and servers.
-</p>
-
-<h4><a name="Remote_TLS_server_certificates">Issuing server certificates</a></h4>
-
-<p>
-For each server (libvirtd) you need to issue a certificate
-with the X.509 CommonName (CN) field set to the hostname
-of the server. The CN must match the hostname which
-clients will be using to connect to the server.
-</p>
-
-<p>
-In the example below, clients will be connecting to the
-server using a <a href="#Remote_URI_reference">URI</a> of
-<code>xen://oirase/</code>, so the CN must be "<code>oirase</code>".
-</p>
-
-<p>
-Make a private key for the server:
-</p>
-
-<pre>
-certtool --generate-privkey > serverkey.pem
-</pre>
-
-<p>
-and sign that key with the CA's private key by first
-creating a template file called <code>server.info</code>
-(only the CN field matters, which as explained above must
-be the server's hostname):
-</p>
-
-<pre>
-organization = <i>Name of your organization</i>
-cn = oirase
-tls_www_server
-encryption_key
-signing_key
-</pre>
-
-<p>
-and sign:
-</p>
-
-<pre>
-certtool --generate-certificate --load-privkey serverkey.pem \
- --load-ca-certificate cacert.pem --load-ca-privkey cakey.pem \
- --template server.info --outfile servercert.pem
-</pre>
-
-<p>
-This gives two files:
-</p>
-
-<ul>
-<li>
-<code>serverkey.pem</code> - The server's private key.
-</li>
-<li>
-<code>servercert.pem</code> - The server's public key.
-</li>
-</ul>
-
-<p>
-We can examine this certificate and its signature:
-</p>
-
-<pre>
-<b>certtool -i --infile servercert.pem</b>
-X.509 certificate info:
-
-Version: 3
-Serial Number (hex): 00
-Subject: O=Red Hat Emerging Technologies,CN=oirase
-Issuer: CN=Red Hat Emerging Technologies
-Signature Algorithm: RSA-SHA
-Validity:
- Not Before: Mon Jun 18 16:34:49 2007
- Not After: Tue Jun 17 16:34:49 2008
-</pre>
-
-<p>
-Note the "Issuer" CN is "Red Hat Emerging Technologies" (the CA) and
-the "Subject" CN is "oirase" (the server).
-</p>
-
-<p>
-Finally we have two files to install:
-</p>
-
-<ul>
-<li>
-<code>serverkey.pem</code> is
-the server's private key which should be copied to the
-server <i>only</i> as
-<code>/etc/pki/libvirt/private/serverkey.pem</code>.
-</li>
-
-<li>
-<code>servercert.pem</code> is the server's certificate
-which can be installed on the server as
-<code>/etc/pki/libvirt/servercert.pem</code>.
-</li>
-</ul>
-
-<h4><a name="Remote_TLS_client_certificates">Issuing client certificates</a></h4>
-
-<p>
-For each client (ie. any program linked with libvirt, such as
-<a href="http://virt-manager.et.redhat.com/">virt-manager</a>)
-you need to issue a certificate with the X.509 Distinguished Name (DN)
-set to a suitable name. You can decide this on a company / organisation
-policy. For example, I use:
-</p>
-
-<pre>
-C=GB,ST=London,L=London,O=Red Hat,CN=<i>name_of_client</i>
-</pre>
-
-<p>
-The process is the same as for
-<a href="#Remote_TLS_server_certificates">setting up the
-server certificate</a> so here we just briefly cover the
-steps.
-</p>
-
-<ol>
-<li>
-Make a private key:
-<pre>
-certtool --generate-privkey > clientkey.pem
-</pre>
-</li>
-
-<li>
-Act as CA and sign the certificate. Create client.info containing:
-<pre>
-country = GB
-state = London
-locality = London
-organization = Red Hat
-cn = client1
-tls_www_client
-encryption_key
-signing_key
-</pre>
-and sign by doing:
-<pre>
-certtool --generate-certificate --load-privkey clientkey.pem \
- --load-ca-certificate cacert.pem --load-ca-privkey cakey.pem \
- --template client.info --outfile clientcert.pem
-</pre>
-</li>
-
-<li>
-Install the certificates on the client machine:
-<pre>
-cp clientkey.pem /etc/pki/libvirt/private/clientkey.pem
-cp clientcert.pem /etc/pki/libvirt/clientcert.pem
-</pre>
-</li>
-</ol>
-
-
-<h4><a name="Remote_TLS_troubleshooting">Troubleshooting TLS certificate problems</a></h4>
-
-<dl>
-<dt> failed to verify client's certificate </dt>
-<dd>
-<p>
-On the server side, run the libvirtd server with
-the '--listen' and '--verbose' options while the
-client is connecting. The verbose log messages should
-tell you enough to diagnose the problem.
-</p>
-</dd>
-</dl>
-<p> You can use the <a href="pki_check.sh">pki_check.sh</a> shell script
-to analyze the setup on the client or server machines, preferably as root.
-It will try to point out the possible problems and provide solutions to
-fix the set up up to a point where you have secure remote access.</p>
-
-
-<h3><a name="Remote_libvirtd_configuration">libvirtd configuration file</a></h3>
-
-<p>
-Libvirtd (the remote daemon) is configured from a file called
-<code>/etc/libvirt/libvirtd.conf</code>, or specified on
-the command line using <code>-f filename</code> or
-<code>--config filename</code>.
-</p>
-
-<p>
-This file should contain lines of the form below.
-Blank lines and comments beginning with <code>#</code> are ignored.
-</p>
-<pre>setting = value</pre>
-<p>The following settings, values and default are:</p>
-
-<table class="top_table">
-<tr>
-<th> Line </th>
-<th> Default </th>
-<th> Meaning </th>
-</tr>
-
-<tr>
-<td> listen_tls <i>[0|1]</i> </td>
-<td> 1 (on) </td>
-<td>
- Listen for secure TLS connections on the public TCP/IP port.
-</td>
-</tr>
-
-<tr>
-<td> listen_tcp <i>[0|1]</i> </td>
-<td> 0 (off) </td>
-<td>
- Listen for unencrypted TCP connections on the public TCP/IP port.
-</td>
-</tr>
-
-<tr>
-<td> tls_port <i>"service"</i> </td>
-<td> "16514" </td>
-<td>
- The port number or service name to listen on for secure TLS connections.
-</td>
-</tr>
-
-<tr>
-<td> tcp_port <i>"service"</i> </td>
-<td> "16509" </td>
-<td>
- The port number or service name to listen on for unencrypted TCP connections.
-</td>
-</tr>
-
-<tr>
-<td> mdns_adv <i>[0|1]</i> </td>
-<td> 1 (advertise with mDNS) </td>
-<td>
- If set to 1 then the virtualization service will be advertised over
- mDNS to hosts on the local LAN segment.
-</td>
-</tr>
-
-<tr>
-<td> mdns_name <i>"name"</i> </td>
-<td> "Virtualization Host HOSTNAME" </td>
-<td>
- The name to advertise for this host with Avahi mDNS. The default
- includes the machine's short hostname. This must be unique to the
- local LAN segment.
-</td>
-</tr>
-
-<tr>
-<td> unix_sock_group <i>"groupname"</i> </td>
-<td> "root" </td>
-<td>
- The UNIX group to own the UNIX domain socket. If the socket permissions allow
- group access, then applications running under matching group can access the
- socket. Only valid if running as root
-</td>
-</tr>
-
-<tr>
-<td> unix_sock_ro_perms <i>"octal-perms"</i> </td>
-<td> "0777" </td>
-<td>
- The permissions for the UNIX domain socket for read-only client connections.
- The default allows any user to monitor domains.
-</td>
-</tr>
-
-<tr>
-<td> unix_sock_rw_perms <i>"octal-perms"</i> </td>
-<td> "0700" </td>
-<td>
- The permissions for the UNIX domain socket for read-write client connections.
- The default allows only root to manage domains.
-</td>
-</tr>
-
-<tr>
-<td> tls_no_verify_certificate <i>[0|1]</i> </td>
-<td> 0 (certificates are verified) </td>
-<td>
- If set to 1 then if a client certificate check fails, it is not an error.
-</td>
-</tr>
-
-<tr>
-<td> tls_no_verify_address <i>[0|1]</i> </td>
-<td> 0 (addresses are verified) </td>
-<td>
- If set to 1 then if a client IP address check fails, it is not an error.
-</td>
-</tr>
-
-<tr>
-<td> key_file <i>"filename"</i> </td>
-<td> "/etc/pki/libvirt/ private/serverkey.pem" </td>
-<td>
- Change the path used to find the server's private key.
- If you set this to an empty string, then no private key is loaded.
-</td>
-</tr>
-
-<tr>
-<td> cert_file <i>"filename"</i> </td>
-<td> "/etc/pki/libvirt/ servercert.pem" </td>
-<td>
- Change the path used to find the server's certificate.
- If you set this to an empty string, then no certificate is loaded.
-</td>
-</tr>
-
-<tr>
-<td> ca_file <i>"filename"</i> </td>
-<td> "/etc/pki/CA/cacert.pem" </td>
-<td>
- Change the path used to find the trusted CA certificate.
- If you set this to an empty string, then no trusted CA certificate is loaded.
-</td>
-</tr>
-
-<tr>
-<td> crl_file <i>"filename"</i> </td>
-<td> (no CRL file is used) </td>
-<td>
- Change the path used to find the CA certificate revocation list (CRL) file.
- If you set this to an empty string, then no CRL is loaded.
-</td>
-</tr>
-
-<tr>
-<td> tls_allowed_dn_list ["DN1", "DN2"] </td>
-<td> (none - DNs are not checked) </td>
-<td>
- <p>
- Enable an access control list of client certificate Distinguished
- Names (DNs) which can connect to the TLS port on this server.
- </p>
- <p>
- The default is that DNs are not checked.
- </p>
- <p>
- This list may contain wildcards such as <code>"C=GB,ST=London,L=London,O=Red Hat,CN=*"</code>
- See the POSIX <code>fnmatch</code> function for the format
- of the wildcards.
- </p>
- <p>
- Note that if this is an empty list, <i>no client can connect</i>.
- </p>
- <p>
- Note also that GnuTLS returns DNs without spaces
- after commas between the fields (and this is what we check against),
- but the <code>openssl x509</code> tool shows spaces.
-</td>
-</tr>
-
-<tr>
-<td> tls_allowed_ip_list ["ip1", "ip2", "ip3"] </td>
-<td> (none - clients can connect from anywhere) </td>
-<td>
- <p>
- Enable an access control list of the IP addresses of clients
- who can connect to the TLS or TCP ports on this server.
- </p>
- <p>
- The default is that clients can connect from any IP address.
- </p>
- <p>
- This list may contain wildcards such as <code>192.168.*</code>
- See the POSIX <code>fnmatch</code> function for the format
- of the wildcards.
- </p>
- <p>
- Note that if this is an empty list, <i>no client can connect</i>.
- </p>
-</td>
-</tr>
-</table>
-
-
-<h3><a name="Remote_IPv6">IPv6 support</a></h3>
-
-<p>
-The libvirtd service and libvirt remote client driver both use the
-<code>getaddrinfo()</code> functions for name resolution and are
-thus fully IPv6 enabled. ie, if a server has IPv6 address configured
-the daemon will listen for incoming connections on both IPv4 and IPv6
-protocols. If a client has an IPv6 address configured and the DNS
-address resolved for a service is reachable over IPv6, then an IPv6
-connection will be made, otherwise IPv4 will be used. In summary it
-should just 'do the right thing(tm)'.
-</p>
-
-<h3><a name="Remote_limitations">Limitations</a></h3>
-
-<ul>
-<li> Remote storage: To be fully useful, particularly for
-creating new domains, it should be possible to enumerate
-and provision storage on the remote machine. This is currently
-in the design phase. </li>
-
-<li> Migration: We expect libvirt will support migration,
-and obviously remote support is what makes migration worthwhile.
-This is also in the design phase. Issues <a
-href="https://www.redhat.com/mailman/listinfo/libvir-list"
-title="libvir-list mailing list">to discuss</a> include
-which path the migration data should follow (eg. client to
-client direct, or client to server to client) and security.
-</li>
-
-<li> Fine-grained authentication: libvirt in general,
-but in particular the remote case should support more
-fine-grained authentication for operations, rather than
-just read-write/read-only as at present.
-</li>
-</ul>
-
-<p>
-Please come and discuss these issues and more on <a
-href="https://www.redhat.com/mailman/listinfo/libvir-list"
-title="libvir-list mailing list">the mailing list</a>.
-</p>
-
-<h3><a name="Remote_implementation_notes">Implementation notes</a></h3>
-
-<p>
-The current implementation uses <a
-href="http://en.wikipedia.org/wiki/External_Data_Representation"
-title="External Data Representation">XDR</a>-encoded packets with a
-simple remote procedure call implementation which also supports
-asynchronous messaging and asynchronous and out-of-order replies,
-although these latter features are not used at the moment.
-</p>
-
-<p>
-The implementation should be considered <b>strictly internal</b> to
-libvirt and <b>subject to change at any time without notice</b>. If
-you wish to talk to libvirtd, link to libvirt. If there is a problem
-that means you think you need to use the protocol directly, please
-first discuss this on <a
-href="https://www.redhat.com/mailman/listinfo/libvir-list"
-title="libvir-list mailing list">the mailing list</a>.
-</p>
-
-<p>
-The messaging protocol is described in
-<code>qemud/remote_protocol.x</code>.
-</p>
-
-<p>
-Authentication and encryption (for TLS) is done using <a
-href="http://www.gnu.org/software/gnutls/" title="GnuTLS project
-page">GnuTLS</a> and the RPC protocol is unaware of this layer.
-</p>
-
-<p>
-Protocol messages are sent using a simple 32 bit length word (encoded
-XDR int) followed by the message header (XDR
-<code>remote_message_header</code>) followed by the message body. The
-length count includes the length word itself, and is measured in
-bytes. Maximum message size is <code>REMOTE_MESSAGE_MAX</code> and to
-avoid denial of services attacks on the XDR decoders strings are
-individually limited to <code>REMOTE_STRING_MAX</code> bytes. In the
-TLS case, messages may be split over TLS records, but a TLS record
-cannot contain parts of more than one message. In the common RPC case
-a single <code>REMOTE_CALL</code> message is sent from client to
-server, and the server then replies synchronously with a single
-<code>REMOTE_REPLY</code> message, but other forms of messaging are
-also possible.
-</p>
-
-<p>
-The protocol contains support for multiple program types and protocol
-versioning, modelled after SunRPC.
-</p>
-
-<h2><a name="ACL">Access control</a></h2>
-
-<p>
-When connecting to libvirt, some connections may require client
-authentication before allowing use of the APIs. The set of possible
-authentication mechanisms is administrator controlled, independent
-of applications using libvirt.
-</p>
-
-<ul>
- <li><a href="#ACL_server_config">Server configuration</a></li>
- <li><a href="#ACL_server_unix_perms">UNIX socket permissions/group</a></li>
- <li><a href="#ACL_server_polkit">UNIX socket PolicyKit auth</a></li>
- <li><a href="#ACL_server_username">Username/password auth</a></li>
- <li><a href="#ACL_server_kerberos">Kerberos auth</a></li>
-</ul>
-
-<h3 name="ACL_server_config">Server configuration</h3>
-
-<p>
-The libvirt daemon allows the administrator to choose the authentication
-mechanisms used for client connections on each network socket independently.
-This is primarily controlled via the libvirt daemon master config file in
-<code>/etc/libvirt/libvirtd.conf</code>. Each of the libvirt sockets can
-have its authentication mechanism configured independently. There is
-currently a choice of <code>none</code>, <code>polkit</code>, and <code>sasl</code>.
-The SASL scheme can be further configured to choose between a large
-number of different mechanisms.
-</p>
-
-<h3 name="ACL_server_unix_perms">UNIX socket permissions/group</h3>
-
-<p>
-If libvirt does not contain support for PolicyKit, then access control for
-the UNIX domain socket is done using traditional file user/group ownership
-and permissions. There are 2 sockets, one for full read-write access, the
-other for read-only access. The RW socket will be restricted (mode 0700) to
-only allow the <code>root</code> user to connect. The read-only socket will
-be open access (mode 0777) to allow any user to connect.
-</p>
-
-<p>
-To allow non-root users greater access, the <code>libvirtd.conf</code> file
-can be edited to change the permissions via the <code>unix_sock_rw_perms</code>,
-config parameter and to set a user group via the <code>unix_sock_group</code>
-parameter. For example, setting the former to mode <code>0770</code> and the
-latter <code>wheel</code> would let any user in the wheel group connect to
-the libvirt daemon.
-</p>
-
-<h3 name="ACL_server_polkit">UNIX socket PolicyKit auth</h3>
-
-<p>
-If libvirt contains support for PolicyKit, then access control options are
-more advanced. The <code>unix_sock_auth</code> parameter will default to
-<code>polkit</code>, and the file permissions will default to <code>0777</code>
-even on the RW socket. Upon connecting to the socket, the client application
-will be required to identify itself with PolicyKit. The default policy for the
-RW daemon socket will require any application running in the current desktop
-session to authenticate using the user's password. This is akin to <code>sudo</code>
-auth, but does not require that the client application ultimately run as root.
-Default policy will still allow any application to connect to the RO socket.
-</p>
-
-<p>
-The default policy can be overridden by the administrator using the PolicyKit
-master configuration file in <code>/etc/PolicyKit/PolicyKit.conf</code>. The
-<code>PolicyKit.conf(5)</code> manual page provides details on the syntax
-available. The two libvirt daemon actions available are named <code>org.libvirt.unix.monitor</code>
-for the RO socket, and <code>org.libvirt.unix.manage</code> for the RW socket.
-</p>
-
-<p>
-As an example, to allow a user <code>fred</code>full access to the RW socket,
-while requiring <code>joe</code> to authenticate with the admin password,
-would require adding the following snippet to <code>PolicyKit.conf</code>.
-</p>
-
-<pre>
- <match action="org.libvirt.unix.manage" user="fred">
- <return result="yes"/>
- </match>
- <match action="org.libvirt.unix.manage" user="joe">
- <return result="auth_admin"/>
- </match>
-</pre>
-
-<h3 name="ACL_server_username">Username/password auth</h3>
-
-<p>
-The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
-The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
-username+password style authentication. It also provides for encryption of the data
-stream, so the security of the plain TCP socket is on a par with that of the TLS
-socket. If desired the UNIX socket and TLS socket can also have SASL enabled by
-setting the <code>auth_unix_ro</code>, <code>auth_unix_rw</code>, <code>auth_tls</code>
-config params in <code>libvirt.conf</code>.
-</p>
-
-<p>
-Out of the box, no user accounts are defined, so no clients will be able to authenticate
-on the TCP socket. Adding users and setting their passwords is done with the <code>saslpasswd2</code>
-command. When running this command it is important to tell it that the appname is <code>libvirt</code>.
-As an example, to add a user <code>fred</code>, run
-</p>
-
-<pre>
-# saslpasswd2 -a libvirt fred
-Password: xxxxxx
-Again (for verification): xxxxxx
-</pre>
-
-<p>
-To see a list of all accounts the <code>sasldblistusers2</code> command can be used.
-This command expects to be given the path to the libvirt user database, which is kept
-in <code>/etc/libvirt/passwd.db</code>
-</p>
-
-<pre>
-# sasldblistusers2 -f /etc/libvirt/passwd.db
-fred@t60wlan.home.berrange.com: userPassword
-</pre>
-
-<p>
-Finally, to disable a user's access, the <code>saslpasswd2</code> command can be used
-again:
-</p>
-
-<pre>
-# saslpasswd2 -a libvirt -d fred
-</pre>
-
-
-<h3 name="ACL_server_kerberos">Kerberos auth</h3>
-
-<p>
-The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
-The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
-username+password style authentication. To enable Kerberos single-sign-on instead,
-the libvirt SASL configuration file must be changed. This is <code>/etc/sasl2/libvirt.conf</code>.
-The <code>mech_list</code> parameter must first be changed to <code>gssapi</code>
-instead of the default <code>digest-md5</code>. If SASL is enabled on the UNIX
-and/or TLS sockets, Kerberos will also be used for them. Like DIGEST-MD5, the Kerberos
-mechanism provides data encryption of the session.
-</p>
-
-<p>
-Some operating systems do not install the SASL kerberos plugin by default. It
-may be necessary to install a sub-package such as <code>cyrus-sasl-gssapi</code>.
-To check whether the Kerberos plugin is installed run the <code>pluginviewer</code>
-program and verify that <code>gssapi</code> is listed,eg:
-</p>
-
-<pre>
-# pluginviewer
-...snip...
-Plugin "gssapiv2" [loaded], API version: 4
- SASL mechanism: GSSAPI, best SSF: 56
- security flags: NO_ANONYMOUS|NO_PLAINTEXT|NO_ACTIVE|PASS_CREDENTIALS|MUTUAL_AUTH
- features: WANT_CLIENT_FIRST|PROXY_AUTHENTICATION|NEED_SERVER_FQDN
-</pre>
-
-<p>
-Next is is necessary for the administrator of the Kerberos realm to issue a principle
-for the libvirt server. There needs to be one principle per host running the libvirt
-daemon. The principle should be named <code>libvirt/full.hostname@KERBEROS.REALM</code>.
-This is typically done by running the <code>kadmin.local</code> command on the Kerberos
-server, though some Kerberos servers have alternate ways of setting up service principles.
-Once created, the principle should be exported to a keytab, copied to the host running
-the libvirt daemon and placed in <code>/etc/libvirt/krb5.tab</code>
-</p>
-
-<pre>
-# kadmin.local
-kadmin.local: add_principal libvirt/foo.example.com
-Enter password for principal "libvirt/foo.example.com@EXAMPLE.COM":
-Re-enter password for principal "libvirt/foo.example.com@EXAMPLE.COM":
-Principal "libvirt/foo.example.com@EXAMPLE.COM" created.
-
-kadmin.local: ktadd -k /root/libvirt-foo-example.tab libvirt/foo.example.com@EXAMPLE.COM
-Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type Triple DES cbc mode with HMAC/sha1 added to keytab WRFILE:/root/libvirt-foo-example.tab.
-Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type ArcFour with HMAC/md5 added to keytab WRFILE:/root/libvirt-foo-example.tab.
-Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type DES with HMAC/sha1 added to keytab WRFILE:/root/libvirt-foo-example.tab.
-Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type DES cbc mode with RSA-MD5 added to keytab WRFILE:/root/libvirt-foo-example.tab.
-
-kadmin.local: quit
-
-# scp /root/libvirt-foo-example.tab root@foo.example.com:/etc/libvirt/krb5.tab
-# rm /root/libvirt-foo-example.tab
-</pre>
-
-<p>
-Any client application wishing to connect to a Kerberos enabled libvirt server
-merely needs to run <code>kinit</code> to gain a user principle. This may well
-be done automatically when a user logs into a desktop session, if PAM is setup
-to authenticate against Kerberos.
-</p>
-
-<h2><a name="uri">Connection URIs</a></h2>
-
-<p>
-Since libvirt supports many different kinds of virtualization
-(often referred to as "drivers" or "hypervisors"), we need a
-way to be able to specify which driver a connection refers to.
-Additionally we may want to refer to a driver on a remote
-machine over the network.
-</p>
-
-<p>
-To this end, libvirt uses URIs as used on the Web and as defined in <a
-href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>. This page
-documents libvirt URIs.
-</p>
-
-<ul>
- <li><a href="#URI_libvirt">Specifying URIs to libvirt</a></li>
- <li><a href="#URI_virsh">Specifying URIs to virsh, virt-manager and virt-install</a></li>
- <li><a href="#URI_xen">xen:/// URI</a></li>
- <li><a href="#URI_qemu">qemu:///... QEMU and KVM URIs</a></li>
- <li><a href="#URI_remote">Remote URIs</a></li>
- <li><a href="#URI_test">test:///... Test URIs</a></li>
- <li><a href="#URI_legacy">Other & legacy URI formats</a></li>
-</ul>
-
-<h3><a name="URI_libvirt">Specifying URIs to libvirt</a></h3>
-
-<p>
-The URI is passed as the <code>name</code> parameter to <a href="html/libvirt-libvirt.html#virConnectOpen"><code>virConnectOpen</code></a> or <a href="html/libvirt-libvirt.html#virConnectOpenReadOnly"><code>virConnectOpenReadOnly</code></a>. For example:
-</p>
-
-<pre>
-virConnectPtr conn = virConnectOpenReadOnly (<b>"test:///default"</b>);
-</pre>
-
-<h3><a name="URI_virsh">Specifying URIs to virsh, virt-manager and virt-install</a></h3>
-
-<p>
-In virsh use the <code>-c</code> or <code>--connect</code> option:
-</p>
-
-<pre>
-virsh <b>-c test:///default</b> list
-</pre>
-
-<p>
-If virsh finds the environment variable
-<code>VIRSH_DEFAULT_CONNECT_URI</code> set, it will try this URI by
-default.
-</p>
-
-<p>
-When using the interactive virsh shell, you can also use the
-<code>connect</code> <i>URI</i> command to reconnect to another
-hypervisor.
-</p>
-
-<p>
-In virt-manager use the <code>-c</code> or <code>--connect=</code><i>URI</i> option:
-</p>
-
-<pre>
-virt-manager <b>-c test:///default</b>
-</pre>
-
-<p>
-In virt-install use the <code>--connect=</code><i>URI</i> option:
-</p>
-
-<pre>
-virt-install <b>--connect=test:///default</b> <i>[other options]</i>
-</pre>
-
-<h3><a name="URI_xen">xen:/// URI</a></h3>
-
-<p><i>This section describes a feature which is new in libvirt >
-0.2.3. For libvirt ≤ 0.2.3 use <a href="#URI_legacy_xen"><code>"xen"</code></a>.</i>
-</p>
-
-<p>
-To access a Xen hypervisor running on the local machine
-use the URI <code>xen:///</code>.
-</p>
-
-<h3><a name="URI_qemu">qemu:///... QEMU and KVM URIs</a></h3>
-
-<p>
-To use QEMU support in libvirt you must be running the
-<code>libvirtd</code> daemon (named <code>libvirt_qemud</code>
-in releases prior to 0.3.0). The purpose of this
-daemon is to manage qemu instances.
-</p>
-
-<p>
-The <code>libvirtd</code> daemon should be started by the
-init scripts when the machine boots. It should appear as
-a process <code>libvirtd --daemon</code> running as root
-in the background and will handle qemu instances on behalf
-of all users of the machine (among other things). </p>
-
-<p>
-So to connect to the daemon, one of two different URIs is used:
-</p>
-
-<ul>
-<li> <code>qemu:///system</code> connects to a system mode daemon. </li>
-<li> <code>qemu:///session</code> connects to a session mode daemon. </li>
-</ul>
-
-<p>
-(If you do <code>libvirtd --help</code>, the daemon will print
-out the paths of the Unix domain socket(s) that it listens on in
-the various different modes).
-</p>
-
-<p>
-KVM URIs are identical. You select between qemu, qemu accelerated and
-KVM guests in the <a href="format.html#KVM1">guest XML as described
-here</a>.
-</p>
-
-<h3><a name="URI_remote">Remote URIs</a></h3>
-
-<p>
-Remote URIs are formed by taking ordinary local URIs and adding a
-hostname and/or transport name. For example:
-</p>
-
-<table class="top_table">
-<tr>
-<th> Local URI </th>
-<th> Remote URI </th>
-<th> Meaning </th>
-</tr>
-
-<tr>
-<td> <code>xen:///</code> </td>
-<td> <code>xen://oirase/</code> </td>
-<td> Connect to the Xen hypervisor running on host <code>oirase</code>
- using TLS. </td>
-</tr>
-
-<tr>
-<td> <code>xen:///</code> </td>
-<td> <code>xen+ssh://oirase/</code> </td>
-<td> Connect to the Xen hypervisor running on host <code>oirase</code>
- by going over an <code>ssh</code> connection. </td>
-</tr>
-
-<tr>
-<td> <code>test:///default</code> </td>
-<td> <code>test+tcp://oirase/default</code> </td>
-<td> Connect to the test driver on host <code>oirase</code>
- using an unsecured TCP connection. </td>
-</tr>
-</table>
-
-<p>
-Remote URIs in libvirt offer a rich syntax and many features.
-We refer you to <a href="remote.html#Remote_URI_reference">the libvirt
-remote URI reference</a> and <a href="remote.html">full documentation
-for libvirt remote support</a>.
-</p>
-
-<h3><a name="URI_test">test:///... Test URIs</a></h3>
-
-<p>
-The test driver is a dummy hypervisor for test purposes.
-The URIs supported are:
-</p>
-
-<ul>
-<li> <code>test:///default</code> connects to a default set of
-host definitions built into the driver. </li>
-<li> <code>test:///path/to/host/definitions</code> connects to
-a set of host definitions held in the named file.
-</ul>
-
-<h3><a name="URI_legacy">Other & legacy URI formats</a></h3>
-
-<h4><a name="URI_NULL">NULL and empty string URIs</a></h4>
-
-<p>
-Libvirt allows you to pass a <code>NULL</code> pointer to
-<code>virConnectOpen*</code>. Empty string (<code>""</code>) acts in
-the same way. Traditionally this has meant
-<q>connect to the local Xen hypervisor</q>. However in future this
-may change to mean <q>connect to the best available hypervisor</q>.
-</p>
-
-<p>
-The theory is that if, for example, Xen is unavailable but the
-machine is running an OpenVZ kernel, then we should not try to
-connect to the Xen hypervisor since that is obviously the wrong
-thing to do.
-</p>
-
-<p>
-In any case applications linked to libvirt can continue to pass
-<code>NULL</code> as a default choice, but should always allow the
-user to override the URI, either by constructing one or by allowing
-the user to type a URI in directly (if that is appropriate). If your
-application wishes to connect specifically to a Xen hypervisor, then
-for future proofing it should choose a full <a
-href="#URI_xen"><code>xen:///</code> URI</a>.
-</p>
-
-<h4><a name="URI_file">File paths (xend-unix-server)</a></h4>
-
-<p>
-If XenD is running and configured in <code>/etc/xen/xend-config.sxp</code>:
-</p>
-
-<pre>
-(xend-unix-server yes)
-</pre>
-
-<p>
-then it listens on a Unix domain socket, usually at
-<code>/var/lib/xend/xend-socket</code>. You may pass a different path
-using a file URI such as:
-</p>
-
-<pre>
-virsh -c ///var/run/xend/xend-socket
-</pre>
-
-<h4><a name="URI_http">Legacy: <code>http://...</code> (xend-http-server)</a></h4>
-
-<p>
-If XenD is running and configured in <code>/etc/xen/xend-config.sxp</code>:
-
-<pre>
-(xend-http-server yes)
-</pre>
-
-<p>
-then it listens on TCP port 8000. libvirt allows you to
-try to connect to xend running on remote machines by passing
-<code>http://<i>hostname</i>[:<i>port</i>]/</code>, for example:
-
-<pre>
-virsh -c http://oirase/ list
-</pre>
-
-<p>
-This method is unencrypted and insecure and is definitely not
-recommended for production use. Instead use <a
-href="remote.html">libvirt's remote support</a>.
-</p>
-
-<p>
-Notes:
-</p>
-
-<ol>
-<li> The HTTP client does not fully support IPv6. </li>
-<li> Many features do not work as expected across HTTP connections, in
- particular, <a
- href="html/libvirt-libvirt.html#virConnectGetCapabilities">virConnectGetCapabilities</a>.
- The <a href="remote.html">remote support</a> however does work
- correctly. </li>
-<li> XenD's new-style XMLRPC interface is not supported by
- libvirt, only the old-style sexpr interface known in the Xen
- documentation as "unix server" or "http server".</li>
-</ol>
-
-<h4><a name="URI_legacy_xen">Legacy: <code>"xen"</code></a></h4>
-
-<p>
-Another legacy URI is to specify name as the string
-<code>"xen"</code>. This will continue to refer to the Xen
-hypervisor. However you should prefer a full <a
-href="#URI_xen"><code>xen:///</code> URI</a> in all future code.
-</p>
-
-<h4><a name="URI_http">Legacy: Xen proxy</a></h4>
-
-<p>
-Libvirt continues to support connections to a separately running Xen
-proxy daemon. This provides a way to allow non-root users to make a
-safe (read-only) subset of queries to the hypervisor.
-</p>
-
-<p>
-There is no specific "Xen proxy" URI. However if a Xen URI of any of
-the ordinary or legacy forms is used (eg. <code>NULL</code>,
-<code>""</code>, <code>"xen"</code>, ...) which fails, <i>and</i> the
-user is not root, <i>and</i> the Xen proxy socket can be connected to
-(<code>/tmp/libvirt_proxy_conn</code>), then libvirt will use a proxy
-connection.
-</p>
-
-<p>
-You should consider using <a href="remote.html">libvirt remote support</a>
-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-08-20</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> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectGetCapabilities </td>
- <td> 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectGetHostname </td>
- <td> 0.3.0 </td>
- <td> ≥ 0.3.0 </td>
- <td> ≥ 0.3.3 </td>
- <td> ≥ 0.3.3 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectGetMaxVcpus </td>
- <td> 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectGetType </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectGetURI </td>
- <td> 0.3.0 </td>
- <td> ≥ 0.3.0 </td>
- <td> ≥ 0.3.0 </td>
- <td> ≥ 0.3.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectGetVersion </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectListDefinedDomains </td>
- <td> 0.1.5 </td>
- <td> ≥ 0.1.9 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectListDomains </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectNumOfDefinedDomains </td>
- <td> 0.1.5 </td>
- <td> ≥ 0.1.9 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectNumOfDomains </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectOpen </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virConnectOpenReadOnly </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainAttachDevice </td>
- <td> 0.1.9 </td>
- <td> ≥ 0.1.9 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainBlockStats </td>
- <td> 0.3.2 </td>
- <td> ≥ 0.3.2 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.2 </td>
-</tr>
-<tr>
- <td> virDomainCoreDump </td>
- <td> 0.1.9 </td>
- <td> ≥ 0.1.9 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainCreate </td>
- <td> 0.1.5 </td>
- <td> ≥ 0.1.9 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainCreateLinux </td>
- <td> All </td>
- <td> ≥ 0.0.5 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainDefineXML </td>
- <td> 0.1.5 </td>
- <td> ≥ 0.1.9 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainDestroy </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainDetachDevice </td>
- <td> 0.1.9 </td>
- <td> ≥ 0.1.9 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainFree </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetAutostart </td>
- <td> 0.2.1 </td>
- <td> x </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 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> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetInfo </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetMaxMemory </td>
- <td> All </td>
- <td> All </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetMaxVcpus </td>
- <td> 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetName </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetOSType </td>
- <td> All </td>
- <td> All </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetSchedulerParameters </td>
- <td> 0.2.3 </td>
- <td> ≥ 0.2.3 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetSchedulerType </td>
- <td> 0.2.3 </td>
- <td> ≥ 0.2.3 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetUUID </td>
- <td> 0.1.10 </td>
- <td> ≥ 0.1.10 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetUUIDString </td>
- <td> 0.1.10 </td>
- <td> ≥ 0.1.10 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainGetVcpus </td>
- <td> 0.1.4 </td>
- <td> ≥ 0.1.4 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainInterfaceStats </td>
- <td> 0.3.2 </td>
- <td> ≥ 0.3.2 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.2 </td>
-</tr>
-<tr>
- <td> virDomainGetXMLDesc </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainLookupByID </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainLookupByName </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainLookupByUUID </td>
- <td> 0.1.10 </td>
- <td> ≥ 0.1.10 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainLookupByUUIDString </td>
- <td> 0.1.10 </td>
- <td> ≥ 0.1.10 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainMigrate </td>
- <td> 0.3.2 </td>
- <td> ≥ 0.3.2 </td>
- <td> x </td>
- <td> x </td>
- <td> 0.3.2 </td>
-</tr>
-<tr>
- <td> virDomainPinVcpu </td>
- <td> 0.1.4 </td>
- <td> ≥ 0.1.4 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainReboot </td>
- <td> 0.1.0 </td>
- <td> ≥ 0.1.0 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainRestore </td>
- <td> All </td>
- <td> All </td>
- <td> x </td>
- <td> ≥ 0.3.2 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainResume </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainSave </td>
- <td> All </td>
- <td> All </td>
- <td> x </td>
- <td> ≥ 0.3.2 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainSetAutostart </td>
- <td> 0.2.1 </td>
- <td> x </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.2.1 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainSetMaxMemory </td>
- <td> All </td>
- <td> All </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainSetMemory </td>
- <td> 0.1.1 </td>
- <td> ≥ 0.1.1 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainSetSchedulerParameters </td>
- <td> 0.2.3 </td>
- <td> ≥ 0.2.3 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainSetVcpus </td>
- <td> 0.1.4 </td>
- <td> ≥ 0.1.4 </td>
- <td> x </td>
- <td> x </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainShutdown </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainSuspend </td>
- <td> All </td>
- <td> All </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virDomainUndefine </td>
- <td> 0.1.5 </td>
- <td> ≥ 0.1.9 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 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> ≥ 0.1.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.2.0 </td>
- <td> ≥ 0.3.0 </td>
-</tr>
-<tr>
- <td> virNodeGetFreeMemory </td>
- <td> 0.3.3 </td>
- <td> ≥ 0.3.3 </td>
- <td> x </td>
- <td> x </td>
- <td> x </td>
-</tr>
-<tr>
- <td> virNodeGetCellsFreeMemory </td>
- <td> 0.3.3 </td>
- <td> ≥ 0.3.3 </td>
- <td> x </td>
- <td> x </td>
- <td> x </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>
-
-<h2><a name="Storage" id="Storage">Storage Management</a></h2>
-
-<p>
-This page describes the storage management capabilities in
-libvirt.
-</p>
-
-<ul>
-<li><a href="#StorageCore">Core concepts</a></li>
-<li><a href="#StoragePool">Storage pool XML</a>
- <ul>
- <li><a href="#StoragePoolFirst">First level elements</a></li>
- <li><a href="#StoragePoolSource">Source elements</a></li>
- <li><a href="#StoragePoolTarget">Target elements</a></li>
- <li><a href="#StoragePoolExtents">Device extents</a></li>
- </ul>
-</li>
-<li><a href="#StorageVol">Storage volume XML</a>
- <ul>
- <li><a href="#StorageVolFirst">First level elements</a></li>
- <li><a href="#StorageVolSource">Source elements</a></li>
- <li><a href="#StorageVolTarget">Target elements</a></li>
- </ul>
-</li>
-<li><a href="#StorageBackend">Storage backend drivers</a>
- <ul>
- <li><a href="#StorageBackendDir">Directory backend</a></li>
- <li><a href="#StorageBackendFS">Local filesystem backend</a></li>
- <li><a href="#StorageBackendNetFS">Network filesystem backend</a></li>
- <li><a href="#StorageBackendLogical">Logical backend</a></li>
- <li><a href="#StorageBackendDisk">Disk backend</a></li>
- <li><a href="#StorageBackendISCSI">iSCSI backend</a></li>
-</ul>
-
-<h3><a name="StorageCore">Core concepts</a></h3>
-
-<p>
-The storage management APIs are based around 2 core concepts
-</p>
-
-<ol>
-<li><strong>Volume</strong> - a single storage volume which can
-be assigned to a guest, or used for creating further pools. A
-volume is either a block device, a raw file, or a special format
-file.</li>
-<li><strong>Pool</strong> - provides a means for taking a chunk
-of storage and carving it up into volumes. A pool can be used to
-manage things such as a physical disk, a NFS server, a iSCSI target,
-a host adapter, an LVM group.</li>
-</ol>
-
-<p>
-These two concepts are mapped through to two libvirt objects, a
-<code>virStorageVolPtr</code> and a <code>virStoragePoolPtr</code>,
-each with a collection of APIs for their management.
-</p>
-
-
-<h3><a name="StoragePool">Storage pool XML</a></h3>
-
-<p>
-Although all storage pool backends share the same public APIs and
-XML format, they have varying levels of capabilities. Some may
-allow creation of volumes, others may only allow use of pre-existing
-volumes. Some may have constraints on volume size, or placement.
-</p>
-
-<p>The is the top level tag for a storage pool document is 'pool'. It has
-a single attribute <code>type</code>, which is one of <code>dir</code>,
-<code>fs</code>,<code>netfs</code>,<code>disk</code>,<code>iscsi</code>,
-<code>logical</code>. This corresponds to the storage backend drivers
-listed further along in this document.
-</p>
-
-
-<h4><a name="StoragePoolFirst">First level elements</a></h4>
-
-<dl>
-<dt>name</dt>
-<dd>Providing a name for the pool which is unique to the host.
-This is mandatory when defining a pool</dd>
-
-<dt>uuid</dt>
-<dd>Providing an identifier for the pool which is globally unique.
-This is optional when defining a pool, a UUID will be generated if
-omitted</dd>
-
-<dt>allocation</dt>
-<dd>Providing the total storage allocation for the pool. This may
-be larger than the sum of the allocation of all volumes due to
-metadata overhead. This value is in bytes. This is not applicable
-when creating a pool.</dd>
-
-<dt>capacity</dt>
-<dd>Providing the total storage capacity for the pool. Due to
-underlying device constraints it may not be possible to use the
-full capacity for storage volumes. This value is in bytes. This
-is not applicable when creating a pool.</dd>
-
-<dt>available</dt>
-<dd>Providing the free space available for allocating new volumes
-in the pool. Due to underlying device constraints it may not be
-possible to allocate the entire free space to a single volume.
-This value is in bytes. This is not applicable when creating a
-pool.</dd>
-
-<dt>source</dt>
-<dd>Provides information about the source of the pool, such as
-the underlying host devices, or remote server</dd>
-
-<dt>target</dt>
-<dd>Provides information about the representation of the pool
-on the local host.</dd>
-</dl>
-
-<h4><a name="StoragePoolSource">Source elements</a></h4>
-
-<dl>
-<dt>device</dt>
-<dd>Provides the source for pools backed by physical devices.
-May be repeated multiple times depending on backend driver. Contains
-a single attribute <code>path</code> which is the fully qualified
-path to the block device node.</dd>
-<dt>directory</dt>
-<dd>Provides the source for pools backed by directories. May
-only occur once. Contains a single attribute <code>path</code>
-which is the fully qualified path to the block device node.</dd>
-<dt>host</dt>
-<dd>Provides the source for pools backed by storage from a
-remote server. Will be used in combination with a <code>directory</code>
-or <code>device</code> element. Contains an attribute <code>name<code>
-which is the hostname or IP address of the server. May optionally
-contain a <code>port</code> attribute for the protocol specific
-port number.</dd>
-<dt>format</dt>
-<dd>Provides information about the format of the pool. This
-contains a single attribute <code>type</code> whose value is
-backend specific. This is typically used to indicate filesystem
-type, or network filesystem type, or partition table type, or
-LVM metadata type. All drivers are required to have a default
-value for this, so it is optional.</dd>
-</dl>
-
-<h4><a name="StoragePoolTarget">Target elements</a></h4>
-
-<dl>
-<dt>path</dt>
-<dd>Provides the location at which the pool will be mapped into
-the local filesystem namespace. For a filesystem/directory based
-pool it will be the name of the directory in which volumes will
-be created. For device based pools it will be the name of the directory in which
-devices nodes exist. For the latter <code>/dev/</code> may seem
-like the logical choice, however, devices nodes there are not
-guaranteed stable across reboots, since they are allocated on
-demand. It is preferable to use a stable location such as one
-of the <code>/dev/disk/by-{path,id,uuid,label</code> locations.
-</dd>
-<dt>permissions<dt>
-<dd>Provides information about the default permissions to use
-when creating volumes. This is currently only useful for directory
-or filesystem based pools, where the volumes allocated are simple
-files. For pools where the volumes are device nodes, the hotplug
-scripts determine permissions. It contains 4 child elements. The
-<code>mode</code> element contains the octal permission set. The
-<code>owner</code> element contains the numeric user ID. The <code>group</code>
-element contains the numeric group ID. The <code>label</code> element
-contains the MAC (eg SELinux) label string.
-</dd>
-</dl>
-
-<h4><a name="StoragePoolExtents">Device extents</a></h4>
-
-<p>
-If a storage pool exposes information about its underlying
-placement / allocation scheme, the <code>device</code> element
-within the <code>source</code> element may contain information
-about its available extents. Some pools have a constraint that
-a volume must be allocated entirely within a single constraint
-(eg disk partition pools). Thus the extent information allows an
-application to determine the maximum possible size for a new
-volume
-</p>
-
-<p>
-For storage pools supporting extent information, within each
-<code>device</code> element there will be zero or more <code>freeExtent</code>
-elements. Each of these elements contains two attributes, <code>start</code>
-and <code>end</code> which provide the boundaries of the extent on the
-device, measured in bytes.
-</p>
-
-<h3><a name="StorageVol">Storage volume XML</a></h3>
-
-<p>
-A storage volume will be either a file or a device node.
-</p>
-
-<h4><a name="StorageVolFirst">First level elements</a></h4>
-
-<dl>
-<dt>name</dt>
-<dd>Providing a name for the pool which is unique to the host.
-This is mandatory when defining a pool</dd>
-
-<dt>uuid</dt>
-<dd>Providing an identifier for the pool which is globally unique.
-This is optional when defining a pool, a UUID will be generated if
-omitted</dd>
-
-<dt>allocation</dt>
-<dd>Providing the total storage allocation for the volume. This
-may be smaller than the logical capacity if the volume is sparsely
-allocated. It may also be larger than the logical capacity if the
-volume has substantial metadata overhead. This value is in bytes.
-If omitted when creating a volume, the volume will be fully
-allocated at time of creation. If set to a value smaller than the
-capacity, the pool has the <strong>option</strong> of deciding
-to sparsely allocate a volume. It does not have to honour requests
-for sparse allocation though.</dd>
-
-<dt>capacity</dt>
-<dd>Providing the logical capacity for the volume. This value is
-in bytes. This is compulsory when creating a volume</dd>
-
-<dt>source</dt>
-<dd>Provides information about the underlying storage allocation
-of the volume. This may not be available for some pool types.</dd>
-
-<dt>target</dt>
-<dd>Provides information about the representation of the volume
-on the local host.</dd>
-</dl>
-
-<h4><a name="StorageVolTarget">Target elements</a></h4>
-
-<dl>
-<dt>path</dt>
-<dd>Provides the location at which the pool will be mapped into
-the local filesystem namespace. For a filesystem/directory based
-pool it will be the name of the directory in which volumes will
-be created. For device based pools it will be the name of the directory in which
-devices nodes exist. For the latter <code>/dev/</code> may seem
-like the logical choice, however, devices nodes there are not
-guaranteed stable across reboots, since they are allocated on
-demand. It is preferrable to use a stable location such as one
-of the <code>/dev/disk/by-{path,id,uuid,label</code> locations.
-</dd>
-<dt>format</dt>
-<dd>Provides information about the pool specific volume format.
-For disk pools it will provide the partition type. For filesystem
-or directory pools it will provide the file format type, eg cow,
-qcow, vmdk, raw. If omitted when creating a volume, the pool's
-default format will be used. The actual format is specified via
-the <code>type</code>. Consult the pool-specific docs for the
-list of valid values.</dd>
-<dt>permissions<dt>
-<dd>Provides information about the default permissions to use
-when creating volumes. This is currently only useful for directory
-or filesystem based pools, where the volumes allocated are simple
-files. For pools where the volumes are device nodes, the hotplug
-scripts determine permissions. It contains 4 child elements. The
-<code>mode</code> element contains the octal permission set. The
-<code>owner</code> element contains the numeric user ID. The <code>group</code>
-element contains the numeric group ID. The <code>label</code> element
-contains the MAC (eg SELinux) label string.
-</dd>
-</dl>
-
-
-
-<h3><a name="StorageBackend">Storage backend drivers</a></h3>
-
-<p>
-This section illustrates the capabilities / format for each of
-the different backend storage pool drivers
-</p>
-
-<h4><a name="StorageBackendDir">Directory pool</a></h4>
-
-<p>
-A pool with a type of <code>dir</code> provides the means to manage
-files within a directory. The files can be fully allocated raw files,
-sparsely allocated raw files, or one of the special disk formats
-such as <code>qcow</code>,<code>qcow2</code>,<code>vmdk</code>,
-<code>cow</code>, etc as supported by the <code>qemu-img</code>
-program. If the directory does not exist at the time the pool is
-defined, the <code>build</code> operation can be used to create it.
-</p>
-
-<h5>Example pool input definition</h5>
-
-<pre>
-<pool type="dir">
- <name>virtimages</name>
- <target>
- <path>/var/lib/virt/images</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The directory pool does not use the pool format type element.
-</p>
-
-<h5>Valid volume format types</h5>
-
-<p>
-One of the following options:
-</p>
-
-<ul>
-<li><code>raw</code>: a plain file</li>
-<li><code>bochs</code>: Bochs disk image format</li>
-<li><code>cloop</code>: compressed loopback disk image format</li>
-<li><code>cow</code>: User Mode Linux disk image format</li>
-<li><code>dmg</code>: Mac disk image format</li>
-<li><code>iso</code>: CDROM disk image format</li>
-<li><code>qcow</code>: QEMU v1 disk image format</li>
-<li><code>qcow2</code>: QEMU v2 disk image format</li>
-<li><code>vmdk</code>: VMWare disk image format</li>
-<li><code>vpc</code>: VirtualPC disk image format</li>
-</ul>
-
-<p>
-When listing existing volumes all these formats are supported
-natively. When creating new volumes, only a subset may be
-available. The <code>raw</code> type is guaranteed always
-available. The <code>qcow2</code> type can be created if
-either <code>qemu-img</code> or <code>qcow-create</code> tools
-are present. The others are dependent on support of the
-<code>qemu-img</code> tool.
-
-<h4><a name="StorageBackendFS">Filesystem pool</a></h4>
-
-<p>
-This is a variant of the directory pool. Instead of creating a
-directory on an existing mounted filesystem though, it expects
-a source block device to be named. This block device will be
-mounted and files managed in the directory of its mount point.
-It will default to allowing the kernel to automatically discover
-the filesystem type, though it can be specified manually if
-required.
-</p>
-
-<h5>Example pool input</h5>
-
-<pre>
-<pool type="fs">
- <name>virtimages</name>
- <source>
- <device path="/dev/VolGroup00/VirtImages"/>
- </source>
- <target>
- <path>/var/lib/virt/images</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The filesystem pool supports the following formats:
-</p>
-
-<ul>
-<li><code>auto</code> - automatically determine format</li>
-<li><code>ext2</code></li>
-<li><code>ext3</code></li>
-<li><code>ext4</code></li>
-<li><code>ufs</code></li>
-<li><code>iso9660</code></li>
-<li><code>udf</code></li>
-<li><code>gfs</code></li>
-<li><code>gfs2</code></li>
-<li><code>vfat</code></li>
-<li><code>hfs+</code></li>
-<li><code>xfs</code></li>
-</ul>
-
-<h5>Valid volume format types</h5>
-
-<p>
-The valid volume types are the same as for the <code>directory</code>
-pool type.
-</p>
-
-<h4><a name="StorageBackendNetFS">Network filesystem pool</a></h4>
-
-<p>
-This is a variant of the filesystem pool. Instead of requiring
-a local block device as the source, it requires the name of a
-host and path of an exported directory. It will mount this network
-filesystem and manage files within the directory of its mount
-point. It will default to using NFS as the protocol.
-</p>
-
-<h5>Example pool input</h5>
-
-<pre>
-<pool type="netfs">
- <name>virtimages</name>
- <source>
- <host name="nfs.example.com"/>
- <dir path="/var/lib/virt/images"/>
- </source>
- <target>
- <path>/var/lib/virt/images</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The network filesystem pool supports the following formats:
-</p>
-
-<ul>
-<li><code>auto</code> - automatically determine format</li>
-<li><code>nfs</code></li>
-</ul>
-
-<h5>Valid volume format types</h5>
-
-<p>
-The valid volume types are the same as for the <code>directory</code>
-pool type.
-</p>
-
-<h4><a name="StorageBackendLogical">Logical volume pools</a></h4>
-
-<p>
-This provides a pool based on an LVM volume group. For a
-pre-defined LVM volume group, simply providing the group
-name is sufficient, while to build a new group requires
-providing a list of source devices to serve as physical
-volumes. Volumes will be allocated by carving out chunks
-of storage from the volume group.
-</p>
-
-<h5>Example pool input</h5>
-
-<pre>
-<pool type="logical">
- <name>HostVG</name>
- <source>
- <device path="/dev/sda1"/>
- <device path="/dev/sdb1"/>
- <device path="/dev/sdc1"/>
- </source>
- <target>
- <path>/dev/HostVG</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The logical volume pool does not use the pool format type element.
-</p>
-
-<h5>Valid volume format types</h5>
-
-<p>
-The logical volume pool does not use the volume format type element.
-</p>
-
-
-<h4><a name="StorageBackendDisk">Disk volume pools</a></h4>
-
-<p>
-This provides a pool based on a physical disk. Volumes are created
-by adding partitions to the disk. Disk pools are have constraints
-on the size and placement of volumes. The 'free extents'
-information will detail the regions which are available for creating
-new volumes. A volume cannot span across 2 different free extents.
-</p>
-
-<h5>Example pool input</h5>
-
-<pre>
-<pool type="disk">
- <name>sda</name>
- <source>
- <device path='/dev/sda'/>
- </source>
- <target>
- <path>/dev</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The disk volume pool accepts the following pool format types, representing
-the common partition table types:
-</p>
-
-<ul>
-<li><code>dos</code></li>
-<li><code>dvh</code></li>
-<li><code>gpt</code></li>
-<li><code>mac</code></li>
-<li><code>bsd</code></li>
-<li><code>pc98</code></li>
-<li><code>sun</code></li>
-</ul>
-
-<p>
-The <code>dos</code> or <code>gpt</code> formats are recommended for
-best portability - the latter is needed for disks larger than 2TB.
-</p>
-
-<h5>Valid volume format types</h5>
-
-<p>
-The disk volume pool accepts the following volume format types, representing
-the common partition entry types:
-</p>
-
-<ul>
-<li><code>none</code></li>
-<li><code>linux</code></li>
-<li><code>fat16</code></li>
-<li><code>fat32</code></li>
-<li><code>linux-swap</code></li>
-<li><code>linux-lvm</code></li>
-<li><code>linux-raid</code></li>
-<li><code>extended</code></li>
-</ul>
-
-
-<h4><a name="StorageBackendISCSI">iSCSI volume pools</a></h4>
-
-<p>
-This provides a pool based on an iSCSI target. Volumes must be
-pre-allocated on the iSCSI server, and cannot be created via
-the libvirt APIs. Since /dev/XXX names may change each time libvirt
-logs into the iSCSI target, it is recommended to configure the pool
-to use <code>/dev/disk/by-path</code> or <code>/dev/disk/by-id</code>
-for the target path. These provide persistent stable naming for LUNs
-</p>
-
-<h5>Example pool input</h5>
-
-<pre>
-<pool type="iscsi">
- <name>virtimages</name>
- <source>
- <host name="iscsi.example.com"/>
- <device path="demo-target"/>
- </source>
- <target>
- <path>/dev/disk/by-path</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The logical volume pool does not use the pool format type element.
-</p>
-
-<h5>Valid volume format types</h5>
-
-<p>
-The logical volume pool does not use the volume format type element.
-</p>
-
-
-
-</body>
-</html>
<field name='domain' type='int' info=' What part of the library raised this error'/>
<field name='message' type='char *' info=' human-readable informative error message'/>
<field name='level' type='virErrorLevel' info=' how consequent is the error'/>
- <field name='conn' type='virConnectPtr' info=' the connection if available'/>
- <field name='dom' type='virDomainPtr' info=' the domain if available'/>
+ <field name='conn' type='virConnectPtr' info=' connection if available, see note above'/>
+ <field name='dom' type='virDomainPtr' info=' domain if available, see note above'/>
<field name='str1' type='char *' info=' extra string information'/>
<field name='str2' type='char *' info=' extra string information'/>
<field name='str3' type='char *' info=' extra string information'/>
<field name='int1' type='int' info=' extra number information'/>
<field name='int2' type='int' info=' extra number information'/>
- <field name='net' type='virNetworkPtr' info=' the network if available'/>
+ <field name='net' type='virNetworkPtr' info=' network if available, see note above'/>
</struct>
<typedef name='virErrorDomain' file='virterror' type='enum'/>
<typedef name='virErrorLevel' file='virterror' type='enum'/>
--- /dev/null
+#FIG 3.2
+Landscape
+Center
+Inches
+Letter
+100.00
+Single
+-2
+1200 2
+6 675 8400 4650 8625
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 675 8400 4650 8400
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 675 8475 4650 8475
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 675 8550 4650 8550
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 675 8625 4650 8625
+-6
+6 7575 8400 11550 8625
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7575 8400 11550 8400
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7575 8475 11550 8475
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7575 8550 11550 8550
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7575 8625 11550 8625
+-6
+6 9000 7125 9600 7425
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 9000 7125 9600 7125 9600 7425 9000 7425 9000 7125
+4 0 0 50 -1 16 12 0.0000 4 135 360 9075 7350 eth1\001
+-6
+6 1950 1200 3600 2325
+6 2100 2025 2625 2325
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 2100 2025 2625 2025 2625 2325 2100 2325 2100 2025
+4 0 0 50 -1 16 12 0.0000 4 135 360 2175 2250 eth0\001
+-6
+6 2850 2025 3375 2325
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 2850 2025 3375 2025 3375 2325 2850 2325 2850 2025
+4 0 0 50 -1 16 12 0.0000 4 135 360 2925 2250 eth1\001
+-6
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 1950 1200 3600 1200 3600 2025 1950 2025 1950 1200
+4 0 0 50 -1 16 12 0.0000 4 135 675 2025 1425 Guest A\001
+-6
+6 4575 1200 6225 2325
+6 4725 2025 5250 2325
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 4725 2025 5250 2025 5250 2325 4725 2325 4725 2025
+4 0 0 50 -1 16 12 0.0000 4 135 360 4800 2250 eth0\001
+-6
+6 5475 2025 6000 2325
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 5475 2025 6000 2025 6000 2325 5475 2325 5475 2025
+4 0 0 50 -1 16 12 0.0000 4 135 360 5550 2250 eth1\001
+-6
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 4575 1200 6225 1200 6225 2025 4575 2025 4575 1200
+2 3 0 1 0 7 50 -1 -1 0.000 0 0 0 0 0 5
+ 5325 1800 5475 1650 5325 1500 5175 1650 5325 1800
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 3
+ 5175 1650 4950 1650 4950 2025
+ 0.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 3
+ 5475 1650 5700 1650 5700 2025
+ 0.000 1.000 0.000
+4 0 0 50 -1 16 12 0.0000 4 135 660 4650 1425 Guest B\001
+4 0 0 50 -1 16 12 0.0000 4 135 420 5550 1575 FWD\001
+-6
+6 7575 1200 9225 2325
+6 7725 2025 8250 2325
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 7725 2025 8250 2025 8250 2325 7725 2325 7725 2025
+4 0 0 50 -1 16 12 0.0000 4 135 360 7800 2250 eth0\001
+-6
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 7575 1200 9225 1200 9225 2025 7575 2025 7575 1200
+4 0 0 50 -1 16 12 0.0000 4 135 675 7650 1425 Guest C\001
+-6
+6 8025 4950 8625 5250
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 8025 4950 8625 4950 8625 5250 8025 5250 8025 4950
+4 0 0 50 -1 16 12 0.0000 4 135 480 8100 5175 virbr1\001
+-6
+6 2550 7125 3150 7425
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 2550 7125 3150 7125 3150 7425 2550 7425 2550 7125
+4 0 0 50 -1 16 12 0.0000 4 180 465 2625 7350 peth0\001
+-6
+6 2475 3675 6450 3900
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 2475 3675 6450 3675
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 2475 3750 6450 3750
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 2475 3825 6450 3825
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 2475 3900 6450 3900
+-6
+6 7500 3675 11475 3900
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7500 3675 11475 3675
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7500 3750 11475 3750
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7500 3825 11475 3825
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7500 3900 11475 3900
+-6
+6 3675 4950 4275 5250
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 3675 4950 4275 4950 4275 5250 3675 5250 3675 4950
+4 0 0 50 -1 16 12 0.0000 4 135 480 3750 5175 virbr0\001
+-6
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 2850 7425 2850 8400
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 9300 7425 9300 8400
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 1725 5250 10275 5250 10275 7125 1725 7125 1725 5250
+2 3 0 1 0 7 50 -1 -1 0.000 0 0 0 0 0 5
+ 4875 6450 5100 6225 4875 6000 4650 6225 4875 6450
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 2325 2325 2325 3375 825 5400 1125 8400
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 5700 2325 5700 2925 7875 2925 7950 3675
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 7950 2325 7950 2850 8475 2850 8925 3675
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 3075 2325 3075 3150 3525 3150 3525 3675
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 4950 2325 4950 3225 4650 3225 4500 3675
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 4875 6450 4875 6825 9225 6525 9225 7125
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 3600 3900 3675 4500 4050 4500 4050 4950
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 3975 5250 3975 5625 4875 5625 4875 6000
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 8775 3900 8700 4500 8325 4500 8325 4950
+ 0.000 1.000 1.000 0.000
+4 0 0 50 -1 16 12 0.0000 4 135 360 825 8850 lan1\001
+4 0 0 50 -1 16 12 0.0000 4 135 360 7725 8850 lan2\001
+4 0 0 50 -1 16 12 0.0000 4 135 465 2550 4125 vlan1\001
+4 0 0 50 -1 16 12 0.0000 4 135 465 7575 4125 vlan2\001
+4 0 0 50 -1 16 12 0.0000 4 135 420 5100 6075 FWD\001
+4 0 0 50 -1 16 12 0.0000 4 135 570 1800 5475 Host A\001
--- /dev/null
+#FIG 3.2
+Landscape
+Center
+Inches
+Letter
+100.00
+Single
+-2
+1200 2
+6 675 8400 4650 8625
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 675 8400 4650 8400
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 675 8475 4650 8475
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 675 8550 4650 8550
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 675 8625 4650 8625
+-6
+6 7575 8400 11550 8625
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7575 8400 11550 8400
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7575 8475 11550 8475
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7575 8550 11550 8550
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7575 8625 11550 8625
+-6
+6 9000 7125 9600 7425
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 9000 7125 9600 7125 9600 7425 9000 7425 9000 7125
+4 0 0 50 -1 16 12 0.0000 4 135 360 9075 7350 eth1\001
+-6
+6 2550 7125 3150 7425
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 2550 7125 3150 7125 3150 7425 2550 7425 2550 7125
+4 0 0 50 -1 16 12 0.0000 4 180 465 2625 7350 peth0\001
+-6
+6 1950 1200 3600 2325
+6 2100 2025 2625 2325
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 2100 2025 2625 2025 2625 2325 2100 2325 2100 2025
+4 0 0 50 -1 16 12 0.0000 4 135 360 2175 2250 eth0\001
+-6
+6 2850 2025 3375 2325
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 2850 2025 3375 2025 3375 2325 2850 2325 2850 2025
+4 0 0 50 -1 16 12 0.0000 4 135 360 2925 2250 eth1\001
+-6
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 1950 1200 3600 1200 3600 2025 1950 2025 1950 1200
+4 0 0 50 -1 16 12 0.0000 4 135 675 2025 1425 Guest A\001
+-6
+6 4575 1200 6225 2325
+6 4725 2025 5250 2325
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 4725 2025 5250 2025 5250 2325 4725 2325 4725 2025
+4 0 0 50 -1 16 12 0.0000 4 135 360 4800 2250 eth0\001
+-6
+6 5475 2025 6000 2325
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 5475 2025 6000 2025 6000 2325 5475 2325 5475 2025
+4 0 0 50 -1 16 12 0.0000 4 135 360 5550 2250 eth1\001
+-6
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 4575 1200 6225 1200 6225 2025 4575 2025 4575 1200
+2 3 0 1 0 7 50 -1 -1 0.000 0 0 0 0 0 5
+ 5325 1800 5475 1650 5325 1500 5175 1650 5325 1800
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 3
+ 5175 1650 4950 1650 4950 2025
+ 0.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 3
+ 5475 1650 5700 1650 5700 2025
+ 0.000 1.000 0.000
+4 0 0 50 -1 16 12 0.0000 4 135 660 4650 1425 Guest B\001
+4 0 0 50 -1 16 12 0.0000 4 135 420 5550 1575 FWD\001
+-6
+6 7575 1200 9225 2325
+6 7725 2025 8250 2325
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 7725 2025 8250 2025 8250 2325 7725 2325 7725 2025
+4 0 0 50 -1 16 12 0.0000 4 135 360 7800 2250 eth0\001
+-6
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 7575 1200 9225 1200 9225 2025 7575 2025 7575 1200
+4 0 0 50 -1 16 12 0.0000 4 135 675 7650 1425 Guest C\001
+-6
+6 4950 4275 6225 4725
+2 4 0 1 0 7 50 -1 -1 0.000 0 0 7 0 0 5
+ 6225 4725 6225 4275 4950 4275 4950 4725 6225 4725
+4 0 0 50 -1 16 12 0.0000 4 180 1080 5025 4575 Bridge virbr0\001
+-6
+6 2400 4275 3750 4725
+2 4 0 1 0 7 50 -1 -1 0.000 0 0 7 0 0 5
+ 3750 4725 3750 4275 2400 4275 2400 4725 3750 4725
+4 0 0 50 -1 16 12 0.0000 4 180 960 2475 4575 Bridge eth0\001
+-6
+6 7725 4275 9000 4725
+2 4 0 1 0 7 50 -1 -1 0.000 0 0 7 0 0 5
+ 9000 4725 9000 4275 7725 4275 7725 4725 9000 4725
+4 0 0 50 -1 16 12 0.0000 4 180 1080 7800 4575 Bridge virbr1\001
+-6
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 2850 7425 2850 8400
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 9300 7425 9300 8400
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 1800 825 10275 825 10275 7125 1800 7125 1800 825
+2 3 0 1 0 7 50 -1 -1 0.000 0 0 0 0 0 5
+ 6675 5850 6900 5625 6675 5400 6450 5625 6675 5850
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 2325 2325 2325 3375 3000 3375 3000 4275
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 3000 4725 3000 5625 2850 5625 2850 7125
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 5700 2325 5700 2925 8250 2925 8250 4275
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 7950 2325 7950 2850 8475 2850 8475 4275
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 3075 2325 3075 3450 5550 3450 5550 4275
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 4950 2325 4950 3225 5700 3225 5700 4275
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 5550 4725 5400 5100 6675 5175 6675 5400
+ 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 0 0 4
+ 6675 5850 6675 6300 9225 6000 9225 7125
+ 0.000 1.000 1.000 0.000
+4 0 0 50 -1 16 12 0.0000 4 135 360 825 8850 lan1\001
+4 0 0 50 -1 16 12 0.0000 4 135 360 7725 8850 lan2\001
+4 0 0 50 -1 16 12 0.0000 4 135 570 1875 1050 Host A\001
+4 0 0 50 -1 16 12 0.0000 4 135 420 5850 5700 FWD\001
<ref name='virStoragePoolGetInfo'/>
<ref name='virStorageVolGetInfo'/>
</word>
+ <word name='above'>
+ <ref name='_virError'/>
+ </word>
<word name='access'>
<ref name='_virNodeInfo'/>
<ref name='virConnectGetVersion'/>
<ref name='virConnGetLastError'/>
<ref name='virGetLastError'/>
</word>
+ <word name='note'>
+ <ref name='_virError'/>
+ </word>
<word name='now'>
<ref name='virStoragePoolBuild'/>
<ref name='virStoragePoolCreate'/>
<ref name='virStorageVolGetName'/>
</word>
<word name='see'>
+ <ref name='_virError'/>
<ref name='virDomainGetUUIDString'/>
<ref name='virDomainMigrate'/>
<ref name='virNetworkGetUUIDString'/>
-body
- {
- margin: 0;
- padding: 0;
- color: #333333;
- font: 13px Verdana, Arial, Helvetica, sans;
- background: #898989;
- text-align: justify;
- }
-a
- {
- color: #0D7520;
- }
-a:hover
- {
- color: #a8a8a8;
- }
-
-img
- {
- border: 0;
- }
-
-#container
- {
- margin: 0 auto;
- width: 766px;
- position: relative;
- background: #fff;
- padding: 0 10px 0 10px;
- text-align: justify;
- }
-* html #container
- {
- width: 766px;
- }
-
-#pageHeader
- {
- position: absolute;
- background: url(libvirtHeader.png) center no-repeat;
- top: 30px;
- height: 76px;
- width: 766px;
- }
-#content h3
- {
- text-align: right;
- color: #a8a8a8;
- }
-#content2 h1
- {
- text-align: right;
- color: #0d7520;
- }
-#content h3
- {
- text-align: right;
- font-size: 24px;
- }
-#content h3 .style1
- {
- color: #0d7520;
- }
-#adjustments
- {
- padding-top: 15px;
- }
-#container #adjustments .p1
- {
- font-size: 11px;
- height: 300px;
- background: url(libvirtLogo.png) center no-repeat;
- margin: 0;
- width: 766px;
- }
-#container #bottom .p1
- {
- font-size: 11px;
- height: 900px;
- margin: 0;
- width: 766px;
- }
-#content2
- {
- margin: 100px 10px 0 160px;
- }
-#content2 p
- {
- line-height: 150%;
- margin: 10px 0 10px 0;
- }
-#content
- {
- margin: 0 10px 0 160px;
- }
-#content p
- {
- line-height: 150%;
- margin: 10px 0 10px 0;
- }
-.linkList
- {
+
+
+h1 {
+ font-weight: normal;
+ color: #3c857c;
+}
+h1 strong {
+ font-weight: bold;
+}
+
+h2, h3, h4, h5, h6 {
+ color: #3c857c;
+}
+
+#header {
position: absolute;
- top: 320px;
- left: 10px;
- width: 140px;
- }
-.llinks ul
- {
- list-style-type: none;
- margin: 0;
- padding: 0 0 0 10px;
- }
-.linkList .llinks ul li
- {
- font-size: 13px;
- border-bottom: 1px solid #E6EEF0;
+ top: 0px;
+ left: 0px;
+ margin: 0px;
+ height: 104px;
+ width: 100%;
+ background: url(libvirt-header-bg.png);
+ border: 0px;
+}
+
+#body {
+ position: relative;
+ border: 0px;
+ padding-top: 104px;
+ left: 0px;
+ margin: 0px;
+ padding-left: 250px;
+}
+
+#content {
+ float: right;
+ padding: 0px;
+ width: 100%;
+ padding-bottom: 1em;
+}
+
+#menu {
+ border: 0px;
+ margin-left: -250px;
+ position: relative;
+ margin-top: 0px;
+ left: 0px;
+ width: 220px;
+ margin-bottom: 1em;
+}
+
+#menu ul {
+ margin: 0px;
+ padding: 0px;
+ margin-left: 40px;
+}
+
+#menu li ul {
+ margin-left: 0px;
+}
+
+#menu ul li {
+ list-style: none;
+ color: black;
+ padding: 0px;
+ font-weight: bold;
+ font-size: 1.2em;
+}
+
+#menu li ul li {
+ font-size: 1em;
+}
+
+#menu ul li a, #menu ul li span {
+ text-decoration: inherit;
+ color: inherit;
display: block;
- padding: 8px 0;
- }
-.llinks h3.links
- {
- background: #e6e6e6;
- color: #999999;
- font-size: 14px;
- height: 25px;
- padding: 10px 0 0 5px;
- margin: 15px 0 5px 5px;
- }
-.linkList2
- {
+ padding: 6px;
+ margin: 2px;
+}
+
+#menu ul li .active {
+ background: #a4c6c2;
+}
+
+#menu ul.l0 li .inactive {
+ background: #c5dbd8;
+}
+
+
+#menu ul.l1 li .inactive,
+#menu ul.l2 li .inactive {
+ background: #dfebea;
+ border-left: 8px solid #dfebea;
+}
+
+#menu ul.l1 li .inactive,
+#menu ul.l1 li .active {
+ padding-left: 1em;
+}
+
+#menu ul.l1 li .inactive {
+ border-left: 6px solid #dfebea;
+}
+#menu ul.l1 li .active {
+ border-left: 6px solid #a5c6c2;
+}
+
+#menu ul.l2 li .inactive,
+#menu ul.l2 li .active {
+ padding-left: 2em;
+ border-left: 8px solid #c5dbd8;
+}
+
+
+#headerLogo {
position: absolute;
- top: 100px;
- left: 10px;
- width: 140px;
- }
-.llinks2 ul
- {
- list-style-type: none;
- margin: 0;
- padding: 0 0 0 10px;
- }
-.linkList2 .llinks2 ul li
- {
- font-size: 13px;
- border-bottom: 1px solid #E6EEF0;
- display: block;
- padding: 8px 0;
- }
-.llinks2 h3.links2
- {
- background: #e6e6e6;
+ top: 0px;
+ left: 0px;
+ height: 104px;
+ width: 400px;
+ background: url(libvirt-header-logo.png);
+}
+#headerSearch {
+ position: absolute;
+ top: 0px;
+ right: 0px;
+ padding: 2em;
+}
+
+#headerSearch input {
+ border: 1px solid #999999;
color: #999999;
- font-size: 14px;
- height: 25px;
- padding: 10px 0 0 5px;
- margin: 15px 0 5px 5px;
- }
-
-div.deprecated pre.programlisting
- {
- border-style: double;
- border-color: red;
- }
-
-pre.programlisting
- {
- border-style: double;
- background: #F0F0F0;
- }
+ background: white;
+ padding: 3px;
+ font-size: 1em;
+}
+
+#headerSearch #submit {
+ border: 1px solid #999999;
+ background: #eeeeee;
+ color: black;
+ padding: 3px;
+ font-size: 1em;
+}
+
+
+#sitemap ul li {
+ list-style: none;
+}
+
+#sitemap ul {
+ margin: 1em;
+ padding: 0em;
+}
+
+#sitemap ul ul {
+ padding-left: 2em;
+}
+
+#sitemap li {
+ margin: 0.5em;
+}
+
+#sitemap a {
+ color: inherit;
+ text-decoration: underline;
+ font-weight: bold;
+}
pre {
- overflow: auto;
+ border: 1px solid #999999;
+ background: #eeeeee;
+ color: black;
+ padding: 1em;
+}
+
+a {
+ color: #566866;
+}
+
+
+div.api {
+ border: 1px solid #999999;
+ background: #eeeeee;
+ color: black;
+}
+
+div.api pre {
+ margin: 0px;
+ border: 0px;
+ background: inherit;
+}
+
+div.api table {
+ margin: 0px;
+ padding-left: 2em;
+ font-family: fixed;
+ whitespace: pre;
+}
+
+
+h1 a, h2 a, h3 a, h4 a, h5 a {
+ color: inherit;
+ text-decoration: inherit;
+}
+
+#changelog .author {
+ color: #3c857c;
+ font-weight: bold;
+}
+
+p.image {
+ text-align: center;
+}
+
+.top_table {
+ border-collapse: collapse;
+}
+
+.top_table th {
+ background: #a4c6c2;
+}
+
+.top_table th a {
+ color: inherit;
+ text-decoration: inherit;
+}
+
+.top_table td, .top_table th {
+ border: 1px solid #999999;
+}
+
+.top_table tr:hover td, .top_table col:hover td {
+ background: #eeeeee;
+}
+
+.top_table tr td:hover {
+ background: #c5dbd8;
+}
+
+#footer {
+ clear: both;
+ position: relative;
+ margin: 0px;
+ padding: 0px;
+ border: 0px;
width: 100%;
+ background: #757575 url(footer_pattern.png) repeat-x;
+ height: 180px;
+}
+
+#footer p {
+ position: absolute;
+ top: 0px;
+ left: 0px;
+ margin: 0px;
+ border: 0px solid red;
+ width: 220px;
+ text-align: center;
+}
+
+#footer p a img {
+ border: 0px;
+}
+
+#projects {
+ margin: 0px;
+ border: 0px;
+ position: absolute;
+ top: 0px;
+ left: 0px;
+ width: 100%;
+}
+
+
+#projects dl {
+ margin: 0px;
+ border: 0px solid white;
+ background: url(footer_corner.png) no-repeat;
+ height: 180px;
+ position: absolute;
+ top: 0px;
+ left: 0px;
+}
+
+
+#projects #p1 {
+ margin-left: 25%;
+ width: 75%;
+}
+
+#projects #p2 {
+ margin-left: 50%;
+ width: 50%;
+}
+
+#projects #p3 {
+ margin-left: 75%;
+ width: 25%;
+}
+
+#projects dt, #projects dd {
+ padding: 0px;
+ margin: 0px;
+}
+
+#projects #p1 dt, #projects #p1 dd {
+ width: 33%;
+}
+#projects #p2 dt, #projects #p2 dd {
+ width: 50%;
+}
+#projects #p3 dt, #projects #p3 dd {
+ width: 99%;
+}
+
+#projects {
+}
+
+#projects span {
+ font-size: 0.8em;
+ display: block;
+ padding-left: 1em;
+ padding-top: 0.5em;
+}
+
+#projects a {
+ font-size: 0.8em;
+ display: block;
+ padding-left: 0.8em;
+ padding-top: 1em;
}
-table.top_table {
- border-collapse: collapse;
+#projects a {
+ color: white;
+ text-decoration: inherit;
}
-table.top_table th, table.top_table td {
- vertical-align: top;
- border: 1px solid #f0f0f0;
+#projects span {
+ color: #ccc;
}
--- /dev/null
+@import url(generic.css);
+@import url(libvirt.css);
exclude-result-prefixes="exsl str">
<!-- Import the main part of the site stylesheets -->
- <xsl:import href="site.xsl"/>
+ <xsl:import href="page.xsl"/>
<!-- Generate XHTML-1.0 transitional -->
<xsl:output method="xml" encoding="ISO-8859-1" indent="yes"
</xsl:template>
<xsl:template match="macro" mode="toc">
- <pre class="programlisting">
- <xsl:text>#define </xsl:text><a href="#{@name}"><xsl:value-of select="@name"/></a>
- </pre>
+ <xsl:text>#define </xsl:text>
+ <a href="#{@name}"><xsl:value-of select="@name"/></a>
+ <xsl:text>
+</xsl:text>
</xsl:template>
<xsl:template match="variable" mode="toc">
- <pre class="programlisting">
- <xsl:text>Variable </xsl:text>
<xsl:call-template name="dumptext">
<xsl:with-param name="text" select="string(@type)"/>
</xsl:call-template>
<a name="{@name}"></a>
<xsl:value-of select="@name"/>
<xsl:text>
-
</xsl:text>
- </pre>
</xsl:template>
<xsl:template match="typedef" mode="toc">
- <xsl:variable name="name" select="string(@name)"/>
- <pre class="programlisting">
+ <xsl:text>typedef </xsl:text><xsl:variable name="name" select="string(@name)"/>
<xsl:choose>
<xsl:when test="@type = 'enum'">
- <xsl:text>Enum </xsl:text>
+ <xsl:text>enum </xsl:text>
<a href="#{$name}"><xsl:value-of select="$name"/></a>
<xsl:text>
</xsl:text>
</xsl:when>
<xsl:otherwise>
- <xsl:text>Typedef </xsl:text>
<xsl:call-template name="dumptext">
<xsl:with-param name="text" select="@type"/>
</xsl:call-template>
</xsl:text>
</xsl:otherwise>
</xsl:choose>
- </pre>
</xsl:template>
<xsl:template match="typedef[@type = 'enum']">
<xsl:variable name="name" select="string(@name)"/>
- <h3>Enum <a name="{$name}"><xsl:value-of select="$name"/></a></h3>
- <pre class="programlisting">
- <xsl:text>Enum </xsl:text>
- <xsl:value-of select="$name"/>
- <xsl:text> {
-</xsl:text>
- <xsl:for-each select="/api/symbols/enum[@type = $name]">
- <xsl:sort select="@value" data-type="number" order="ascending"/>
- <xsl:text> </xsl:text>
- <a name="{@name}"><xsl:value-of select="@name"/></a>
- <xsl:text> = </xsl:text>
- <xsl:value-of select="@value"/>
- <xsl:if test="@info != ''">
- <xsl:text> : </xsl:text>
- <xsl:call-template name="dumptext">
- <xsl:with-param name="text" select="@info"/>
- </xsl:call-template>
- </xsl:if>
- <xsl:text>
+ <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
+ <div class="api">
+ <pre>
+ <xsl:text>enum </xsl:text>
+ <xsl:value-of select="$name"/>
+ <xsl:text> {
</xsl:text>
- </xsl:for-each>
- <xsl:text>}
+ </pre>
+ <table>
+ <xsl:for-each select="/api/symbols/enum[@type = $name]">
+ <xsl:sort select="@value" data-type="number" order="ascending"/>
+ <tr>
+ <td><a name="{@name}"><xsl:value-of select="@name"/></a></td>
+ <td><xsl:text> = </xsl:text></td>
+ <td><xsl:value-of select="@value"/></td>
+ <xsl:if test="@info != ''">
+ <td>
+ <xsl:text> : </xsl:text>
+ <xsl:call-template name="dumptext">
+ <xsl:with-param name="text" select="@info"/>
+ </xsl:call-template>
+ </td>
+ </xsl:if>
+ </tr>
+ </xsl:for-each>
+ </table>
+ <pre>
+ <xsl:text>}
</xsl:text>
- </pre>
+ </pre>
+ </div>
</xsl:template>
<xsl:template match="struct" mode="toc">
- <pre class="programlisting">
- <xsl:text>Structure </xsl:text><a href="#{@name}"><xsl:value-of select="@name"/></a><br/>
- <xsl:value-of select="@type"/><xsl:text>
-</xsl:text>
- <xsl:if test="not(field)">
- <xsl:text>The content of this structure is not made public by the API.
+ <xsl:text>typedef </xsl:text>
+ <xsl:value-of select="@type"/>
+ <xsl:text> </xsl:text>
+ <a href="#{@name}"><xsl:value-of select="@name"/></a>
+ <xsl:text>
</xsl:text>
- </xsl:if>
- </pre>
</xsl:template>
<xsl:template match="struct">
- <h3><a name="{@name}">Structure <xsl:value-of select="@name"/></a></h3>
- <pre class="programlisting">
- <xsl:text>Structure </xsl:text><xsl:value-of select="@name"/><br/>
- <xsl:value-of select="@type"/><xsl:text> {
+ <h3><a name="{@name}"><code><xsl:value-of select="@name"/></code></a></h3>
+ <div class="api">
+ <pre>
+ <xsl:text>struct </xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:text>{
</xsl:text>
- <xsl:if test="not(field)">
- <xsl:text>The content of this structure is not made public by the API.
-</xsl:text>
- </xsl:if>
- <xsl:for-each select="field">
- <xsl:text> </xsl:text>
- <xsl:call-template name="dumptext">
- <xsl:with-param name="text" select="@type"/>
- </xsl:call-template>
- <xsl:text>	</xsl:text>
- <xsl:value-of select="@name"/>
- <xsl:if test="@info != ''">
- <xsl:text>	: </xsl:text>
- <xsl:call-template name="dumptext">
- <xsl:with-param name="text" select="substring(@info, 1, 40)"/>
- </xsl:call-template>
- </xsl:if>
- <xsl:text>
+ </pre>
+ <table>
+ <xsl:for-each select="field">
+ <tr>
+ <td>
+ <xsl:call-template name="dumptext">
+ <xsl:with-param name="text" select="@type"/>
+ </xsl:call-template>
+ </td>
+ <td><xsl:value-of select="@name"/></td>
+ <xsl:if test="@info != ''">
+ <td>
+ <xsl:text> : </xsl:text>
+ <xsl:call-template name="dumptext">
+ <xsl:with-param name="text" select="@info"/>
+ </xsl:call-template>
+ </td>
+ </xsl:if>
+ </tr>
+ </xsl:for-each>
+ <xsl:if test="not(field)">
+ <tr>
+ <td colspan="3">
+ <xsl:text>The content of this structure is not made public by the API</xsl:text>
+ </td>
+ </tr>
+ </xsl:if>
+ </table>
+ <pre>
+ <xsl:text>
+}
</xsl:text>
- </xsl:for-each>
- <xsl:text>}</xsl:text>
- </pre>
+ </pre>
+ </div>
</xsl:template>
<xsl:template match="macro">
<xsl:variable name="name" select="string(@name)"/>
- <h3><a name="{$name}"></a>Macro: <xsl:value-of select="$name"/></h3>
+ <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
<pre><xsl:text>#define </xsl:text><xsl:value-of select="$name"/></pre>
<p>
<xsl:call-template name="dumptext">
<xsl:variable name="nlen" select="string-length($name)"/>
<xsl:variable name="tlen" select="string-length(return/@type)"/>
<xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
- <pre class="programlisting">
<xsl:call-template name="dumptext">
<xsl:with-param name="text" select="return/@type"/>
</xsl:call-template>
<xsl:text>					 </xsl:text>
</xsl:if>
</xsl:for-each>
- <xsl:text>)</xsl:text>
- </pre><xsl:text>
+ <xsl:text>)
</xsl:text>
</xsl:template>
<xsl:variable name="nlen" select="string-length($name)"/>
<xsl:variable name="tlen" select="string-length(return/@type)"/>
<xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
- <pre class="programlisting">
- <xsl:text>Function type: </xsl:text>
+ <xsl:text>typedef </xsl:text>
<a href="#{$name}"><xsl:value-of select="$name"/></a>
<xsl:text>
</xsl:text>
</xsl:for-each>
<xsl:text>)
</xsl:text>
- </pre>
<xsl:text>
</xsl:text>
</xsl:template>
<xsl:variable name="nlen" select="string-length($name)"/>
<xsl:variable name="tlen" select="string-length(return/@type)"/>
<xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
- <h3>
- <a name="{$name}"></a>
- <xsl:text>Function type: </xsl:text>
- <xsl:value-of select="$name"/>
- </h3>
+ <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
<pre class="programlisting">
- <xsl:text>Function type: </xsl:text>
- <xsl:value-of select="$name"/>
- <xsl:text>
-</xsl:text>
+ <xsl:text>typedef </xsl:text>
<xsl:call-template name="dumptext">
<xsl:with-param name="text" select="return/@type"/>
</xsl:call-template>
- <xsl:text>	</xsl:text>
+ <xsl:text>	(*</xsl:text>
<xsl:value-of select="@name"/>
<xsl:if test="$blen - 40 < -8">
<xsl:text>	</xsl:text>
<xsl:if test="$blen - 40 < 0">
<xsl:text>	</xsl:text>
</xsl:if>
- <xsl:text>	(</xsl:text>
+ <xsl:text>)	(</xsl:text>
<xsl:if test="not(arg)">
<xsl:text>void</xsl:text>
</xsl:if>
<xsl:variable name="nlen" select="string-length($name)"/>
<xsl:variable name="tlen" select="string-length(return/@type)"/>
<xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
- <h3><a name="{$name}"></a>Function: <xsl:value-of select="$name"/></h3>
+ <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
<pre class="programlisting">
<xsl:call-template name="dumptext">
<xsl:with-param name="text" select="return/@type"/>
<xsl:template match="file">
<xsl:variable name="name" select="@name"/>
<xsl:variable name="title">Module <xsl:value-of select="$name"/> from <xsl:value-of select="/api/@name"/></xsl:variable>
- <xsl:document href="{$htmldir}/libvirt-{$name}.html" method="xml" encoding="ISO-8859-1"
- doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
- doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html>
- <head>
- <xsl:call-template name="style"/>
- <xsl:element name="title">
- <xsl:value-of select="$title"/>
- </xsl:element>
- </head>
- <body>
- <div id="container">
- <div id="intro">
- <div id="adjustments"/>
- <div id="pageHeader"/>
- <div id="content2">
- <xsl:call-template name="titlebox">
- <xsl:with-param name="title" select="$title"/>
- </xsl:call-template>
- <xsl:call-template name="navbar"/>
- <xsl:call-template name="description"/>
- <xsl:choose>
- <xsl:when test="deprecated">
- <div class="deprecated">
- <h2>Table of Contents</h2>
- <xsl:apply-templates select="exports" mode="toc"/>
- <h2>Description</h2>
- <xsl:text>
-</xsl:text>
- <xsl:apply-templates select="exports"/>
- </div>
- </xsl:when>
- <xsl:otherwise>
- <h2>Table of Contents</h2>
- <xsl:apply-templates select="exports[@type='macro']" mode="toc">
- <xsl:sort select='@symbol'/>
- </xsl:apply-templates>
- <xsl:apply-templates select="exports[@type='enum']" mode="toc">
- <xsl:sort select='@symbol'/>
- </xsl:apply-templates>
- <xsl:apply-templates select="exports[@type='typedef']" mode="toc">
- <xsl:sort select='@symbol'/>
- </xsl:apply-templates>
- <xsl:apply-templates select="exports[@type='struct']" mode="toc">
- <xsl:sort select='@symbol'/>
- </xsl:apply-templates>
- <xsl:apply-templates select="exports[@type='function']" mode="toc">
- <xsl:sort select='@symbol'/>
- </xsl:apply-templates>
- <h2>Description</h2>
- <xsl:text>
-</xsl:text>
- <xsl:apply-templates select="exports[@type='macro']">
- <xsl:sort select='@symbol'/>
- </xsl:apply-templates>
- <xsl:apply-templates select="exports[@type='enum']">
- <xsl:sort select='@symbol'/>
- </xsl:apply-templates>
- <xsl:apply-templates select="exports[@type='typedef']">
- <xsl:sort select='@symbol'/>
- </xsl:apply-templates>
- <xsl:apply-templates select="exports[@type='struct']">
- <xsl:sort select='@symbol'/>
- </xsl:apply-templates>
- <xsl:apply-templates select="exports[@type='function']">
- <xsl:sort select='@symbol'/>
- </xsl:apply-templates>
- </xsl:otherwise>
- </xsl:choose>
- </div>
- </div>
- <xsl:call-template name="linkList2"/>
- <xsl:call-template name="bottom"/>
- </div>
- </body>
- </html>
- </xsl:document>
+ <html>
+ <body>
+ <h1><xsl:value-of select="$title"/></h1>
+ <xsl:call-template name="description"/>
+ <h2>Table of Contents</h2>
+ <xsl:if test="count(exports[@type='macro']) > 0">
+ <h3><a href="#macros">Macros</a></h3>
+ <pre>
+ <xsl:apply-templates select="exports[@type='macro']" mode="toc">
+ <xsl:sort select='@symbol'/>
+ </xsl:apply-templates>
+ </pre>
+ </xsl:if>
+ <h3><a href="#types">Types</a></h3>
+ <pre>
+ <xsl:apply-templates select="exports[@type='typedef']" mode="toc">
+ <xsl:sort select='@symbol'/>
+ </xsl:apply-templates>
+ </pre>
+ <h3><a href="#functions">Functions</a></h3>
+ <pre>
+ <xsl:apply-templates select="exports[@type='function']" mode="toc">
+ <xsl:sort select='@symbol'/>
+ </xsl:apply-templates>
+ </pre>
+
+ <h2>Description</h2>
+
+ <xsl:if test="count(exports[@type='macro']) > 0">
+ <h3><a name="macros">Macros</a></h3>
+ <xsl:apply-templates select="exports[@type='macro']">
+ <xsl:sort select='@symbol'/>
+ </xsl:apply-templates>
+ </xsl:if>
+ <h3><a name="types">Types</a></h3>
+ <xsl:apply-templates select="exports[@type='typedef']">
+ <xsl:sort select='@symbol'/>
+ </xsl:apply-templates>
+ <h3><a name="functions">Functions</a></h3>
+ <xsl:apply-templates select="exports[@type='function']">
+ <xsl:sort select='@symbol'/>
+ </xsl:apply-templates>
+ </body>
+ </html>
</xsl:template>
<xsl:template match="file" mode="toc">
</xsl:template>
<xsl:template name="mainpage">
- <xsl:param name="file" select="concat($htmldir, '/index.html')"/>
<xsl:variable name="title">Reference Manual for <xsl:value-of select="/api/@name"/></xsl:variable>
- <xsl:document href="{$file}" method="xml" encoding="ISO-8859-1"
- doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
- doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html>
- <head>
- <xsl:call-template name="style"/>
- <xsl:element name="title">
- <xsl:value-of select="$title"/>
- </xsl:element>
- </head>
- <body>
- <div id="container">
- <div id="intro">
- <div id="adjustments"/>
- <div id="pageHeader"/>
- <div id="content2">
- <xsl:call-template name="titlebox">
- <xsl:with-param name="title" select="$title"/>
- </xsl:call-template>
- <h2>Table of Contents</h2>
- <ul>
- <xsl:apply-templates select="/api/files/file" mode="toc"/>
- </ul>
- </div>
- </div>
- <xsl:call-template name="linkList2"/>
- <xsl:call-template name="bottom"/>
- </div>
- </body>
- </html>
- </xsl:document>
+ <html>
+ <body>
+ <h1><xsl:value-of select="$title"/></h1>
+ <h2>Table of Contents</h2>
+ <ul>
+ <xsl:apply-templates select="/api/files/file" mode="toc"/>
+ </ul>
+ </body>
+ </html>
</xsl:template>
<xsl:template match="/">
<!-- Save the main index.html as well as a couple of copies -->
- <xsl:call-template name="mainpage"/>
- <xsl:call-template name="mainpage">
- <xsl:with-param name="file" select="concat($htmldir, '/book1.html')"/>
- </xsl:call-template>
- <xsl:call-template name="mainpage">
- <xsl:with-param name="file" select="concat($htmldir, '/libvirt-lib.html')"/>
- </xsl:call-template>
- <!-- now build the file for each of the modules -->
- <xsl:apply-templates select="/api/files/file"/>
+ <xsl:variable name="mainpage">
+ <xsl:call-template name="mainpage"/>
+ </xsl:variable>
+ <xsl:document
+ href="{concat($htmldir, '/index.html')}"
+ method="xml"
+ encoding="ISO-8859-1"
+ doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <xsl:apply-templates select="exsl:node-set($mainpage)" mode="page">
+ <xsl:with-param name="pagename" select="concat($htmldir, '/index.html')"/>
+ </xsl:apply-templates>
+ </xsl:document>
+
+ <xsl:for-each select="/api/files/file">
+ <xsl:variable name="subpage">
+ <xsl:apply-templates select="."/>
+ </xsl:variable>
+
+ <xsl:document
+ href="{concat($htmldir, '/libvirt-', @name, '.html')}"
+ method="xml"
+ encoding="ISO-8859-1"
+ doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <xsl:apply-templates select="exsl:node-set($subpage)" mode="page">
+ <xsl:with-param name="pagename" select="concat($htmldir, '/libvirt-', @name, '.html')"/>
+ </xsl:apply-templates>
+ </xsl:document>
+ </xsl:for-each>
</xsl:template>
</xsl:stylesheet>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Releases</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Releases</h1><p>Here is the list of official releases, however since it is early on in the
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from news.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Releases</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Releases</h1>
+ <p>Here is the list of official releases, however since it is early on in the
development of libvirt, it is preferable when possible to just use the <a href="downloads.html">CVS version or snapshot</a>, contact the mailing list
-and check the <a href="ChangeLog.html">ChangeLog</a> to gauge progress.</p><h3>0.4.2: Apr 8 2008</h3><ul><li>New features: memory operation for QEmu/KVM driver (Cole Robinson),
- new routed networking schemas (Mads Olesen)</li>
- <li>Documentation: storage documentation fixes (Atsushi Sakai), many
- typo cleanups (Atsushi Sakai), string fixes (Francesco Tombolini)</li>
- <li>Bug fixes: pointer errors in qemu (Jim Meyering), iSCSI login fix
+and check the <a href="ChangeLog.html">ChangeLog</a> to gauge progress.</p>
+ <h3>0.4.2: Apr 8 2008</h3>
+ <ul><li>New features: memory operation for QEmu/KVM driver (Cole Robinson),
+ new routed networking schemas (Mads Olesen)</li><li>Documentation: storage documentation fixes (Atsushi Sakai), many
+ typo cleanups (Atsushi Sakai), string fixes (Francesco Tombolini)</li><li>Bug fixes: pointer errors in qemu (Jim Meyering), iSCSI login fix
(Chris Lalancette), well formedness error in test driver capabilities
(Cole Robinson), fixes cleanup code when daemon exits (Daniel Berrange),
CD Rom change on live QEmu/KVM domains (Cole Robinson), setting scheduler
(Daniel Berrange), XML output fix for directory pools (Daniel Berrange),
remove dandling domain/net/conn pointers from error data, do not
ask polkit auth when root (Daniel Berrange), handling of fork and
- pipe errors when starting the daemon (Richard Jones)</li>
- <li>Improvements: better validation of MAC addresses (Jim Meyering and
+ pipe errors when starting the daemon (Richard Jones)</li><li>Improvements: better validation of MAC addresses (Jim Meyering and
Hiroyuki Kaguchi),
virsh vcpupin error report (Shigeki Sakamoto), keep boot tag on
HVM domains (Cole Robinson), virsh non-root should not be limited to read
move linux container support in the daemon (Dan Berrange), older
awk implementation support (Mike Gerdts), NUMA support in test
driver (Cole Robinson), xen and hvm added to test driver capabilities
- (Cole Robinson)</li>
- <li>Code cleanup: remove unused getopt header (Jim Meyering), mark more
- strings as translatable (Guido Günther and Jim Meyering), convert
+ (Cole Robinson)</li><li>Code cleanup: remove unused getopt header (Jim Meyering), mark more
+ strings as translatable (Guido Günther and Jim Meyering), convert
error strings to something meaningful and translatable (Jim Meyering),
- Linux Containers code cleanup, last error initializer (Guido Günther)</li>
-</ul><h3>0.4.1: Mar 3 2008</h3><ul><li>New features: build on MacOSX (Richard Jones), storage management
- (Daniel Berrange), Xenner - Xen on KVM - support (Daniel Berrange)</li>
- <li>Documentation: Fix of various typos (Atsushi SAKAI), memory and
+ Linux Containers code cleanup, last error initializer (Guido Günther)</li></ul>
+ <h3>0.4.1: Mar 3 2008</h3>
+ <ul><li>New features: build on MacOSX (Richard Jones), storage management
+ (Daniel Berrange), Xenner - Xen on KVM - support (Daniel Berrange)</li><li>Documentation: Fix of various typos (Atsushi SAKAI), memory and
vcpu settings details (Richard Jones), ethernet bridging typo
- (Maxwell Bottiger), add storage APIs documentation (Daniel Berrange)</li>
- <li>Bug fixes: OpenVZ code compilation (Mikhail Pokidko), crash in
+ (Maxwell Bottiger), add storage APIs documentation (Daniel Berrange)</li><li>Bug fixes: OpenVZ code compilation (Mikhail Pokidko), crash in
policykit auth handling (Daniel Berrange), large config files
(Daniel Berrange), cpumap hypercall size (Saori Fukuta), crash
in remote auth (Daniel Berrange), ssh args error (Daniel Berrange),
qemud signal pipe (Daniel Berrange), double free in OpenVZ
(Anton Protopopov), handle mac without addresses (Shigeki Sakamoto),
MAC addresses checks (Shigeki Sakamoto and Richard Jones),
- allow to read non-seekable files (Jim Meyering)</li>
- <li>Improvements: Windows build (Richard Jones), KVM/QEmu shutdown
+ allow to read non-seekable files (Jim Meyering)</li><li>Improvements: Windows build (Richard Jones), KVM/QEmu shutdown
(Guido Guenther), catch virExec output on debug (Mark McLoughlin),
integration of iptables and lokkit (Mark McLoughlin), keymap
parameter for VNC servers (Daniel Hokka Zakrisson), enable debug
virsh commands to manipulate and create storage(Daniel Berrange),
update use of PolicyKit APIs, better detection of fedault hypervisor,
block device statistics for QEmu/KVM (Richard Jones), various improvements
- for Xenner (Daniel Berrange)</li>
- <li>Code cleanups: avoid warnings (Daniel Berrange), virRun helper
+ for Xenner (Daniel Berrange)</li><li>Code cleanups: avoid warnings (Daniel Berrange), virRun helper
function (Dan Berrange), iptable code fixes (Mark McLoughlin),
static and const cleanups (Jim Meyering), malloc and python cleanups
(Jim Meyering), xstrtol_ull and xstrtol_ll functions (Daniel Berrange),
refactoring of code dealing with hypervisor capabilities (Daniel
Berrange), qemudReportError to use virErrorMsg (Cole Robinson),
intemediate library and Makefiles for compiling static and coverage
- rule support (Jim Meyering), cleanup of various leaks (Jim Meyering)</li>
-</ul><h3>0.4.0: Dec 18 2007</h3><ul><li>New features: Compilation on Windows cygwin/mingw (Richard Jones),
+ rule support (Jim Meyering), cleanup of various leaks (Jim Meyering)</li></ul>
+ <h3>0.4.0: Dec 18 2007</h3>
+ <ul><li>New features: Compilation on Windows cygwin/mingw (Richard Jones),
Ruby bindings (David Lutterkort), SASL based authentication for
libvirt remote support (Daniel Berrange), PolicyKit authentication
- (Daniel Berrange)</li>
- <li>Documentation: example files for QEMU and libvirtd configuations
+ (Daniel Berrange)</li><li>Documentation: example files for QEMU and libvirtd configuations
(Daniel Berrange), english cleanups (Jim Paris), CIM and OpenVZ
references, document <shareable/>, daemon startup when using
QEMU/KVM, document HV support for new NUMA calls (Richard Jones),
various english fixes (Bruce Montague), OCaml docs links (Richard Jones),
describe the various bindings add Ruby link, Windows support page
(Richard Jones), authentication documentation updates (Daniel Berrange)
- </li>
- <li>Bug fixes: NUMA topology error handling (Beth Kon), NUMA topology
+ </li><li>Bug fixes: NUMA topology error handling (Beth Kon), NUMA topology
cells without CPU (Beth Kon), XML to/from XM bridge config (Daniel
Berrange), XM processing of vnc parameters (Daniel Berrange), Reset
migration source after failure (Jim Paris), negative integer in config
parameter setting in XM config (Saori Fukuta), credential handling
fixes (Daniel Berrange), fix compatibility with Xen 3.2.0 (Daniel
Berrange)
- </li>
- <li>Improvements: /etc/libvirt/qemu.conf configuration for QEMU driver
+ </li><li>Improvements: /etc/libvirt/qemu.conf configuration for QEMU driver
(Daniel Berrange), NUMA cpu pinning in config files (DV and Saori Fukuta),
CDRom media change in KVM/QEMU (Daniel Berrange), tests for
<shareable/> in configs, pinning inactive domains for Xen 3.0.3
--without-libvirtd config option (Richard Jones), Python bindings for
NUMA, add extra utility functions to buffer (Richard Jones),
separate qparams module for handling query parameters (Richard Jones)
- </li>
- <li>Code cleanups: remove virDomainRestart from API as it was never used
+ </li><li>Code cleanups: remove virDomainRestart from API as it was never used
(Richard Jones), constify params for attach/detach APIs (Daniel Berrange),
gcc printf attribute checkings (Jim Meyering), refactoring of device
parsing code and shell escaping (Daniel Berrange), virsh schedinfo
port (Richard Jones), disable the proxy if using PolicyKit, readline
availability detection, test libvirtd's config-processing code (Jim
Meyering), use a variable name as sizeof argument (Jim Meyering)
- </li>
-</ul><h3>0.3.3: Sep 30 2007</h3><ul><li>New features: Avahi mDNS daemon export (Daniel Berrange),
- NUMA support (Beth Kan) </li>
- <li>Documentation: cleanups (Toth Istvan), typos (Eduardo Pereira), </li>
- <li>Bug fixes: memory corruption on large dumps (Masayuki Sunou), fix
+ </li></ul>
+ <h3>0.3.3: Sep 30 2007</h3>
+ <ul><li>New features: Avahi mDNS daemon export (Daniel Berrange),
+ NUMA support (Beth Kan) </li><li>Documentation: cleanups (Toth Istvan), typos (Eduardo Pereira), </li><li>Bug fixes: memory corruption on large dumps (Masayuki Sunou), fix
virsh vncdisplay command exit (Masayuki Sunou), Fix network stats
TX/RX result (Richard Jones), warning on Xen 3.0.3 (Richard Jones),
missing buffer check in virDomainXMLDevID (Hugh Brock), avoid zombies
(Richard Jones), avoid ssh tty prompt (Daniel Berrange), username
handling for remote URIs (Fabian Deutsch), fix potential crash
on multiple input XML tags (Daniel Berrange), Solaris Xen hypercalls
- fixup (Mark Johnson)</li>
- <li>Improvements: OpenVZ support (Shuveb Hussain and Anoop Cyriac),
+ fixup (Mark Johnson)</li><li>Improvements: OpenVZ support (Shuveb Hussain and Anoop Cyriac),
CD-Rom reload on XEn (Hugh Brock), PXE boot got QEmu/KVM (Daniel
Berrange), QEmu socket permissions customization (Daniel Berrange),
more QEmu support (Richard Jones), better path detection for qemu and
default bootloader support (Daniel Berrange), new virNodeGetFreeMemory
API, vncpasswd extraction in configuration files if secure (Mark
Johnson and Daniel Berrange), Python bindings for block and interface
- statistics</li>
- <li>Code cleanups: virDrvOpenRemoteFlags definition (Richard Jones),
- configure tests and output (Daniel Berrange)</li>
-
</ul><h3>0.3.2: Aug 21 2007</h3><ul><li>New features: KVM migration and save/restore (Jim Paris),
+ statistics</li><li>Code cleanups: virDrvOpenRemoteFlags definition (Richard Jones),
+ configure tests and output (Daniel Berrange)</li></ul>
+ <h3>0.3.2: Aug 21 2007</h3>
+
<ul><li>New features: KVM migration and save/restore (Jim Paris),
added API for migration (Richard Jones), added APIs for block device and
- interface statistic (Richard Jones).</li>
- <li>Documentation: examples for XML network APIs,
+ interface statistic (Richard Jones).</li><li>Documentation: examples for XML network APIs,
fix typo and schedinfo synopsis in man page (Atsushi SAKAI),
- hypervisor support page update (Richard Jones).</li>
- <li>Bug fixes: remove a couple of leaks in QEmu/KVM backend(Daniel berrange),
+ hypervisor support page update (Richard Jones).</li><li>Bug fixes: remove a couple of leaks in QEmu/KVM backend(Daniel berrange),
fix GnuTLS 1.0 compatibility (Richard Jones), --config/-f option
mistake for libvirtd (Richard Jones), remove leak in QEmu backend
(Jim Paris), fix some QEmu communication bugs (Jim Paris), UUID
lookup though proxy fix, setvcpus checking bugs (with Atsushi SAKAI),
int checking in virsh parameters (with Masayuki Sunou), deny devices
attach/detach for < Xen 3.0.4 (Masayuki Sunou), XenStore query
- memory leak (Masayuki Sunou), virsh schedinfo cleanup (Saori Fukuta).</li>
- <li>Improvement: virsh new ttyconsole command, networking API implementation
+ memory leak (Masayuki Sunou), virsh schedinfo cleanup (Saori Fukuta).</li><li>Improvement: virsh new ttyconsole command, networking API implementation
for test driver (Daniel berrange), qemu/kvm feature reporting of
ACPI/APIC (David Lutterkort), checking of QEmu architectures (Daniel
berrange), improve devices XML errors reporting (Masayuki Sunou),
speedup of domain queries on Xen (Daniel berrange), augment XML dumps
with interface devices names (Richard Jones), internal API to query
drivers for features (Richard Jones).
- </li>
- <li>Cleanups: Improve virNodeGetInfo implentation (Daniel berrange),
+ </li><li>Cleanups: Improve virNodeGetInfo implentation (Daniel berrange),
general UUID code cleanup (Daniel berrange), fix API generator
- file selection. </li>
-</ul><h3>0.3.1: Jul 24 2007</h3><ul><li>Documentation: index to remote page, script to test certificates,
+ file selection. </li></ul>
+ <h3>0.3.1: Jul 24 2007</h3>
+ <ul><li>Documentation: index to remote page, script to test certificates,
IPv6 remote support docs (Daniel Berrange), document
VIRSH_DEFAULT_CONNECT_URI in virsh man page (David Lutterkort),
- Relax-NG early grammar for the network XML (David Lutterkort)</li>
- <li>Bug fixes: leaks in disk XML parsing (Masayuki Sunou), hypervisor
+ Relax-NG early grammar for the network XML (David Lutterkort)</li><li>Bug fixes: leaks in disk XML parsing (Masayuki Sunou), hypervisor
alignment call problems on PPC64 (Christian Ehrhardt), dead client
registration in daemon event loop (Daniel Berrange), double free
in error handling (Daniel Berrange), close on exec for log file
descriptors in the daemon (Daniel Berrange), avoid caching problem
in remote daemon (Daniel Berrange), avoid crash after QEmu domain
- failure (Daniel Berrange)</li>
- <li>Improvements: checks of x509 certificates and keys (Daniel Berrange),
+ failure (Daniel Berrange)</li><li>Improvements: checks of x509 certificates and keys (Daniel Berrange),
error reports in the daemon (Daniel Berrange), checking of Ethernet MAC
addresses in XML configs (Masayuki Sunou), support for a new
clock switch between UTC and localtime (Daniel Berrange), early
on PS/2 and USB buses (Daniel Berrange), more tests especially
the QEmu support (Daniel Berrange), range check in credit scheduler
(with Saori Fukuta and Atsushi Sakai), add support for listen VNC
- parameter un QEmu and fix command line arg (Daniel Berrange)</li>
- <li>Cleanups: debug tracing (Richard Jones), removal of --with-qemud-pid-file
+ parameter un QEmu and fix command line arg (Daniel Berrange)</li><li>Cleanups: debug tracing (Richard Jones), removal of --with-qemud-pid-file
(Richard Jones), remove unused virDeviceMode, new util module for
code shared between drivers (Shuveb Hussain), xen header location
- detection (Richard Jones)</li>
-</ul><h3>0.3.0: Jul 9 2007</h3><ul><li>Secure Remote support (Richard Jones).
+ detection (Richard Jones)</li></ul>
+ <h3>0.3.0: Jul 9 2007</h3>
+ <ul><li>Secure Remote support (Richard Jones).
See <a href="http://libvirt.org/remote.html">the remote page</a>
of the documentation
</li><li>Documentation: remote support (Richard Jones), description of
the URI connection strings (Richard Jones), update of virsh man
page, matrix of libvirt API/hypervisor support with version
- information (Richard Jones)</li>
- <li>Bug fixes: examples Makefile.am generation (Richard Jones),
+ information (Richard Jones)</li><li>Bug fixes: examples Makefile.am generation (Richard Jones),
SetMem fix (Mark Johnson), URI handling and ordering of
drivers (Daniel Berrange), fix virsh help without hypervisor (Richard
Jones), id marshalling fix (Daniel Berrange), fix virConnectGetMaxVcpus
parameters handling for Xen (Richard Jones), various early remote
bug fixes (Richard Jones), remove virsh leaks of domains references
(Masayuki Sunou), configCache refill bug (Richard Jones), fix
- XML serialization bugs</li>
- <li>Improvements: QEmu switch to XDR-based protocol (Dan Berrange),
+ XML serialization bugs</li><li>Improvements: QEmu switch to XDR-based protocol (Dan Berrange),
device attach/detach commands (Masayuki Sunou), OCaml bindings
(Richard Jones), new entry points virDomainGetConnect and
virNetworkGetConnect useful for bindings (Richard Jones),
reunitifaction of remote and qemu daemon under a single libvirtd
- with a config file (Daniel Berrange)</li>
- <li>Cleanups: parsing of connection URIs (Richard Jones), messages
+ with a config file (Daniel Berrange)</li><li>Cleanups: parsing of connection URIs (Richard Jones), messages
from virsh (Saori Fukuta), Coverage files (Daniel Berrange),
Solaris fixes (Mark Johnson), avoid [r]index calls (Richard Jones),
release information in Xen backend, virsh cpupin command cleanups
directly (Daniel Berrange), virBuffer functions cleanups (Richard Jones),
make init script LSB compliant, error handling on lookup functions
(Richard Jones), remove internal virGetDomainByID (Richard Jones),
- revamp of xen subdrivers interfaces (Richard Jones)</li>
- <li>Localization updates</li>
-
</ul><h3>0.2.3: Jun 8 2007</h3><ul><li>Documentation: documentation for upcoming remote access (Richard Jones),
+ revamp of xen subdrivers interfaces (Richard Jones)</li><li>Localization updates</li></ul>
+ <h3>0.2.3: Jun 8 2007</h3>
+
<ul><li>Documentation: documentation for upcoming remote access (Richard Jones),
virConnectNumOfDefinedDomains doc (Jan Michael), virsh help messages
- for dumpxml and net-dumpxml (Chris Wright), </li>
- <li>Bug fixes: RelaxNG schemas regexp fix (Robin Green), RelaxNG arch bug
+ for dumpxml and net-dumpxml (Chris Wright), </li><li>Bug fixes: RelaxNG schemas regexp fix (Robin Green), RelaxNG arch bug
(Mark McLoughlin), large buffers bug fixes (Shigeki Sakamoto), error
on out of memory condition (Shigeki Sakamoto), virshStrdup fix, non-root
driver when using Xen bug (Richard Jones), use --strict-order when
fix compiler flags (Richard Jones), remove type ioemu on recent Xen
HVM for paravirt drivers (Saori Fukuta), uninitialized string bug
(Masayuki Sunou), allow init even if the daemon is not running,
- XML to config fix (Daniel Berrange)</li>
- <li>Improvements: add a special error class for the test module (Richard
+ XML to config fix (Daniel Berrange)</li><li>Improvements: add a special error class for the test module (Richard
Jones), virConnectGetCapabilities on proxy (Richard Jones), allow
network driver to decline usage (Richard Jones), extend error messages
for upcoming remote access (Richard Jones), on_reboot support for QEmu
insensitive and Python bindings (Richard Jones), new scheduler API
(Atsushi SAKAI), localizations updates, add logging option for virsh
(Nobuhiro Itou), allow arguments to be passed to bootloader (Hugh Brock),
- increase the test suite (Daniel Berrange and Hugh Brock)</li>
- <li>Cleanups: Remove VIR_DRV_OPEN_QUIET (Richard Jones), disable xm_internal.c
+ increase the test suite (Daniel Berrange and Hugh Brock)</li><li>Cleanups: Remove VIR_DRV_OPEN_QUIET (Richard Jones), disable xm_internal.c
for Xen > 3.0.3 (Daniel Berrange), unused fields in _virDomain (Richard
Jones), export __virGetDomain and __virGetNetwork for libvirtd only
(Richard Jones), ignore old VNC config for HVM on recent Xen (Daniel
- Berrange), various code cleanups, -Werror cleanup (Hugh Brock)</li>
-</ul><h3>0.2.2: Apr 17 2007</h3><ul><li>Documentation: fix errors due to Amaya (with Simon Hernandez),
+ Berrange), various code cleanups, -Werror cleanup (Hugh Brock)</li></ul>
+ <h3>0.2.2: Apr 17 2007</h3>
+ <ul><li>Documentation: fix errors due to Amaya (with Simon Hernandez),
virsh uses kB not bytes (Atsushi SAKAI), add command line help to
qemud (Richard Jones), xenUnifiedRegister docs (Atsushi SAKAI),
strings typos (Nikolay Sivov), ilocalization probalem raised by
- Thomas Canniot</li>
- <li>Bug fixes: virsh memory values test (Masayuki Sunou), operations without
+ Thomas Canniot</li><li>Bug fixes: virsh memory values test (Masayuki Sunou), operations without
libvirt_qemud (Atsushi SAKAI), fix spec file (Florian La Roche, Jeremy
Katz, Michael Schwendt),
direct hypervisor call (Atsushi SAKAI), buffer overflow on qemu
McLoughlin), set VIR_CONNECT_RO on read-only connections (S.Sakamoto),
avoid memory explosion bug (Daniel Berrange), integer overflow
for qemu CPU time (Daniel Berrange), QEMU binary path check (Daniel
- Berrange)</li>
- <li>Cleanups: remove some global variables (Jim Meyering), printf-style
+ Berrange)</li><li>Cleanups: remove some global variables (Jim Meyering), printf-style
functions checks (Jim Meyering), better virsh error messages, increase
compiler checkings and security (Daniel Berrange), virBufferGrow usage
and docs, use calloc instead of malloc/memset, replace all sprintf by
signal handler error cleanup (Richard Jones), iptables internal code
claenup (Mark McLoughlin), unified Xen driver (Richard Jones),
cleanup XPath libxml2 calls, IPTables rules tightening (Daniel
- Berrange), </li>
- <li>Improvements: more regression tests on XML (Daniel Berrange), Python
+ Berrange), </li><li>Improvements: more regression tests on XML (Daniel Berrange), Python
bindings now generate exception in error cases (Richard Jones),
Python bindings for vir*GetAutoStart (Daniel Berrange),
handling of CD-Rom device without device name (Nobuhiro Itou),
fix hypervisor call to work with Xen 3.0.5 (Daniel Berrange),
DomainGetOSType for inactive domains (Daniel Berrange), multiple boot
devices for HVM (Daniel Berrange),
- </li>
-</ul><h3>0.2.1: Mar 16 2007</h3><ul><li>Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin)</li>
- <li>Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt
+ </li></ul>
+ <h3>0.2.1: Mar 16 2007</h3>
+ <ul><li>Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin)</li><li>Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt
config directory (Daniel Berrange and Mark McLoughlin), memory leak
in qemud (Mark), various fixes on network support (Mark), avoid Xen
domain zombies on device hotplug errors (Daniel Berrange), various
(Rich Jones), read-only socket cleanup (Rich Jones), use of vnc port 5900
(Nobuhiro Itou), assorted networking fixes (Daniel Berrange), shutoff and
shutdown mismatches (Kazuki Mizushima), unlimited memory handling
- (Atsushi SAKAI), python binding fixes (Tatsuro Enokura)</li>
- <li>Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies
+ (Atsushi SAKAI), python binding fixes (Tatsuro Enokura)</li><li>Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies
and build (Daniel Berrange), fix xend port detection (Daniel
Berrange), icompile time warnings (Mark), avoid const related
compiler warnings (Daniel Berrange), automated builds (Daniel
Berrange), pointer/int mismatch (Richard Jones), configure time
- selection of drivers, libvirt spec hacking (Daniel Berrange)</li>
- <li>Add support for network autostart and init scripts (Mark McLoughlin)</li>
- <li>New API virConnectGetCapabilities() to detect the virtualization
- capabilities of a host (Richard Jones)</li>
- <li>Minor improvements: qemud signal handling (Mark), don't shutdown or reboot
+ selection of drivers, libvirt spec hacking (Daniel Berrange)</li><li>Add support for network autostart and init scripts (Mark McLoughlin)</li><li>New API virConnectGetCapabilities() to detect the virtualization
+ capabilities of a host (Richard Jones)</li><li>Minor improvements: qemud signal handling (Mark), don't shutdown or reboot
domain0 (Kazuki Mizushima), QEmu version autodetection (Daniel Berrange),
network UUIDs (Mark), speed up UUID domain lookups (Tatsuro Enokura and
Daniel Berrange), support for paused QEmu CPU (Daniel Berrange), keymap
VNC attribute support (Takahashi Tomohiro and Daniel Berrange), maximum
number of virtual CPU (Masayuki Sunou), virtsh --readonly option (Rich
- Jones), python bindings for new functions (Daniel Berrange)</li>
- <li>Documentation updates especially on the XML formats</li>
-</ul><h3>0.2.0: Feb 14 2007</h3><ul><li>Various internal cleanups (Mark McLoughlin, Richard Jones,
- Daniel Berrange, Karel Zak)</li>
- <li>Bug fixes: avoid a crash in connect (Daniel Berrange), virsh args
- parsing (Richard Jones)</li>
- <li>Add support for QEmu and KVM virtualization (Daniel Berrange)</li>
- <li>Add support for network configuration (Mark McLoughlin)</li>
- <li>Minor improvements: regression testing (Daniel Berrange),
- localization string updates</li>
-</ul><h3>0.1.11: Jan 22 2007</h3><ul><li>Finish XML <-> XM config files support</li>
- <li>Remove memory leak when freeing virConf objects</li>
- <li>Finishing inactive domain support (Daniel Berrange)</li>
- <li>Added a Relax-NG schemas to check XML instances</li>
-</ul><h3>0.1.10: Dec 20 2006</h3><ul><li>more localizations</li>
- <li>bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains buffer overflow (Daniel Berrange), reference count bug when creating Xen domains (Daniel Berrange).</li>
- <li>improvements: support graphic framebuffer for Xen paravirt (Daniel Berrange), VNC listen IP range support (Daniel Berrange), support for default Xen config files and inactive domains of 3.0.4 (Daniel Berrange).</li>
-</ul><h3>0.1.9: Nov 29 2006</h3><ul><li>python bindings: release interpeter lock when calling C (Daniel Berrange)</li>
- <li>don't raise HTTP error when looking information for a domain</li>
- <li>some refactoring to use the driver for all entry points</li>
- <li>better error reporting (Daniel Berrange)</li>
- <li>fix OS reporting when running as non-root</li>
- <li>provide XML parsing errors</li>
- <li>extension of the test framework (Daniel Berrange)</li>
- <li>fix the reconnect regression test</li>
- <li>python bindings: Domain instances now link to the Connect to avoid garbage collection and disconnect</li>
- <li>separate the notion of maximum memory and current use at the XML level</li>
- <li>Fix a memory leak (Daniel Berrange)</li>
- <li>add support for shareable drives</li>
- <li>add support for non-bridge style networking configs for guests(Daniel Berrange)</li>
- <li>python bindings: fix unsigned long marshalling (Daniel Berrange)</li>
- <li>new config APIs virConfNew() and virConfSetValue() to build configs from scratch</li>
- <li>hot plug device support based on Michel Ponceau patch</li>
- <li>added support for inactive domains, new APIs, various associated cleanup (Daniel Berrange)</li>
- <li>special device model for HVM guests (Daniel Berrange)</li>
- <li>add API to dump core of domains (but requires a patched xend)</li>
- <li>pygrub bootloader information take over <os> information</li>
- <li>updated the localization strings</li>
-</ul><h3>0.1.8: Oct 16 2006</h3><ul><li> Bug for system with page size != 4k</li>
- <li> vcpu number initialization (Philippe Berthault)</li>
- <li> don't label crashed domains as shut off (Peter Vetere)</li>
- <li> fix virsh man page (Noriko Mizumoto)</li>
- <li> blktapdd support for alternate drivers like blktap (Daniel Berrange)</li>
- <li> memory leak fixes (xend interface and XML parsing) (Daniel Berrange)</li>
- <li> compile fix</li>
- <li> mlock/munlock size fixes (Daniel Berrange)</li>
- <li> improve error reporting</li>
-</ul><h3>0.1.7: Sep 29 2006</h3><ul><li> fix a memory bug on getting vcpu information from xend (Daniel Berrange)</li>
- <li> fix another problem in the hypercalls change in Xen changeset
- 86d26e6ec89b when getting domain information (Daniel Berrange)</li>
-</ul><h3>0.1.6: Sep 22 2006</h3><ul><li>Support for localization of strings using gettext (Daniel Berrange)</li>
- <li>Support for new Xen-3.0.3 cdrom and disk configuration (Daniel Berrange)</li>
- <li>Support for setting VNC port when creating domains with new
- xend config files (Daniel Berrange) </li>
- <li>Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig)</li>
- <li>Fix reconnection problem when talking directly to http xend</li>
-</ul><h3>0.1.5: Sep 5 2006</h3><ul><li>Support for new hypercalls change in Xen changeset 86d26e6ec89b</li>
- <li>bug fixes: virParseUUID() was wrong, netwoking for paravirt guestsi
+ Jones), python bindings for new functions (Daniel Berrange)</li><li>Documentation updates especially on the XML formats</li></ul>
+ <h3>0.2.0: Feb 14 2007</h3>
+ <ul><li>Various internal cleanups (Mark McLoughlin, Richard Jones,
+ Daniel Berrange, Karel Zak)</li><li>Bug fixes: avoid a crash in connect (Daniel Berrange), virsh args
+ parsing (Richard Jones)</li><li>Add support for QEmu and KVM virtualization (Daniel Berrange)</li><li>Add support for network configuration (Mark McLoughlin)</li><li>Minor improvements: regression testing (Daniel Berrange),
+ localization string updates</li></ul>
+ <h3>0.1.11: Jan 22 2007</h3>
+ <ul><li>Finish XML <-> XM config files support</li><li>Remove memory leak when freeing virConf objects</li><li>Finishing inactive domain support (Daniel Berrange)</li><li>Added a Relax-NG schemas to check XML instances</li></ul>
+ <h3>0.1.10: Dec 20 2006</h3>
+ <ul><li>more localizations</li><li>bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains buffer overflow (Daniel Berrange), reference count bug when creating Xen domains (Daniel Berrange).</li><li>improvements: support graphic framebuffer for Xen paravirt (Daniel Berrange), VNC listen IP range support (Daniel Berrange), support for default Xen config files and inactive domains of 3.0.4 (Daniel Berrange).</li></ul>
+ <h3>0.1.9: Nov 29 2006</h3>
+ <ul><li>python bindings: release interpeter lock when calling C (Daniel Berrange)</li><li>don't raise HTTP error when looking information for a domain</li><li>some refactoring to use the driver for all entry points</li><li>better error reporting (Daniel Berrange)</li><li>fix OS reporting when running as non-root</li><li>provide XML parsing errors</li><li>extension of the test framework (Daniel Berrange)</li><li>fix the reconnect regression test</li><li>python bindings: Domain instances now link to the Connect to avoid garbage collection and disconnect</li><li>separate the notion of maximum memory and current use at the XML level</li><li>Fix a memory leak (Daniel Berrange)</li><li>add support for shareable drives</li><li>add support for non-bridge style networking configs for guests(Daniel Berrange)</li><li>python bindings: fix unsigned long marshalling (Daniel Berrange)</li><li>new config APIs virConfNew() and virConfSetValue() to build configs from scratch</li><li>hot plug device support based on Michel Ponceau patch</li><li>added support for inactive domains, new APIs, various associated cleanup (Daniel Berrange)</li><li>special device model for HVM guests (Daniel Berrange)</li><li>add API to dump core of domains (but requires a patched xend)</li><li>pygrub bootloader information take over <os> information</li><li>updated the localization strings</li></ul>
+ <h3>0.1.8: Oct 16 2006</h3>
+ <ul><li> Bug for system with page size != 4k</li><li> vcpu number initialization (Philippe Berthault)</li><li> don't label crashed domains as shut off (Peter Vetere)</li><li> fix virsh man page (Noriko Mizumoto)</li><li> blktapdd support for alternate drivers like blktap (Daniel Berrange)</li><li> memory leak fixes (xend interface and XML parsing) (Daniel Berrange)</li><li> compile fix</li><li> mlock/munlock size fixes (Daniel Berrange)</li><li> improve error reporting</li></ul>
+ <h3>0.1.7: Sep 29 2006</h3>
+ <ul><li> fix a memory bug on getting vcpu information from xend (Daniel Berrange)</li><li> fix another problem in the hypercalls change in Xen changeset
+ 86d26e6ec89b when getting domain information (Daniel Berrange)</li></ul>
+ <h3>0.1.6: Sep 22 2006</h3>
+ <ul><li>Support for localization of strings using gettext (Daniel Berrange)</li><li>Support for new Xen-3.0.3 cdrom and disk configuration (Daniel Berrange)</li><li>Support for setting VNC port when creating domains with new
+ xend config files (Daniel Berrange) </li><li>Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig)</li><li>Fix reconnection problem when talking directly to http xend</li></ul>
+ <h3>0.1.5: Sep 5 2006</h3>
+ <ul><li>Support for new hypercalls change in Xen changeset 86d26e6ec89b</li><li>bug fixes: virParseUUID() was wrong, netwoking for paravirt guestsi
(Daniel Berrange), virsh on non-existent domains (Daniel Berrange),
string cast bug when handling error in python (Pete Vetere), HTTP
- 500 xend error code handling (Pete Vetere and Daniel Berrange)</li>
- <li>improvements: test suite for SEXPR <-> XML format conversions (Daniel
+ 500 xend error code handling (Pete Vetere and Daniel Berrange)</li><li>improvements: test suite for SEXPR <-> XML format conversions (Daniel
Berrange), virsh output regression suite (Daniel Berrange), new environ
variable VIRSH_DEFAULT_CONNECT_URI for the default URI when connecting
(Daniel Berrange), graphical console support for paravirt guests
(Jeremy Katz), parsing of simple Xen config files (with Daniel Berrange),
early work on defined (not running) domains (Daniel Berrange),
- virsh output improvement (Daniel Berrange</li>
-</ul><h3>0.1.4: Aug 16 2006</h3><ul><li>bug fixes: spec file fix (Mark McLoughlin), error report problem (with
+ virsh output improvement (Daniel Berrange</li></ul>
+ <h3>0.1.4: Aug 16 2006</h3>
+ <ul><li>bug fixes: spec file fix (Mark McLoughlin), error report problem (with
Hugh Brock), long integer in Python bindings (with Daniel Berrange), XML
generation bug for CDRom (Daniel Berrange), bug whem using number() XPath
function (Mark McLoughlin), fix python detection code, remove duplicate
- initialization errors (Daniel Berrange)</li>
- <li>improvements: UUID in XML description (Peter Vetere), proxy code
+ initialization errors (Daniel Berrange)</li><li>improvements: UUID in XML description (Peter Vetere), proxy code
cleanup, virtual CPU and affinity support + virsh support (Michel
Ponceau, Philippe Berthault, Daniel Berrange), port and tty information
for console in XML (Daniel Berrange), added XML dump to driver and proxy
floppy and cdrom (Daniel Berrange), features block in XML to report/ask
PAE, ACPI, APIC for HVM domains (Daniel Berrange), fail saide-effect
operations when using read-only connection, large improvements to test
- driver (Daniel Berrange) </li>
- <li>documentation: spelling (Daniel Berrange), test driver examples.</li>
-
</ul><h3>0.1.3: Jul 11 2006</h3><ul><li>bugfixes: build as non-root, fix xend access when root, handling of
+ driver (Daniel Berrange) </li><li>documentation: spelling (Daniel Berrange), test driver examples.</li></ul>
+ <h3>0.1.3: Jul 11 2006</h3>
+
<ul><li>bugfixes: build as non-root, fix xend access when root, handling of
empty XML elements (Mark McLoughlin), XML serialization and parsing fixes
(Mark McLoughlin), allow to create domains without disk (Mark
- McLoughlin),</li>
- <li>improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel Berrange),
- support for fully virtualized guest (Jim Fehlig, DV, Mark McLoughlin)</li>
- <li>documentation: augmented to cover hvm domains</li>
-</ul><h3>0.1.2: Jul 3 2006</h3><ul><li>headers include paths fixup</li>
- <li>proxy mechanism for unprivileged read-only access by httpu</li>
-</ul><h3>0.1.1: Jun 21 2006</h3><ul><li>building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
- Berrange)</li>
- <li>driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
- Berrange)</li>
- <li>Cope with API change introduced in Xen changeset 10277</li>
- <li>new test driver for regression checks (Daniel P. Berrange)</li>
- <li>improvements: added UUID to XML serialization, buffer usage (Karel
- Zak), --connect argument to virsh (Daniel P. Berrange),</li>
- <li>bug fixes: uninitialized memory access in error reporting, S-Expr
+ McLoughlin),</li><li>improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel Berrange),
+ support for fully virtualized guest (Jim Fehlig, DV, Mark McLoughlin)</li><li>documentation: augmented to cover hvm domains</li></ul>
+ <h3>0.1.2: Jul 3 2006</h3>
+ <ul><li>headers include paths fixup</li><li>proxy mechanism for unprivileged read-only access by httpu</li></ul>
+ <h3>0.1.1: Jun 21 2006</h3>
+ <ul><li>building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
+ Berrange)</li><li>driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
+ Berrange)</li><li>Cope with API change introduced in Xen changeset 10277</li><li>new test driver for regression checks (Daniel P. Berrange)</li><li>improvements: added UUID to XML serialization, buffer usage (Karel
+ Zak), --connect argument to virsh (Daniel P. Berrange),</li><li>bug fixes: uninitialized memory access in error reporting, S-Expr
parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO in
- xs_internal.c</li>
- <li>documentation: Python examples (David Lutterkort), new Perl binding
- URL, man page update (Karel Zak)</li>
-</ul><h3>0.1.0: Apr 10 2006</h3><ul><li>building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
- build and pkginfo cflag fix (Daniel Berrange)</li>
- <li>enhancement and fixes of the XML description format (David Lutterkort
- and Jim Fehlig)</li>
- <li>new APIs: for Node information and Reboot</li>
- <li>internal code cleanup: refactoring internals into a driver model, more
- error handling, structure sharing, thread safety and ref counting</li>
- <li>bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
- Meyering), virDomainLookupByID (Jim Fehlig),</li>
- <li>documentation: updates on architecture, and format, typo fix (Jim
- Meyering)</li>
- <li>bindings: exception handling in examples (Jim Meyering), perl ones out
- of tree (Daniel Berrange)</li>
- <li>virsh: more options, create, nodeinfo (Karel Zak), renaming of some
+ xs_internal.c</li><li>documentation: Python examples (David Lutterkort), new Perl binding
+ URL, man page update (Karel Zak)</li></ul>
+ <h3>0.1.0: Apr 10 2006</h3>
+ <ul><li>building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
+ build and pkginfo cflag fix (Daniel Berrange)</li><li>enhancement and fixes of the XML description format (David Lutterkort
+ and Jim Fehlig)</li><li>new APIs: for Node information and Reboot</li><li>internal code cleanup: refactoring internals into a driver model, more
+ error handling, structure sharing, thread safety and ref counting</li><li>bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
+ Meyering), virDomainLookupByID (Jim Fehlig),</li><li>documentation: updates on architecture, and format, typo fix (Jim
+ Meyering)</li><li>bindings: exception handling in examples (Jim Meyering), perl ones out
+ of tree (Daniel Berrange)</li><li>virsh: more options, create, nodeinfo (Karel Zak), renaming of some
options (Karel Zak), use stderr only for errors (Karel Zak), man page
- (Andrew Puch)</li>
-</ul><h3>0.0.6: Feb 28 2006</h3><ul><li>add UUID lookup and extract API</li>
- <li>add error handling APIs both synchronous and asynchronous</li>
- <li>added minimal hook for error handling at the python level, improved the
- python bindings</li>
- <li>augment the documentation and tests to cover error handling</li>
-</ul><h3>0.0.5: Feb 23 2006</h3><ul><li>Added XML description parsing, dependance to libxml2, implemented the
- creation API virDomainCreateLinux()</li>
- <li>new APIs to lookup and name domain by UUID</li>
- <li>fixed the XML dump when using the Xend access</li>
- <li>Fixed a few more problem related to the name change</li>
- <li>Adding regression tests in python and examples in C</li>
- <li>web site improvement, extended the documentation to cover the XML
- format and Python API</li>
- <li>Added devhelp help for Gnome/Gtk programmers</li>
-</ul><h3>0.0.4: Feb 10 2006</h3><ul><li>Fix various bugs introduced in the name change</li>
-</ul><h3>0.0.3: Feb 9 2006</h3><ul><li>Switch name from from 'libvir' to libvirt</li>
- <li>Starting infrastructure to add code examples</li>
- <li>Update of python bindings for completeness</li>
-</ul><h3>0.0.2: Jan 29 2006</h3><ul><li>Update of the documentation, web site redesign (Diana Fong)</li>
- <li>integration of HTTP xend RPC based on libxend by Anthony Liquori for
- most operations</li>
- <li>Adding Save and Restore APIs</li>
- <li>extended the virsh command line tool (Karel Zak)</li>
- <li>remove xenstore transactions (Anthony Liguori)</li>
- <li>fix the Python bindings bug when domain and connections where freed</li>
-</ul><h3>0.0.1: Dec 19 2005</h3><ul><li>First release</li>
- <li>Basic management of existing Xen domains</li>
- <li>Minimal autogenerated Python bindings</li>
-</ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+ (Andrew Puch)</li></ul>
+ <h3>0.0.6: Feb 28 2006</h3>
+ <ul><li>add UUID lookup and extract API</li><li>add error handling APIs both synchronous and asynchronous</li><li>added minimal hook for error handling at the python level, improved the
+ python bindings</li><li>augment the documentation and tests to cover error handling</li></ul>
+ <h3>0.0.5: Feb 23 2006</h3>
+ <ul><li>Added XML description parsing, dependance to libxml2, implemented the
+ creation API virDomainCreateLinux()</li><li>new APIs to lookup and name domain by UUID</li><li>fixed the XML dump when using the Xend access</li><li>Fixed a few more problem related to the name change</li><li>Adding regression tests in python and examples in C</li><li>web site improvement, extended the documentation to cover the XML
+ format and Python API</li><li>Added devhelp help for Gnome/Gtk programmers</li></ul>
+ <h3>0.0.4: Feb 10 2006</h3>
+ <ul><li>Fix various bugs introduced in the name change</li></ul>
+ <h3>0.0.3: Feb 9 2006</h3>
+ <ul><li>Switch name from from 'libvir' to libvirt</li><li>Starting infrastructure to add code examples</li><li>Update of python bindings for completeness</li></ul>
+ <h3>0.0.2: Jan 29 2006</h3>
+ <ul><li>Update of the documentation, web site redesign (Diana Fong)</li><li>integration of HTTP xend RPC based on libxend by Anthony Liquori for
+ most operations</li><li>Adding Save and Restore APIs</li><li>extended the virsh command line tool (Karel Zak)</li><li>remove xenstore transactions (Anthony Liguori)</li><li>fix the Python bindings bug when domain and connections where freed</li></ul>
+ <h3>0.0.1: Dec 19 2005</h3>
+ <ul><li>First release</li><li>Basic management of existing Xen domains</li><li>Minimal autogenerated Python bindings</li></ul>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <span class="active">News</span>
+ <ul class="l1"><li>
+ <a title="Latest commit messages from the source repository " class="inactive" href="ChangeLog.html">Changelog</a>
+ </li></ul>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1 >Releases</h1>
+ <p>Here is the list of official releases, however since it is early on in the
+development of libvirt, it is preferable when possible to just use the <a href="downloads.html">CVS version or snapshot</a>, contact the mailing list
+and check the <a href="ChangeLog.html">ChangeLog</a> to gauge progress.</p>
+ <h3>0.4.2: Apr 8 2008</h3>
+ <ul>
+ <li>New features: memory operation for QEmu/KVM driver (Cole Robinson),
+ new routed networking schemas (Mads Olesen)</li>
+ <li>Documentation: storage documentation fixes (Atsushi Sakai), many
+ typo cleanups (Atsushi Sakai), string fixes (Francesco Tombolini)</li>
+ <li>Bug fixes: pointer errors in qemu (Jim Meyering), iSCSI login fix
+ (Chris Lalancette), well formedness error in test driver capabilities
+ (Cole Robinson), fixes cleanup code when daemon exits (Daniel Berrange),
+ CD Rom change on live QEmu/KVM domains (Cole Robinson), setting scheduler
+ parameter is forbidden for read-only (Saori Fukuta)i, fixes for TAP
+ devices (Daniel Berrange), assorted storage driver fixes (Daniel
+ Berrange), Makefile fixes (Jim Meyering), Xen-3.2 hypercall fix,
+ fix iptables rules to avoid blocking traffic within virtual network
+ (Daniel Berrange), XML output fix for directory pools (Daniel Berrange),
+ remove dandling domain/net/conn pointers from error data, do not
+ ask polkit auth when root (Daniel Berrange), handling of fork and
+ pipe errors when starting the daemon (Richard Jones)</li>
+ <li>Improvements: better validation of MAC addresses (Jim Meyering and
+ Hiroyuki Kaguchi),
+ virsh vcpupin error report (Shigeki Sakamoto), keep boot tag on
+ HVM domains (Cole Robinson), virsh non-root should not be limited to read
+ only anymore (Daniel Berrange), switch to polkit-auth from polkit-grant
+ (Daniel Berrange), better handling of missing SElinux data (Daniel
+ Berrange and Jim Meyering), cleanup of the connection opening logic
+ (Daniel Berrange), first bits of Linux Containers support (Dave Leskovec),
+ scheduler API support via xend (Saori Fukuta), improvement of the
+ testing framework and first tests (Jim Meyering), missing error
+ messages from virsh parameters validation (Shigeki Sakamoto),
+ improve support of older iscsiadm command (Chris Lalancette),
+ move linux container support in the daemon (Dan Berrange), older
+ awk implementation support (Mike Gerdts), NUMA support in test
+ driver (Cole Robinson), xen and hvm added to test driver capabilities
+ (Cole Robinson)</li>
+ <li>Code cleanup: remove unused getopt header (Jim Meyering), mark more
+ strings as translatable (Guido Günther and Jim Meyering), convert
+ error strings to something meaningful and translatable (Jim Meyering),
+ Linux Containers code cleanup, last error initializer (Guido Günther)</li>
+ </ul>
+ <h3>0.4.1: Mar 3 2008</h3>
+ <ul>
+ <li>New features: build on MacOSX (Richard Jones), storage management
+ (Daniel Berrange), Xenner - Xen on KVM - support (Daniel Berrange)</li>
+ <li>Documentation: Fix of various typos (Atsushi SAKAI), memory and
+ vcpu settings details (Richard Jones), ethernet bridging typo
+ (Maxwell Bottiger), add storage APIs documentation (Daniel Berrange)</li>
+ <li>Bug fixes: OpenVZ code compilation (Mikhail Pokidko), crash in
+ policykit auth handling (Daniel Berrange), large config files
+ (Daniel Berrange), cpumap hypercall size (Saori Fukuta), crash
+ in remote auth (Daniel Berrange), ssh args error (Daniel Berrange),
+ preserve vif order from config files (Hiroyuki Kaguchi), invalid
+ pointer access (Jim Meyering), virDomainGetXMLDesc flag handling,
+ device name conversion on stats (Daniel Berrange), double mutex lock
+ (Daniel Berrange), config file reading crashes (Guido Guenther),
+ xenUnifiedDomainSuspend bug (Marcus Meissner), do not crash if
+ /sys/hypervisor/capabilities is missing (Mark McLoughlin),
+ virHashRemoveSet bug (Hiroyuki Kaguchi), close-on-exec flag for
+ qemud signal pipe (Daniel Berrange), double free in OpenVZ
+ (Anton Protopopov), handle mac without addresses (Shigeki Sakamoto),
+ MAC addresses checks (Shigeki Sakamoto and Richard Jones),
+ allow to read non-seekable files (Jim Meyering)</li>
+ <li>Improvements: Windows build (Richard Jones), KVM/QEmu shutdown
+ (Guido Guenther), catch virExec output on debug (Mark McLoughlin),
+ integration of iptables and lokkit (Mark McLoughlin), keymap
+ parameter for VNC servers (Daniel Hokka Zakrisson), enable debug
+ by default using VIR_DEBUG (Daniel Berrange), xen 3.2 fixes
+ (Daniel Berrange), Python bindings for VCPU and scheduling
+ (Daniel Berrange), framework for automatic code syntax checks
+ (Jim Meyering), allow kernel+initrd setup in Xen PV (Daniel Berrange),
+ allow change of Disk/NIC of an inactive domains (Shigeki Sakamoto),
+ virsh commands to manipulate and create storage(Daniel Berrange),
+ update use of PolicyKit APIs, better detection of fedault hypervisor,
+ block device statistics for QEmu/KVM (Richard Jones), various improvements
+ for Xenner (Daniel Berrange)</li>
+ <li>Code cleanups: avoid warnings (Daniel Berrange), virRun helper
+ function (Dan Berrange), iptable code fixes (Mark McLoughlin),
+ static and const cleanups (Jim Meyering), malloc and python cleanups
+ (Jim Meyering), xstrtol_ull and xstrtol_ll functions (Daniel Berrange),
+ remove no-op networking from OpenVZ (Daniel Berrange), python generator
+ cleanups (Daniel Berrange), cleanup ref counting (Daniel Berrange),
+ remove uninitialized warnings (Jim Meyering), cleanup configure
+ for RHEL4 (Daniel Berrange), CR/LF cleanups (Richard Jones),
+ various automatic code check and associated cleanups (Jim Meyering),
+ various memory leaks (Jim Meyering), fix compilation when building
+ without Xen (Guido Guenther), mark translatables strings (Jim Meyering),
+ use virBufferAddLit for constant strings (Jim Meyering), fix
+ make distcheck (Jim Meyering), return values for python bindings (Cole
+ Robinson), trailing blanks fixes (Jim Meyering), gcc-4.3.0 fixes
+ (Mark McLoughlin), use safe read and write routines (Jim Meyering),
+ refactoring of code dealing with hypervisor capabilities (Daniel
+ Berrange), qemudReportError to use virErrorMsg (Cole Robinson),
+ intemediate library and Makefiles for compiling static and coverage
+ rule support (Jim Meyering), cleanup of various leaks (Jim Meyering)</li>
+ </ul>
+ <h3>0.4.0: Dec 18 2007</h3>
+ <ul>
+ <li>New features: Compilation on Windows cygwin/mingw (Richard Jones),
+ Ruby bindings (David Lutterkort), SASL based authentication for
+ libvirt remote support (Daniel Berrange), PolicyKit authentication
+ (Daniel Berrange)</li>
+ <li>Documentation: example files for QEMU and libvirtd configuations
+ (Daniel Berrange), english cleanups (Jim Paris), CIM and OpenVZ
+ references, document <shareable/>, daemon startup when using
+ QEMU/KVM, document HV support for new NUMA calls (Richard Jones),
+ various english fixes (Bruce Montague), OCaml docs links (Richard Jones),
+ describe the various bindings add Ruby link, Windows support page
+ (Richard Jones), authentication documentation updates (Daniel Berrange)
+ </li>
+ <li>Bug fixes: NUMA topology error handling (Beth Kon), NUMA topology
+ cells without CPU (Beth Kon), XML to/from XM bridge config (Daniel
+ Berrange), XM processing of vnc parameters (Daniel Berrange), Reset
+ migration source after failure (Jim Paris), negative integer in config
+ (Tatsuro Enokura), zero terminating string buffer, detect integer
+ overflow (Jim Meyering), QEmu command line ending fixes (Daniel Berrange),
+ recursion problem in the daemon (Daniel Berrange), HVM domain with CDRom
+ (Masayuki Sunou), off by one error in NUMA cpu count (Beth Kon),
+ avoid xend errors when adding disks (Masayuki Sunou), compile error
+ (Chris Lalancette), transposed fwrite args (Jim Meyering), compile
+ without xen and on solaris (Jim Paris), parsing of interface names
+ (Richard Jones), overflow for starts on 32bits (Daniel Berrange),
+ fix problems in error reporting (Saori Fukuta), wrong call to
+ brSetForwardDelay changed to brSetEnableSTP (Richard Jones),
+ allow shareable disk in old Xen, fix wrong certificate file (Jim
+ Meyering), avoid some startup error when non-root, off-by-1 buffer
+ NULL termination (Daniel Berrange), various string allocation fixes
+ (Daniel Berrange), avoid problems with vnetXXX interfaces in domain dumps
+ (Daniel Berrange), build fixes for RHEL (Daniel Berrange), virsh prompt
+ should not depend on uid (Richard Jones), fix scaping of '<' (Richard
+ Jones), fix detach-disk on Xen tap devices (Saori Fukuta), CPU
+ parameter setting in XM config (Saori Fukuta), credential handling
+ fixes (Daniel Berrange), fix compatibility with Xen 3.2.0 (Daniel
+ Berrange)
+ </li>
+ <li>Improvements: /etc/libvirt/qemu.conf configuration for QEMU driver
+ (Daniel Berrange), NUMA cpu pinning in config files (DV and Saori Fukuta),
+ CDRom media change in KVM/QEMU (Daniel Berrange), tests for
+ <shareable/> in configs, pinning inactive domains for Xen 3.0.3
+ (Saori Fukuta), use gnulib for portability enhancement (Jim Meyering),
+ --without-libvirtd config option (Richard Jones), Python bindings for
+ NUMA, add extra utility functions to buffer (Richard Jones),
+ separate qparams module for handling query parameters (Richard Jones)
+ </li>
+ <li>Code cleanups: remove virDomainRestart from API as it was never used
+ (Richard Jones), constify params for attach/detach APIs (Daniel Berrange),
+ gcc printf attribute checkings (Jim Meyering), refactoring of device
+ parsing code and shell escaping (Daniel Berrange), virsh schedinfo
+ parameters validation (Masayuki Sunou), Avoid risk of format string abuse
+ (Jim Meyering), integer parsing cleanups (Jim Meyering), build out
+ of the source tree (Jim Meyering), URI parsing refactoring (Richard
+ Jones), failed strdup/malloc handling (Jim Meyering), Make "make
+ distcheck" work (Jim Meyering), improve xen internall error reports
+ (Richard Jones), cleanup of the daemon remote code (Daniel Berrange),
+ rename error VIR_FROM_LINUX to VIR_FROM_STATS_LINUX (Richard Jones),
+ don't compile the proxy if without Xen (Richard Jones), fix paths when
+ configuring for /usr prefix, improve error reporting code (Jim Meyering),
+ detect heap allocation failure (Jim Meyering), disable xen sexpr parsing
+ code if Xen is disabled (Daniel Berrange), cleanup of the GetType
+ entry point for Xen drivers, move some QEmu path handling to generic
+ module (Daniel Berrange), many code cleanups related to the Windows
+ port (Richard Jones), disable the proxy if using PolicyKit, readline
+ availability detection, test libvirtd's config-processing code (Jim
+ Meyering), use a variable name as sizeof argument (Jim Meyering)
+ </li>
+ </ul>
+ <h3>0.3.3: Sep 30 2007</h3>
+ <ul>
+ <li>New features: Avahi mDNS daemon export (Daniel Berrange),
+ NUMA support (Beth Kan) </li>
+ <li>Documentation: cleanups (Toth Istvan), typos (Eduardo Pereira), </li>
+ <li>Bug fixes: memory corruption on large dumps (Masayuki Sunou), fix
+ virsh vncdisplay command exit (Masayuki Sunou), Fix network stats
+ TX/RX result (Richard Jones), warning on Xen 3.0.3 (Richard Jones),
+ missing buffer check in virDomainXMLDevID (Hugh Brock), avoid zombies
+ when using remote (Daniel Berrange), xend connection error message
+ (Richard Jones), avoid ssh tty prompt (Daniel Berrange), username
+ handling for remote URIs (Fabian Deutsch), fix potential crash
+ on multiple input XML tags (Daniel Berrange), Solaris Xen hypercalls
+ fixup (Mark Johnson)</li>
+ <li>Improvements: OpenVZ support (Shuveb Hussain and Anoop Cyriac),
+ CD-Rom reload on XEn (Hugh Brock), PXE boot got QEmu/KVM (Daniel
+ Berrange), QEmu socket permissions customization (Daniel Berrange),
+ more QEmu support (Richard Jones), better path detection for qemu and
+ dnsmasq (Richard Jones), QEmu flags are per-Domain (Daniel Berrange),
+ virsh freecell command, Solaris portability fixes (Mark Johnson),
+ default bootloader support (Daniel Berrange), new virNodeGetFreeMemory
+ API, vncpasswd extraction in configuration files if secure (Mark
+ Johnson and Daniel Berrange), Python bindings for block and interface
+ statistics</li>
+ <li>Code cleanups: virDrvOpenRemoteFlags definition (Richard Jones),
+ configure tests and output (Daniel Berrange)</li>
+ </ul>
+ <h3>0.3.2: Aug 21 2007</h3>
+ <ul>
+ <li>New features: KVM migration and save/restore (Jim Paris),
+ added API for migration (Richard Jones), added APIs for block device and
+ interface statistic (Richard Jones).</li>
+ <li>Documentation: examples for XML network APIs,
+ fix typo and schedinfo synopsis in man page (Atsushi SAKAI),
+ hypervisor support page update (Richard Jones).</li>
+ <li>Bug fixes: remove a couple of leaks in QEmu/KVM backend(Daniel berrange),
+ fix GnuTLS 1.0 compatibility (Richard Jones), --config/-f option
+ mistake for libvirtd (Richard Jones), remove leak in QEmu backend
+ (Jim Paris), fix some QEmu communication bugs (Jim Paris), UUID
+ lookup though proxy fix, setvcpus checking bugs (with Atsushi SAKAI),
+ int checking in virsh parameters (with Masayuki Sunou), deny devices
+ attach/detach for < Xen 3.0.4 (Masayuki Sunou), XenStore query
+ memory leak (Masayuki Sunou), virsh schedinfo cleanup (Saori Fukuta).</li>
+ <li>Improvement: virsh new ttyconsole command, networking API implementation
+ for test driver (Daniel berrange), qemu/kvm feature reporting of
+ ACPI/APIC (David Lutterkort), checking of QEmu architectures (Daniel
+ berrange), improve devices XML errors reporting (Masayuki Sunou),
+ speedup of domain queries on Xen (Daniel berrange), augment XML dumps
+ with interface devices names (Richard Jones), internal API to query
+ drivers for features (Richard Jones).
+ </li>
+ <li>Cleanups: Improve virNodeGetInfo implentation (Daniel berrange),
+ general UUID code cleanup (Daniel berrange), fix API generator
+ file selection. </li>
+ </ul>
+ <h3>0.3.1: Jul 24 2007</h3>
+ <ul>
+ <li>Documentation: index to remote page, script to test certificates,
+ IPv6 remote support docs (Daniel Berrange), document
+ VIRSH_DEFAULT_CONNECT_URI in virsh man page (David Lutterkort),
+ Relax-NG early grammar for the network XML (David Lutterkort)</li>
+ <li>Bug fixes: leaks in disk XML parsing (Masayuki Sunou), hypervisor
+ alignment call problems on PPC64 (Christian Ehrhardt), dead client
+ registration in daemon event loop (Daniel Berrange), double free
+ in error handling (Daniel Berrange), close on exec for log file
+ descriptors in the daemon (Daniel Berrange), avoid caching problem
+ in remote daemon (Daniel Berrange), avoid crash after QEmu domain
+ failure (Daniel Berrange)</li>
+ <li>Improvements: checks of x509 certificates and keys (Daniel Berrange),
+ error reports in the daemon (Daniel Berrange), checking of Ethernet MAC
+ addresses in XML configs (Masayuki Sunou), support for a new
+ clock switch between UTC and localtime (Daniel Berrange), early
+ version of OpenVZ support (Shuveb Hussain), support for input devices
+ on PS/2 and USB buses (Daniel Berrange), more tests especially
+ the QEmu support (Daniel Berrange), range check in credit scheduler
+ (with Saori Fukuta and Atsushi Sakai), add support for listen VNC
+ parameter un QEmu and fix command line arg (Daniel Berrange)</li>
+ <li>Cleanups: debug tracing (Richard Jones), removal of --with-qemud-pid-file
+ (Richard Jones), remove unused virDeviceMode, new util module for
+ code shared between drivers (Shuveb Hussain), xen header location
+ detection (Richard Jones)</li>
+ </ul>
+ <h3>0.3.0: Jul 9 2007</h3>
+ <ul>
+ <li>Secure Remote support (Richard Jones).
+ See <a href="http://libvirt.org/remote.html">the remote page</a>
+ of the documentation
+ </li>
+ <li>Documentation: remote support (Richard Jones), description of
+ the URI connection strings (Richard Jones), update of virsh man
+ page, matrix of libvirt API/hypervisor support with version
+ information (Richard Jones)</li>
+ <li>Bug fixes: examples Makefile.am generation (Richard Jones),
+ SetMem fix (Mark Johnson), URI handling and ordering of
+ drivers (Daniel Berrange), fix virsh help without hypervisor (Richard
+ Jones), id marshalling fix (Daniel Berrange), fix virConnectGetMaxVcpus
+ on remote (Richard Jones), avoid a realloc leak (Jim Meyering), scheduler
+ parameters handling for Xen (Richard Jones), various early remote
+ bug fixes (Richard Jones), remove virsh leaks of domains references
+ (Masayuki Sunou), configCache refill bug (Richard Jones), fix
+ XML serialization bugs</li>
+ <li>Improvements: QEmu switch to XDR-based protocol (Dan Berrange),
+ device attach/detach commands (Masayuki Sunou), OCaml bindings
+ (Richard Jones), new entry points virDomainGetConnect and
+ virNetworkGetConnect useful for bindings (Richard Jones),
+ reunitifaction of remote and qemu daemon under a single libvirtd
+ with a config file (Daniel Berrange)</li>
+ <li>Cleanups: parsing of connection URIs (Richard Jones), messages
+ from virsh (Saori Fukuta), Coverage files (Daniel Berrange),
+ Solaris fixes (Mark Johnson), avoid [r]index calls (Richard Jones),
+ release information in Xen backend, virsh cpupin command cleanups
+ (Masayuki Sunou), xen:/// suppport as standard Xen URI (Richard Jones and
+ Daniel Berrange), improve driver selection/decline mechanism (Richard
+ Jones), error reporting on XML dump (Richard Jones), Remove unused
+ virDomainKernel structure (Richard Jones), daemon event loop event
+ handling (Daniel Berrange), various unifications cleanup in the daemon
+ merging (Daniel Berrange), internal file and timer monitoring API
+ (Daniel Berrange), remove libsysfs dependancy, call brctl program
+ directly (Daniel Berrange), virBuffer functions cleanups (Richard Jones),
+ make init script LSB compliant, error handling on lookup functions
+ (Richard Jones), remove internal virGetDomainByID (Richard Jones),
+ revamp of xen subdrivers interfaces (Richard Jones)</li>
+ <li>Localization updates</li>
+ </ul>
+ <h3>0.2.3: Jun 8 2007</h3>
+ <ul>
+ <li>Documentation: documentation for upcoming remote access (Richard Jones),
+ virConnectNumOfDefinedDomains doc (Jan Michael), virsh help messages
+ for dumpxml and net-dumpxml (Chris Wright), </li>
+ <li>Bug fixes: RelaxNG schemas regexp fix (Robin Green), RelaxNG arch bug
+ (Mark McLoughlin), large buffers bug fixes (Shigeki Sakamoto), error
+ on out of memory condition (Shigeki Sakamoto), virshStrdup fix, non-root
+ driver when using Xen bug (Richard Jones), use --strict-order when
+ running dnsmasq (Daniel Berrange), virbr0 weirdness on restart (Mark
+ McLoughlin), keep connection error messages (Richard Jones), increase
+ QEmu read buffer on help (Daniel Berrange), rpm dependance on
+ dnsmasq (Daniel Berrange), fix XML boot device syntax (Daniel Berrange),
+ QEmu memory bug (Daniel Berrange), memory leak fix (Masayuki Sunou),
+ fix compiler flags (Richard Jones), remove type ioemu on recent Xen
+ HVM for paravirt drivers (Saori Fukuta), uninitialized string bug
+ (Masayuki Sunou), allow init even if the daemon is not running,
+ XML to config fix (Daniel Berrange)</li>
+ <li>Improvements: add a special error class for the test module (Richard
+ Jones), virConnectGetCapabilities on proxy (Richard Jones), allow
+ network driver to decline usage (Richard Jones), extend error messages
+ for upcoming remote access (Richard Jones), on_reboot support for QEmu
+ (Daniel Berrange), save daemon output in a log file (Daniel Berrange),
+ xenXMDomainDefineXML can override guest config (Hugh Brock),
+ add attach-device and detach-device commands to virsh (Masayuki Sunou
+ and Mark McLoughlin and Richard Jones), make virGetVersion case
+ insensitive and Python bindings (Richard Jones), new scheduler API
+ (Atsushi SAKAI), localizations updates, add logging option for virsh
+ (Nobuhiro Itou), allow arguments to be passed to bootloader (Hugh Brock),
+ increase the test suite (Daniel Berrange and Hugh Brock)</li>
+ <li>Cleanups: Remove VIR_DRV_OPEN_QUIET (Richard Jones), disable xm_internal.c
+ for Xen > 3.0.3 (Daniel Berrange), unused fields in _virDomain (Richard
+ Jones), export __virGetDomain and __virGetNetwork for libvirtd only
+ (Richard Jones), ignore old VNC config for HVM on recent Xen (Daniel
+ Berrange), various code cleanups, -Werror cleanup (Hugh Brock)</li>
+ </ul>
+ <h3>0.2.2: Apr 17 2007</h3>
+ <ul>
+ <li>Documentation: fix errors due to Amaya (with Simon Hernandez),
+ virsh uses kB not bytes (Atsushi SAKAI), add command line help to
+ qemud (Richard Jones), xenUnifiedRegister docs (Atsushi SAKAI),
+ strings typos (Nikolay Sivov), ilocalization probalem raised by
+ Thomas Canniot</li>
+ <li>Bug fixes: virsh memory values test (Masayuki Sunou), operations without
+ libvirt_qemud (Atsushi SAKAI), fix spec file (Florian La Roche, Jeremy
+ Katz, Michael Schwendt),
+ direct hypervisor call (Atsushi SAKAI), buffer overflow on qemu
+ networking command (Daniel Berrange), buffer overflow in quemud (Daniel
+ Berrange), virsh vcpupin bug (Masayuki Sunou), host PAE detections
+ and strcuctures size (Richard Jones), Xen PAE flag handling (Daniel
+ Berrange), bridged config configuration (Daniel Berrange), erroneous
+ XEN_V2_OP_SETMAXMEM value (Masayuki Sunou), memory free error (Mark
+ McLoughlin), set VIR_CONNECT_RO on read-only connections (S.Sakamoto),
+ avoid memory explosion bug (Daniel Berrange), integer overflow
+ for qemu CPU time (Daniel Berrange), QEMU binary path check (Daniel
+ Berrange)</li>
+ <li>Cleanups: remove some global variables (Jim Meyering), printf-style
+ functions checks (Jim Meyering), better virsh error messages, increase
+ compiler checkings and security (Daniel Berrange), virBufferGrow usage
+ and docs, use calloc instead of malloc/memset, replace all sprintf by
+ snprintf, avoid configure clobbering user's CTAGS (Jim Meyering),
+ signal handler error cleanup (Richard Jones), iptables internal code
+ claenup (Mark McLoughlin), unified Xen driver (Richard Jones),
+ cleanup XPath libxml2 calls, IPTables rules tightening (Daniel
+ Berrange), </li>
+ <li>Improvements: more regression tests on XML (Daniel Berrange), Python
+ bindings now generate exception in error cases (Richard Jones),
+ Python bindings for vir*GetAutoStart (Daniel Berrange),
+ handling of CD-Rom device without device name (Nobuhiro Itou),
+ fix hypervisor call to work with Xen 3.0.5 (Daniel Berrange),
+ DomainGetOSType for inactive domains (Daniel Berrange), multiple boot
+ devices for HVM (Daniel Berrange),
+ </li>
+ </ul>
+ <h3>0.2.1: Mar 16 2007</h3>
+ <ul>
+ <li>Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin)</li>
+ <li>Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt
+ config directory (Daniel Berrange and Mark McLoughlin), memory leak
+ in qemud (Mark), various fixes on network support (Mark), avoid Xen
+ domain zombies on device hotplug errors (Daniel Berrange), various
+ fixes on qemud (Mark), args parsing (Richard Jones), virsh -t argument
+ (Saori Fukuta), avoid virsh crash on TAB key (Daniel Berrange), detect
+ xend operation failures (Kazuki Mizushima), don't listen on null socket
+ (Rich Jones), read-only socket cleanup (Rich Jones), use of vnc port 5900
+ (Nobuhiro Itou), assorted networking fixes (Daniel Berrange), shutoff and
+ shutdown mismatches (Kazuki Mizushima), unlimited memory handling
+ (Atsushi SAKAI), python binding fixes (Tatsuro Enokura)</li>
+ <li>Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies
+ and build (Daniel Berrange), fix xend port detection (Daniel
+ Berrange), icompile time warnings (Mark), avoid const related
+ compiler warnings (Daniel Berrange), automated builds (Daniel
+ Berrange), pointer/int mismatch (Richard Jones), configure time
+ selection of drivers, libvirt spec hacking (Daniel Berrange)</li>
+ <li>Add support for network autostart and init scripts (Mark McLoughlin)</li>
+ <li>New API virConnectGetCapabilities() to detect the virtualization
+ capabilities of a host (Richard Jones)</li>
+ <li>Minor improvements: qemud signal handling (Mark), don't shutdown or reboot
+ domain0 (Kazuki Mizushima), QEmu version autodetection (Daniel Berrange),
+ network UUIDs (Mark), speed up UUID domain lookups (Tatsuro Enokura and
+ Daniel Berrange), support for paused QEmu CPU (Daniel Berrange), keymap
+ VNC attribute support (Takahashi Tomohiro and Daniel Berrange), maximum
+ number of virtual CPU (Masayuki Sunou), virtsh --readonly option (Rich
+ Jones), python bindings for new functions (Daniel Berrange)</li>
+ <li>Documentation updates especially on the XML formats</li>
+ </ul>
+ <h3>0.2.0: Feb 14 2007</h3>
+ <ul>
+ <li>Various internal cleanups (Mark McLoughlin, Richard Jones,
+ Daniel Berrange, Karel Zak)</li>
+ <li>Bug fixes: avoid a crash in connect (Daniel Berrange), virsh args
+ parsing (Richard Jones)</li>
+ <li>Add support for QEmu and KVM virtualization (Daniel Berrange)</li>
+ <li>Add support for network configuration (Mark McLoughlin)</li>
+ <li>Minor improvements: regression testing (Daniel Berrange),
+ localization string updates</li>
+ </ul>
+ <h3>0.1.11: Jan 22 2007</h3>
+ <ul>
+ <li>Finish XML <-> XM config files support</li>
+ <li>Remove memory leak when freeing virConf objects</li>
+ <li>Finishing inactive domain support (Daniel Berrange)</li>
+ <li>Added a Relax-NG schemas to check XML instances</li>
+ </ul>
+ <h3>0.1.10: Dec 20 2006</h3>
+ <ul>
+ <li>more localizations</li>
+ <li>bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains buffer overflow (Daniel Berrange), reference count bug when creating Xen domains (Daniel Berrange).</li>
+ <li>improvements: support graphic framebuffer for Xen paravirt (Daniel Berrange), VNC listen IP range support (Daniel Berrange), support for default Xen config files and inactive domains of 3.0.4 (Daniel Berrange).</li>
+ </ul>
+ <h3>0.1.9: Nov 29 2006</h3>
+ <ul>
+ <li>python bindings: release interpeter lock when calling C (Daniel Berrange)</li>
+ <li>don't raise HTTP error when looking information for a domain</li>
+ <li>some refactoring to use the driver for all entry points</li>
+ <li>better error reporting (Daniel Berrange)</li>
+ <li>fix OS reporting when running as non-root</li>
+ <li>provide XML parsing errors</li>
+ <li>extension of the test framework (Daniel Berrange)</li>
+ <li>fix the reconnect regression test</li>
+ <li>python bindings: Domain instances now link to the Connect to avoid garbage collection and disconnect</li>
+ <li>separate the notion of maximum memory and current use at the XML level</li>
+ <li>Fix a memory leak (Daniel Berrange)</li>
+ <li>add support for shareable drives</li>
+ <li>add support for non-bridge style networking configs for guests(Daniel Berrange)</li>
+ <li>python bindings: fix unsigned long marshalling (Daniel Berrange)</li>
+ <li>new config APIs virConfNew() and virConfSetValue() to build configs from scratch</li>
+ <li>hot plug device support based on Michel Ponceau patch</li>
+ <li>added support for inactive domains, new APIs, various associated cleanup (Daniel Berrange)</li>
+ <li>special device model for HVM guests (Daniel Berrange)</li>
+ <li>add API to dump core of domains (but requires a patched xend)</li>
+ <li>pygrub bootloader information take over <os> information</li>
+ <li>updated the localization strings</li>
+ </ul>
+ <h3>0.1.8: Oct 16 2006</h3>
+ <ul>
+ <li> Bug for system with page size != 4k</li>
+ <li> vcpu number initialization (Philippe Berthault)</li>
+ <li> don't label crashed domains as shut off (Peter Vetere)</li>
+ <li> fix virsh man page (Noriko Mizumoto)</li>
+ <li> blktapdd support for alternate drivers like blktap (Daniel Berrange)</li>
+ <li> memory leak fixes (xend interface and XML parsing) (Daniel Berrange)</li>
+ <li> compile fix</li>
+ <li> mlock/munlock size fixes (Daniel Berrange)</li>
+ <li> improve error reporting</li>
+ </ul>
+ <h3>0.1.7: Sep 29 2006</h3>
+ <ul>
+ <li> fix a memory bug on getting vcpu information from xend (Daniel Berrange)</li>
+ <li> fix another problem in the hypercalls change in Xen changeset
+ 86d26e6ec89b when getting domain information (Daniel Berrange)</li>
+ </ul>
+ <h3>0.1.6: Sep 22 2006</h3>
+ <ul>
+ <li>Support for localization of strings using gettext (Daniel Berrange)</li>
+ <li>Support for new Xen-3.0.3 cdrom and disk configuration (Daniel Berrange)</li>
+ <li>Support for setting VNC port when creating domains with new
+ xend config files (Daniel Berrange) </li>
+ <li>Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig)</li>
+ <li>Fix reconnection problem when talking directly to http xend</li>
+ </ul>
+ <h3>0.1.5: Sep 5 2006</h3>
+ <ul>
+ <li>Support for new hypercalls change in Xen changeset 86d26e6ec89b</li>
+ <li>bug fixes: virParseUUID() was wrong, netwoking for paravirt guestsi
+ (Daniel Berrange), virsh on non-existent domains (Daniel Berrange),
+ string cast bug when handling error in python (Pete Vetere), HTTP
+ 500 xend error code handling (Pete Vetere and Daniel Berrange)</li>
+ <li>improvements: test suite for SEXPR <-> XML format conversions (Daniel
+ Berrange), virsh output regression suite (Daniel Berrange), new environ
+ variable VIRSH_DEFAULT_CONNECT_URI for the default URI when connecting
+ (Daniel Berrange), graphical console support for paravirt guests
+ (Jeremy Katz), parsing of simple Xen config files (with Daniel Berrange),
+ early work on defined (not running) domains (Daniel Berrange),
+ virsh output improvement (Daniel Berrange</li>
+ </ul>
+ <h3>0.1.4: Aug 16 2006</h3>
+ <ul>
+ <li>bug fixes: spec file fix (Mark McLoughlin), error report problem (with
+ Hugh Brock), long integer in Python bindings (with Daniel Berrange), XML
+ generation bug for CDRom (Daniel Berrange), bug whem using number() XPath
+ function (Mark McLoughlin), fix python detection code, remove duplicate
+ initialization errors (Daniel Berrange)</li>
+ <li>improvements: UUID in XML description (Peter Vetere), proxy code
+ cleanup, virtual CPU and affinity support + virsh support (Michel
+ Ponceau, Philippe Berthault, Daniel Berrange), port and tty information
+ for console in XML (Daniel Berrange), added XML dump to driver and proxy
+ support (Daniel Berrange), extention of boot options with support for
+ floppy and cdrom (Daniel Berrange), features block in XML to report/ask
+ PAE, ACPI, APIC for HVM domains (Daniel Berrange), fail saide-effect
+ operations when using read-only connection, large improvements to test
+ driver (Daniel Berrange) </li>
+ <li>documentation: spelling (Daniel Berrange), test driver examples.</li>
+ </ul>
+ <h3>0.1.3: Jul 11 2006</h3>
+ <ul>
+ <li>bugfixes: build as non-root, fix xend access when root, handling of
+ empty XML elements (Mark McLoughlin), XML serialization and parsing fixes
+ (Mark McLoughlin), allow to create domains without disk (Mark
+ McLoughlin),</li>
+ <li>improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel Berrange),
+ support for fully virtualized guest (Jim Fehlig, DV, Mark McLoughlin)</li>
+ <li>documentation: augmented to cover hvm domains</li>
+ </ul>
+ <h3>0.1.2: Jul 3 2006</h3>
+ <ul>
+ <li>headers include paths fixup</li>
+ <li>proxy mechanism for unprivileged read-only access by httpu</li>
+ </ul>
+ <h3>0.1.1: Jun 21 2006</h3>
+ <ul>
+ <li>building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
+ Berrange)</li>
+ <li>driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
+ Berrange)</li>
+ <li>Cope with API change introduced in Xen changeset 10277</li>
+ <li>new test driver for regression checks (Daniel P. Berrange)</li>
+ <li>improvements: added UUID to XML serialization, buffer usage (Karel
+ Zak), --connect argument to virsh (Daniel P. Berrange),</li>
+ <li>bug fixes: uninitialized memory access in error reporting, S-Expr
+ parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO in
+ xs_internal.c</li>
+ <li>documentation: Python examples (David Lutterkort), new Perl binding
+ URL, man page update (Karel Zak)</li>
+ </ul>
+ <h3>0.1.0: Apr 10 2006</h3>
+ <ul>
+ <li>building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
+ build and pkginfo cflag fix (Daniel Berrange)</li>
+ <li>enhancement and fixes of the XML description format (David Lutterkort
+ and Jim Fehlig)</li>
+ <li>new APIs: for Node information and Reboot</li>
+ <li>internal code cleanup: refactoring internals into a driver model, more
+ error handling, structure sharing, thread safety and ref counting</li>
+ <li>bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
+ Meyering), virDomainLookupByID (Jim Fehlig),</li>
+ <li>documentation: updates on architecture, and format, typo fix (Jim
+ Meyering)</li>
+ <li>bindings: exception handling in examples (Jim Meyering), perl ones out
+ of tree (Daniel Berrange)</li>
+ <li>virsh: more options, create, nodeinfo (Karel Zak), renaming of some
+ options (Karel Zak), use stderr only for errors (Karel Zak), man page
+ (Andrew Puch)</li>
+ </ul>
+ <h3>0.0.6: Feb 28 2006</h3>
+ <ul>
+ <li>add UUID lookup and extract API</li>
+ <li>add error handling APIs both synchronous and asynchronous</li>
+ <li>added minimal hook for error handling at the python level, improved the
+ python bindings</li>
+ <li>augment the documentation and tests to cover error handling</li>
+ </ul>
+ <h3>0.0.5: Feb 23 2006</h3>
+ <ul>
+ <li>Added XML description parsing, dependance to libxml2, implemented the
+ creation API virDomainCreateLinux()</li>
+ <li>new APIs to lookup and name domain by UUID</li>
+ <li>fixed the XML dump when using the Xend access</li>
+ <li>Fixed a few more problem related to the name change</li>
+ <li>Adding regression tests in python and examples in C</li>
+ <li>web site improvement, extended the documentation to cover the XML
+ format and Python API</li>
+ <li>Added devhelp help for Gnome/Gtk programmers</li>
+ </ul>
+ <h3>0.0.4: Feb 10 2006</h3>
+ <ul>
+ <li>Fix various bugs introduced in the name change</li>
+ </ul>
+ <h3>0.0.3: Feb 9 2006</h3>
+ <ul>
+ <li>Switch name from from 'libvir' to libvirt</li>
+ <li>Starting infrastructure to add code examples</li>
+ <li>Update of python bindings for completeness</li>
+ </ul>
+ <h3>0.0.2: Jan 29 2006</h3>
+ <ul>
+ <li>Update of the documentation, web site redesign (Diana Fong)</li>
+ <li>integration of HTTP xend RPC based on libxend by Anthony Liquori for
+ most operations</li>
+ <li>Adding Save and Restore APIs</li>
+ <li>extended the virsh command line tool (Karel Zak)</li>
+ <li>remove xenstore transactions (Anthony Liguori)</li>
+ <li>fix the Python bindings bug when domain and connections where freed</li>
+ </ul>
+ <h3>0.0.1: Dec 19 2005</h3>
+ <ul>
+ <li>First release</li>
+ <li>Basic management of existing Xen domains</li>
+ <li>Minimal autogenerated Python bindings</li>
+ </ul>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>\r
+<xsl:stylesheet\r
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
+ xmlns:exsl="http://exslt.org/common"\r
+ exclude-result-prefixes="xsl exsl"\r
+ version="1.0">\r
+\r
+ <!-- The sitemap.html.in page contains the master navigation structure -->\r
+ <xsl:variable name="sitemap" select="document('sitemap.html.in')/html/body/div[@id='sitemap']"/>\r
+\r
+ <!-- This processes the sitemap to form a context sensitive\r
+ navigation menu for the current page -->\r
+ <xsl:template match="ul" mode="menu">\r
+ <xsl:param name="pagename"/>\r
+ <xsl:param name="level"/>\r
+ <ul class="{concat('l', $level)}">\r
+ <xsl:for-each select="li">\r
+ <li>\r
+ <!-- A menu is active if there is an 'a' tag with\r
+ a href matching this pagename at this level\r
+ or a child menu -->\r
+ <xsl:variable name="class">\r
+ <xsl:choose>\r
+ <xsl:when test="count(.//a[@href = $pagename]) > 0">\r
+ <xsl:text>active</xsl:text>\r
+ </xsl:when>\r
+ <xsl:otherwise>\r
+ <xsl:text>inactive</xsl:text>\r
+ </xsl:otherwise>\r
+ </xsl:choose>\r
+ </xsl:variable>\r
+\r
+ <!-- A menu should use a 'span' instead of 'a' if\r
+ the immediate 'a' tag has href matching the\r
+ current pagename -->\r
+ <xsl:choose>\r
+ <xsl:when test="$pagename = a/@href">\r
+ <span class="{$class}"><xsl:value-of select="a"/></span>\r
+ </xsl:when>\r
+ <xsl:otherwise>\r
+ <a title="{./span}" class="{$class}" href="{concat($href_base, a/@href)}"><xsl:value-of select="a"/></a>\r
+ </xsl:otherwise>\r
+ </xsl:choose>\r
+\r
+ <!-- A sub-menu should only be expanded it contains\r
+ an 'a' tag with href matching this pagename -->\r
+ <xsl:if test="count(.//a[@href = $pagename]) > 0">\r
+ <xsl:apply-templates select="ul" mode="menu">\r
+ <xsl:with-param name="pagename" select="$pagename"/>\r
+ <xsl:with-param name="level" select="$level + 1"/>\r
+ </xsl:apply-templates>\r
+ </xsl:if>\r
+ </li>\r
+ </xsl:for-each>\r
+ </ul>\r
+ </xsl:template>\r
+\r
+ <!-- This is the master page structure -->\r
+ <xsl:template match="/" mode="page">\r
+ <xsl:param name="pagename"/>\r
+ <html>\r
+ <xsl:comment>\r
+ This file is autogenerated from <xsl:value-of select="$pagename"/>.in\r
+ Do not edit this file. Changes will be lost.\r
+ </xsl:comment>\r
+ <head>\r
+ <link rel="stylesheet" type="text/css" href="{$href_base}main.css"/>\r
+ <link rel="SHORTCUT ICON" href="{$href_base}32favicon.png"/>\r
+ <title>libvirt: <xsl:value-of select="html/body/h1"/></title>\r
+ <meta name="description" content="libvirt, virtualization, virtualization API"/>\r
+ </head>\r
+ <body>\r
+ <div id="header">\r
+ <div id="headerLogo"/>\r
+ <div id="headerSearch">\r
+ <form action="{$href_base}search.php" enctype="application/x-www-form-urlencoded" method="get">\r
+ <input id="query" name="query" type="text" size="12" value=""/>\r
+ <input id="submit" name="submit" type="submit" value="Search"/>\r
+ </form>\r
+ </div>\r
+ </div>\r
+ <div id="body">\r
+ <div id="content">\r
+ <xsl:copy-of select="html/body/*"/>\r
+ </div>\r
+ <div id="menu">\r
+ <xsl:apply-templates select="exsl:node-set($sitemap)/ul" mode="menu">\r
+ <xsl:with-param name="pagename" select="$pagename"/>\r
+ <xsl:with-param name="level" select="0"/>\r
+ </xsl:apply-templates>\r
+ </div>\r
+ </div>\r
+ <div id="footer">\r
+ <div id="projects">\r
+ <dl id="p1">\r
+ <dt><a href="http://augeas.net/">Augeas</a></dt>\r
+ <dd><span>A configuration editing tool and API</span></dd>\r
+ <dt><a href="http://libvirt.org/">libvirt</a></dt>\r
+ <dd><span>The open source virtualization API</span></dd>\r
+ </dl>\r
+ <dl id="p2">\r
+ <dt><a href="http://cobbler.et.redhat.com/">Cobbler</a></dt>\r
+ <dd><span>OS provisioning and profile management</span></dd>\r
+ <dt><a href="http://ovirt.org/">oVirt</a></dt>\r
+ <dd><span>Virtualization management across the data center</span></dd>\r
+ </dl>\r
+ <dl id="p3">\r
+ <dt><a href="http://freeipa.org/">FreeIPA</a></dt>\r
+ <dd><span>Identity, policy and audit management</span></dd>\r
+ <dt><a href="http://virt-manager.org/">Virtual Machine Manager</a></dt>\r
+ <dd><span>Virtualization management from the desktop</span></dd>\r
+ </dl>\r
+ </div>\r
+ <!--\r
+ <p id="et">\r
+ <a href="http://et.redhat.com/"><img src="{$href_base}et_logo.png" alt="A Red Hat Emerging Technology Project"/></a>\r
+ </p>\r
+ -->\r
+ </div>\r
+ </body>\r
+ </html>\r
+ </xsl:template>\r
+\r
+</xsl:stylesheet>\r
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Bindings for other languages</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Bindings for other languages</h1><p>Libvirt comes with bindings to support other languages than
-pure C. First the headers embeds the necessary declarations to
-allow direct acces from C++ code, but also we have bindings for
-higher level kind of languages:</p><ul><li>Python: Libvirt comes with direct support for the Python language
- (just make sure you installed the libvirt-python package if not
- compiling from sources). See below for more information about
- using libvirt with python</li>
- <li>Perl: Daniel Berrange provides <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">bindings for
- Perl</a>.</li>
- <li>OCaml: Richard Jones supplies <a href="http://libvirt.org/ocaml/">bindings for OCaml</a>.</li>
- <li>Ruby: David Lutterkork provides <a href="http://libvirt.org/ruby/">bindings for Ruby</a>.</li>
-</ul><p>Support, requests or help for libvirt bindings are welcome on
-the <a href="https://www.redhat.com/mailman/listinfo/libvir-list/">mailing
-list</a>, as usual try to provide enough background information
-and make sure you use recent version, see the <a href="bugs.html">help
-page</a>.</p><p>The remaining of this page focuses on the Python bindings.</p><p>The Python binding should be complete and are mostly automatically
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from python.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Python API bindings</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Python API bindings</h1>
+ <p>The Python binding should be complete and are mostly automatically
generated from the formal description of the API in xml. The bindings are
articulated around 2 classes <code>virConnect</code> and virDomain mapping to
the C types. Functions in the C API taking either type as argument then
becomes methods for the classes, their name is just stripped from the
virConnect or virDomain(Get) prefix and the first letter gets converted to
-lower case, for example the C functions:</p><p><code>int <a href="html/libvirt-libvirt.html#virConnectNumOfDomains">virConnectNumOfDomains</a>
-(virConnectPtr conn);</code></p><p><code>int <a href="html/libvirt-libvirt.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a>
-(virDomainPtr domain, unsigned long memory);</code></p><p>become</p><p><code>virConn::numOfDomains(self)</code></p><p><code>virDomain::setMaxMemory(self, memory)</code></p><p>This process is fully automated, you can get a summary of the conversion
+lower case, for example the C functions:</p>
+ <p>
+ <code>int <a href="html/libvirt-libvirt.html#virConnectNumOfDomains">virConnectNumOfDomains</a>
+(virConnectPtr conn);</code>
+ </p>
+ <p>
+ <code>int <a href="html/libvirt-libvirt.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a>
+(virDomainPtr domain, unsigned long memory);</code>
+ </p>
+ <p>become</p>
+ <p>
+ <code>virConn::numOfDomains(self)</code>
+ </p>
+ <p>
+ <code>virDomain::setMaxMemory(self, memory)</code>
+ </p>
+ <p>This process is fully automated, you can get a summary of the conversion
in the file libvirtclass.txt present in the python dir or in the docs.There
is a couple of function who don't map directly to their C counterparts due to
-specificities in their argument conversions:</p><ul><li><code><a href="html/libvirt-libvirt.html#virConnectListDomains">virConnectListDomains</a></code>
+specificities in their argument conversions:</p>
+ <ul><li><code><a href="html/libvirt-libvirt.html#virConnectListDomains">virConnectListDomains</a></code>
is replaced by <code>virDomain::listDomainsID(self)</code> which returns
- a list of the integer ID for the currently running domains</li>
- <li><code><a href="html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a></code>
+ a list of the integer ID for the currently running domains</li><li><code><a href="html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a></code>
is replaced by <code>virDomain::info()</code> which returns a list of
- <ol><li>state: one of the state values (virDomainState)</li>
- <li>maxMemory: the maximum memory used by the domain</li>
- <li>memory: the current amount of memory used by the domain</li>
- <li>nbVirtCPU: the number of virtual CPU</li>
- <li>cpuTime: the time used by the domain in nanoseconds</li>
- </ol></li>
-</ul><p>So let's look at a simple example inspired from the <code>basic.py</code>
-test found in <code>python/tests/</code> in the source tree:</p><pre>import <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>
+ <ol><li>state: one of the state values (virDomainState)</li><li>maxMemory: the maximum memory used by the domain</li><li>memory: the current amount of memory used by the domain</li><li>nbVirtCPU: the number of virtual CPU</li><li>cpuTime: the time used by the domain in nanoseconds</li></ol></li></ul>
+ <p>So let's look at a simple example inspired from the <code>basic.py</code>
+test found in <code>python/tests/</code> in the source tree:</p>
+ <pre>import <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>
import sys
conn = <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>.openReadOnly(None)
sys.exit(1)
print "Domain 0: id %d running %s" % (dom0.<span style="color: #FF0080; background-color: #FFFFFF">ID</span>(), dom0.<span style="color: #FF0080; background-color: #FFFFFF">OSType</span>())
-print dom0.<span style="color: #FF0080; background-color: #FFFFFF">info</span>()</pre><p>There is not much to comment about it, it really is a straight mapping
-from the C API, the only points to notice are:</p><ul><li>the import of the module called <code><span style="color: #0071FF; background-color: #FFFFFF">libvirt</span></code></li>
- <li>getting a connection to the hypervisor, in that case using the
- openReadOnly function allows the code to execute as a normal user.</li>
- <li>getting an object representing the Domain 0 using <span style="color: #007F00; background-color: #FFFFFF">lookupByName</span></li>
- <li>if the domain is not found a libvirtError exception will be raised</li>
- <li>extracting and printing some information about the domain using
+print dom0.<span style="color: #FF0080; background-color: #FFFFFF">info</span>()</pre>
+ <p>There is not much to comment about it, it really is a straight mapping
+from the C API, the only points to notice are:</p>
+ <ul><li>the import of the module called <code><span style="color: #0071FF; background-color: #FFFFFF">libvirt</span></code></li><li>getting a connection to the hypervisor, in that case using the
+ openReadOnly function allows the code to execute as a normal user.</li><li>getting an object representing the Domain 0 using <span style="color: #007F00; background-color: #FFFFFF">lookupByName</span></li><li>if the domain is not found a libvirtError exception will be raised</li><li>extracting and printing some information about the domain using
various <span style="color: #E50073; background-color: #FFFFFF">methods</span>
- associated to the virDomain class.</li>
-</ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+ associated to the virDomain class.</li></ul>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="active" href="bindings.html">Language bindings</a>
+ <ul class="l2"><li>
+ <span class="active">Python</span>
+ </li></ul>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1>Python API bindings</h1>
+
+ <p>The Python binding should be complete and are mostly automatically
+generated from the formal description of the API in xml. The bindings are
+articulated around 2 classes <code>virConnect</code> and virDomain mapping to
+the C types. Functions in the C API taking either type as argument then
+becomes methods for the classes, their name is just stripped from the
+virConnect or virDomain(Get) prefix and the first letter gets converted to
+lower case, for example the C functions:</p>
+ <p>
+ <code>int <a href="html/libvirt-libvirt.html#virConnectNumOfDomains">virConnectNumOfDomains</a>
+(virConnectPtr conn);</code>
+ </p>
+ <p>
+ <code>int <a href="html/libvirt-libvirt.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a>
+(virDomainPtr domain, unsigned long memory);</code>
+ </p>
+ <p>become</p>
+ <p>
+ <code>virConn::numOfDomains(self)</code>
+ </p>
+ <p>
+ <code>virDomain::setMaxMemory(self, memory)</code>
+ </p>
+ <p>This process is fully automated, you can get a summary of the conversion
+in the file libvirtclass.txt present in the python dir or in the docs.There
+is a couple of function who don't map directly to their C counterparts due to
+specificities in their argument conversions:</p>
+ <ul>
+ <li><code><a href="html/libvirt-libvirt.html#virConnectListDomains">virConnectListDomains</a></code>
+ is replaced by <code>virDomain::listDomainsID(self)</code> which returns
+ a list of the integer ID for the currently running domains</li>
+ <li><code><a href="html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a></code>
+ is replaced by <code>virDomain::info()</code> which returns a list of
+ <ol><li>state: one of the state values (virDomainState)</li><li>maxMemory: the maximum memory used by the domain</li><li>memory: the current amount of memory used by the domain</li><li>nbVirtCPU: the number of virtual CPU</li><li>cpuTime: the time used by the domain in nanoseconds</li></ol></li>
+ </ul>
+ <p>So let's look at a simple example inspired from the <code>basic.py</code>
+test found in <code>python/tests/</code> in the source tree:</p>
+ <pre>import <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>
+import sys
+
+conn = <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>.openReadOnly(None)
+if conn == None:
+ print 'Failed to open connection to the hypervisor'
+ sys.exit(1)
+
+try:
+ dom0 = conn.<span style="color: #007F00; background-color: #FFFFFF">lookupByName</span>("Domain-0")
+except:
+ print 'Failed to find the main domain'
+ sys.exit(1)
+
+print "Domain 0: id %d running %s" % (dom0.<span style="color: #FF0080; background-color: #FFFFFF">ID</span>(), dom0.<span style="color: #FF0080; background-color: #FFFFFF">OSType</span>())
+print dom0.<span style="color: #FF0080; background-color: #FFFFFF">info</span>()</pre>
+ <p>There is not much to comment about it, it really is a straight mapping
+from the C API, the only points to notice are:</p>
+ <ul>
+ <li>the import of the module called <code><span style="color: #0071FF; background-color: #FFFFFF">libvirt</span></code></li>
+ <li>getting a connection to the hypervisor, in that case using the
+ openReadOnly function allows the code to execute as a normal user.</li>
+ <li>getting an object representing the Domain 0 using <span style="color: #007F00; background-color: #FFFFFF">lookupByName</span></li>
+ <li>if the domain is not found a libvirtError exception will be raised</li>
+ <li>extracting and printing some information about the domain using
+ various <span style="color: #E50073; background-color: #FFFFFF">methods</span>
+ associated to the virDomain class.</li>
+ </ul>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from relatedlinks.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Related links</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Related links</h1>
+ <p>
+ This page contains some links of interest in the area of virtualization.
+ There are separate pages covering <a href="apps.html">applications using libvirt</a>
+ and <a href="bindings.html">language bindings for libvirt</a>.
+ </p>
+ <h2>Other library bindings</h2>
+ <ul><li><a href="/CIM/">CIM provider</a></li><li><a href="http://search.cpan.org/dist/Sys-Virt/">Perl bindings</a></li><li><a href="/ocaml/">OCaml bindings</a></li><li><a href="/ruby/">Ruby bindings</a></li></ul>
+ <h2>Hypervisors / emulators / containers</h2>
+ <ul><li>
+ The <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen</a> hypervisor
+ </li><li>
+ The <a href="http://fabrice.bellard.free.fr/qemu/">QEMU</a> emulator
+ </li><li>
+ The <a href="http://kvm.qumranet.com/kvmwiki">KVM</a> Linux hypervisor
+ </li><li>
+ The <a href="http://lxc.sourceforge.net/">LXC</a> Linux container system
+ </li><li>
+ The <a href="http://openvz.org/">OpenVZ</a> Linux container system
+ </li><li>
+ The <a href="http://virt.kernelnewbies.org/lguest">lGuest</a> paravirtualized hypervisor
+ </li><li>
+ The <a href="http://virt.kernelnewbies.org/Linux-VServer">Linux-VServer</a> container system
+ </li><li>
+ The <a href="http://virt.kernelnewbies.org/UML">User Mode Linux</a> paravirtualized hypervisor
+ </li></ul>
+ <h2>Virtualization technology</h2>
+ <ul><li>
+ <a href="http://virt.kernelnewbies.org/">Kernel Newbies Virtualization guide</a>
+ </li><li>
+ <a href="http://www-128.ibm.com/developerworks/linux/library/l-linuxvirt/?ca=dgr-lnxw01Virtual-Linux">IBM developerworks virtualization guide</a>
+ </li><li>
+ <a href="http://en.wikipedia.org/wiki/Virtualization">Wikipedia Virtualization</a>
+ </li></ul>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <span class="active">Related Links</span>
+ <ul class="l1"><li>
+ <a title="Overview of applications using the libvirt APIs" class="inactive" href="apps.html">Applications</a>
+ </li></ul>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Related links</h1>
+
+ <p>
+ This page contains some links of interest in the area of virtualization.
+ There are separate pages covering <a href="apps.html">applications using libvirt</a>
+ and <a href="bindings.html">language bindings for libvirt</a>.
+ </p>
+
+ <h2>Other library bindings</h2>
+
+ <ul>
+ <li><a href="/CIM/">CIM provider</a></li>
+ <li><a href="http://search.cpan.org/dist/Sys-Virt/">Perl bindings</a></li>
+ <li><a href="/ocaml/">OCaml bindings</a></li>
+ <li><a href="/ruby/">Ruby bindings</a></li>
+ </ul>
+
+ <h2>Hypervisors / emulators / containers</h2>
+
+ <ul>
+ <li>
+ The <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen</a> hypervisor
+ </li>
+ <li>
+ The <a href="http://fabrice.bellard.free.fr/qemu/">QEMU</a> emulator
+ </li>
+ <li>
+ The <a href="http://kvm.qumranet.com/kvmwiki">KVM</a> Linux hypervisor
+ </li>
+ <li>
+ The <a href="http://lxc.sourceforge.net/">LXC</a> Linux container system
+ </li>
+ <li>
+ The <a href="http://openvz.org/">OpenVZ</a> Linux container system
+ </li>
+ <li>
+ The <a href="http://virt.kernelnewbies.org/lguest">lGuest</a> paravirtualized hypervisor
+ </li>
+ <li>
+ The <a href="http://virt.kernelnewbies.org/Linux-VServer">Linux-VServer</a> container system
+ </li>
+ <li>
+ The <a href="http://virt.kernelnewbies.org/UML">User Mode Linux</a> paravirtualized hypervisor
+ </li>
+ </ul>
+
+ <h2>Virtualization technology</h2>
+
+ <ul>
+ <li>
+ <a href="http://virt.kernelnewbies.org/">Kernel Newbies Virtualization guide</a>
+ </li>
+ <li>
+ <a href="http://www-128.ibm.com/developerworks/linux/library/l-linuxvirt/?ca=dgr-lnxw01Virtual-Linux">IBM developerworks virtualization guide</a>
+ </li>
+ <li>
+ <a href="http://en.wikipedia.org/wiki/Virtualization">Wikipedia Virtualization</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Remote support</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Remote support</h1><p>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from remote.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Remote support</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Remote support</h1>
+ <p>
Libvirt allows you to access hypervisors running on remote
machines through authenticated and encrypted connections.
-</p><ul><li><a href="#Remote_basic_usage">Basic usage</a></li>
- <li><a href="#Remote_transports">Transports</a></li>
- <li><a href="#Remote_URI_reference">Remote URIs</a>
- <ul><li><a href="#Remote_URI_parameters">Extra parameters</a></li>
- </ul></li>
- <li><a href="#Remote_certificates">Generating TLS certificates</a>
- <ul><li><a href="#Remote_PKI">Public Key Infrastructure set up</a></li>
- <li><a href="#Remote_TLS_background">Background to TLS certificates</a></li>
- <li><a href="#Remote_TLS_CA">Setting up a Certificate Authority (CA)</a></li>
- <li><a href="#Remote_TLS_server_certificates">Issuing server certificates</a></li>
- <li><a href="#Remote_TLS_client_certificates">Issuing client certificates</a></li>
- <li><a href="#Remote_TLS_troubleshooting">Troubleshooting TLS certificate problems</a></li>
- </ul></li>
- <li><a href="#Remote_libvirtd_configuration">libvirtd configuration file</a></li>
- <li><a href="#Remote_IPv6">IPv6 support</a></li>
- <li><a href="#Remote_limitations">Limitations</a></li>
- <li><a href="#Remote_implementation_notes">Implementation notes</a></li>
-</ul><h3><a name="Remote_basic_usage" id="Remote_basic_usage">Basic usage</a></h3><p>
+</p>
+ <ul><li>
+ <a href="#Remote_basic_usage">Basic usage</a>
+ </li><li>
+ <a href="#Remote_transports">Transports</a>
+ </li><li>
+ <a href="#Remote_URI_reference">Remote URIs</a>
+ <ul><li>
+ <a href="#Remote_URI_parameters">Extra parameters</a>
+ </li></ul></li><li>
+ <a href="#Remote_certificates">Generating TLS certificates</a>
+ <ul><li>
+ <a href="#Remote_PKI">Public Key Infrastructure set up</a>
+ </li><li>
+ <a href="#Remote_TLS_background">Background to TLS certificates</a>
+ </li><li>
+ <a href="#Remote_TLS_CA">Setting up a Certificate Authority (CA)</a>
+ </li><li>
+ <a href="#Remote_TLS_server_certificates">Issuing server certificates</a>
+ </li><li>
+ <a href="#Remote_TLS_client_certificates">Issuing client certificates</a>
+ </li><li>
+ <a href="#Remote_TLS_troubleshooting">Troubleshooting TLS certificate problems</a>
+ </li></ul></li><li>
+ <a href="#Remote_libvirtd_configuration">libvirtd configuration file</a>
+ </li><li>
+ <a href="#Remote_IPv6">IPv6 support</a>
+ </li><li>
+ <a href="#Remote_limitations">Limitations</a>
+ </li><li>
+ <a href="#Remote_implementation_notes">Implementation notes</a>
+ </li></ul>
+ <h3>
+ <a name="Remote_basic_usage" id="Remote_basic_usage">Basic usage</a>
+ </h3>
+ <p>
On the remote machine, <code>libvirtd</code> should be running.
See <a href="#Remote_libvirtd_configuration">the section
on configuring libvirtd</a> for more information.
-</p><p>
+</p>
+ <p>
To tell libvirt that you want to access a remote resource,
you should supply a hostname in the normal <a href="uri.html">URI</a> that is passed
to <code>virConnectOpen</code> (or <code>virsh -c ...</code>).
to access the system-wide QEMU daemon, then to access
the system-wide QEMU daemon on a remote machine called
<code>oirase</code> you would use <code>qemu://oirase/system</code>.
-</p><p>
+</p>
+ <p>
The <a href="#Remote_URI_reference">section on remote URIs</a>
describes in more detail these remote URIs.
-</p><p>
+</p>
+ <p>
From an API point of view, apart from the change in URI, the
API should behave the same. For example, ordinary calls
are routed over the remote connection transparently, and
values or errors from the remote side are returned to you
as if they happened locally. Some differences you may notice:
-</p><ul><li> Additional errors can be generated, specifically ones
-relating to failures in the remote transport itself. </li>
-<li> Remote calls are handled synchronously, so they will be
-much slower than, say, direct hypervisor calls. </li>
-</ul><h3><a name="Remote_transports" id="Remote_transports">Transports</a></h3><p>
+</p>
+ <ul><li> Additional errors can be generated, specifically ones
+relating to failures in the remote transport itself. </li><li> Remote calls are handled synchronously, so they will be
+much slower than, say, direct hypervisor calls. </li></ul>
+ <h3>
+ <a name="Remote_transports" id="Remote_transports">Transports</a>
+ </h3>
+ <p>
Remote libvirt supports a range of transports:
-</p><dl><dt> tls </dt>
-
<dd> <a href="http://en.wikipedia.org/wiki/Transport_Layer_Security" title="Transport Layer Security">TLS</a>
+</p>
+
<dl><dt> tls </dt><dd><a href="http://en.wikipedia.org/wiki/Transport_Layer_Security" title="Transport Layer Security">TLS</a>
1.0 (SSL 3.1) authenticated and encrypted TCP/IP socket, usually
listening on a public port number. To use this you will need to
<a href="#Remote_certificates" title="Generating TLS certificates">generate client and
server certificates</a>.
The standard port is 16514.
- </dd>
-
-<dt> unix </dt>
-<dd> Unix domain socket. Since this is only accessible on the
+ </dd><dt> unix </dt><dd> Unix domain socket. Since this is only accessible on the
local machine, it is not encrypted, and uses Unix permissions or
SELinux for authentication.
The standard socket names are
<code>/var/run/libvirt/libvirt-sock</code> and
<code>/var/run/libvirt/libvirt-sock-ro</code> (the latter
for read-only connections).
- </dd>
-
-<dt> ssh </dt>
-<dd> Transported over an ordinary
+ </dd><dt> ssh </dt><dd> Transported over an ordinary
<a href="http://www.openssh.com/" title="OpenSSH homepage">ssh
(secure shell)</a> connection.
Requires <a href="http://netcat.sourceforge.net/">Netcat (nc)</a>
ssh key management (eg.
<a href="http://mah.everybody.org/docs/ssh" title="Using ssh-agent with ssh">ssh-agent</a>)
otherwise programs which use
- this transport will stop to ask for a password. </dd>
-
-<dt> ext </dt>
-<dd> Any external program which can make a connection to the
- remote machine by means outside the scope of libvirt. </dd>
-
-<dt> tcp </dt>
-<dd> Unencrypted TCP/IP socket. Not recommended for production
+ this transport will stop to ask for a password. </dd><dt> ext </dt><dd> Any external program which can make a connection to the
+ remote machine by means outside the scope of libvirt. </dd><dt> tcp </dt><dd> Unencrypted TCP/IP socket. Not recommended for production
use, this is normally disabled, but an administrator can enable
it for testing or use over a trusted network.
The standard port is 16509.
- </dd>
+ </dd></dl>
The default transport, if no other is specified, is <code>tls</code>.
-</p><h3><a name="Remote_URI_reference" id="Remote_URI_reference">Remote URIs</a></h3><p>
+</p>
+ <h3>
+ <a name="Remote_URI_reference" id="Remote_URI_reference">Remote URIs</a>
+ </h3>
+ <p>
See also: <a href="uri.html">documentation on ordinary ("local") URIs</a>.
-</p><p>
+</p>
+ <p>
Remote URIs have the general form ("[...]" meaning an optional part):
-</p><p>
-<code>driver</code>[<code>+transport</code>]<code>://</code>[<code>username@</code>][<code>hostname</code>][<code>:port</code>]<code>/</code>[<code>path</code>][<code>?extraparameters</code>]
-</p><p>
+</p>
+ <p><code>driver</code>[<code>+transport</code>]<code>://</code>[<code>username@</code>][<code>hostname</code>][<code>:port</code>]<code>/</code>[<code>path</code>][<code>?extraparameters</code>]
+</p>
+ <p>
Either the transport or the hostname must be given in order
to distinguish this from a local URI.
-</p><p>
+</p>
+ <p>
Some examples:
-</p><ul><li> <code>xen+ssh://rjones@towada/</code> <br /> — Connect to a
+</p>
+ <ul><li><code>xen+ssh://rjones@towada/</code><br /> — Connect to a
remote Xen hypervisor on host <code>towada</code> using ssh transport and ssh
username <code>rjones</code>.
-</li>
-
-<li> <code>xen://towada/</code> <br /> — Connect to a
+</li><li><code>xen://towada/</code><br /> — Connect to a
remote Xen hypervisor on host <code>towada</code> using TLS.
-</li>
-
-<li> <code>xen://towada/?no_verify=1</code> <br /> — Connect to a
+</li><li><code>xen://towada/?no_verify=1</code><br /> — Connect to a
remote Xen hypervisor on host <code>towada</code> using TLS. Do not verify
the server's certificate.
-</li>
-
-<li> <code>qemu+unix:///system?socket=/opt/libvirt/run/libvirt/libvirt-sock</code> <br /> —
+</li><li><code>qemu+unix:///system?socket=/opt/libvirt/run/libvirt/libvirt-sock</code><br /> —
Connect to the local qemu instances over a non-standard
Unix socket (the full path to the Unix socket is
supplied explicitly in this case).
-</li>
-
-<li> <code>test+tcp://localhost:5000/default</code> <br /> —
+</li><li><code>test+tcp://localhost:5000/default</code><br /> —
Connect to a libvirtd daemon offering unencrypted TCP/IP connections
on localhost port 5000 and use the test driver with default
settings.
-</li>
-
-</ul><h4><a name="Remote_URI_parameters" id="Remote_URI_parameters">Extra parameters</a></h4><p>
+</li></ul>
+ <h4>
+ <a name="Remote_URI_parameters" id="Remote_URI_parameters">Extra parameters</a>
+ </h4>
+ <p>
Extra parameters can be added to remote URIs as part
of the query string (the part following <q><code>?</code></q>).
Remote URIs understand the extra parameters shown below.
Any others are passed unmodified through to the back end.
Note that parameter values must be
<a href="http://xmlsoft.org/html/libxml-uri.html#xmlURIEscapeStr">URI-escaped</a>.
-</p><table class="top_table"><tr><th> Name </th>
-<th> Transports </th>
-<th> Meaning </th>
-</tr><tr><td> <code>name</code> </td>
-<td> <i>any transport</i> </td>
-<td>
+</p>
+ <table class="top_table"><tr><th> Name </th><th> Transports </th><th> Meaning </th></tr><tr><td>
+ <code>name</code>
+ </td><td>
+ <i>any transport</i>
+ </td><td>
The name passed to the remote virConnectOpen function. The
name is normally formed by removing transport, hostname, port
number, username and extra parameters from the remote URI, but in certain
very complex cases it may be better to supply the name explicitly.
-</td>
-</tr><tr><td colspan="2"></td>
-<td> Example: <code>name=qemu:///system</code> </td>
-</tr><tr><td> <code>command</code> </td>
-<td> ssh, ext </td>
-<td>
+</td></tr><tr><td colspan="2"></td><td> Example: <code>name=qemu:///system</code> </td></tr><tr><td>
+ <code>command</code>
+ </td><td> ssh, ext </td><td>
The external command. For ext transport this is required.
For ssh the default is <code>ssh</code>.
The PATH is searched for the command.
-</td>
-</tr><tr><td colspan="2"></td>
-<td> Example: <code>command=/opt/openssh/bin/ssh</code> </td>
-</tr><tr><td> <code>socket</code> </td>
-<td> unix, ssh </td>
-<td>
+</td></tr><tr><td colspan="2"></td><td> Example: <code>command=/opt/openssh/bin/ssh</code> </td></tr><tr><td>
+ <code>socket</code>
+ </td><td> unix, ssh </td><td>
The path to the Unix domain socket, which overrides the
compiled-in default. For ssh transport, this is passed to
the remote netcat command (see next).
-</td>
-</tr><tr><td colspan="2"></td>
-<td> Example: <code>socket=/opt/libvirt/run/libvirt/libvirt-sock</code> </td>
-</tr><tr><td> <code>netcat</code> </td>
-<td> ssh </td>
-<td>
+</td></tr><tr><td colspan="2"></td><td> Example: <code>socket=/opt/libvirt/run/libvirt/libvirt-sock</code> </td></tr><tr><td>
+ <code>netcat</code>
+ </td><td> ssh </td><td>
The name of the netcat command on the remote machine.
The default is <code>nc</code>. For ssh transport, libvirt
constructs an ssh command which looks like:
-<pre>
-<i>command</i> -p <i>port</i> [-l <i>username</i>] <i>hostname</i> <i>netcat</i> -U <i>socket</i>
+<pre><i>command</i> -p <i>port</i> [-l <i>username</i>] <i>hostname</i> <i>netcat</i> -U <i>socket</i>
</pre>
where <i>port</i>, <i>username</i>, <i>hostname</i> can be
and <i>socket</i> come from extra parameters (or
sensible defaults).
-</td>
-</tr><tr><td colspan="2"></td>
-<td> Example: <code>netcat=/opt/netcat/bin/nc</code> </td>
-</tr><tr><td> <code>no_verify</code> </td>
-<td> tls </td>
-<td>
+</td></tr><tr><td colspan="2"></td><td> Example: <code>netcat=/opt/netcat/bin/nc</code> </td></tr><tr><td>
+ <code>no_verify</code>
+ </td><td> tls </td><td>
If set to a non-zero value, this disables client checks of the
server's certificate. Note that to disable server checks of
the client's certificate or IP address you must
<a href="#Remote_libvirtd_configuration">change the libvirtd
configuration</a>.
-</td>
-</tr><tr><td colspan="2"></td>
-<td> Example: <code>no_verify=1</code> </td>
-</tr><tr><td> <code>no_tty</code> </td>
-<td> ssh </td>
-<td>
+</td></tr><tr><td colspan="2"></td><td> Example: <code>no_verify=1</code> </td></tr><tr><td>
+ <code>no_tty</code>
+ </td><td> ssh </td><td>
If set to a non-zero value, this stops ssh from asking for
a password if it cannot log in to the remote machine automatically
(eg. using ssh-agent etc.). Use this when you don't have access
to a terminal - for example in graphical programs which use libvirt.
-</td>
-</tr><tr><td colspan="2"></td>
-<td> Example: <code>no_tty=1</code> </td>
-</tr></table><h3><a name="Remote_certificates" id="Remote_certificates">Generating TLS certificates</a></h3><h4><a name="Remote_PKI" id="Remote_PKI">Public Key Infrastructure set up</a></h4><p>
+</td></tr><tr><td colspan="2"></td><td> Example: <code>no_tty=1</code> </td></tr></table>
+ <h3>
+ <a name="Remote_certificates" id="Remote_certificates">Generating TLS certificates</a>
+ </h3>
+ <h4>
+ <a name="Remote_PKI" id="Remote_PKI">Public Key Infrastructure set up</a>
+ </h4>
+ <p>
If you are unsure how to create TLS certificates, skip to the
next section.
-</p><table class="top_table"><tr><th> Location </th>
-<th> Machine </th>
-<th> Description </th>
-<th> Required fields </th>
-</tr><tr><td> <code>/etc/pki/CA/cacert.pem</code> </td>
-<td> Installed on all clients and servers </td>
-<td> CA's certificate (<a href="#Remote_TLS_CA">more info</a>)</td>
-<td> n/a </td>
-</tr><tr><td> <code>/etc/pki/libvirt/ private/serverkey.pem</code> </td>
-<td> Installed on the server </td>
-<td> Server's private key (<a href="#Remote_TLS_server_certificates">more info</a>)</td>
-<td> n/a </td>
-</tr><tr><td> <code>/etc/pki/libvirt/ servercert.pem</code> </td>
-<td> Installed on the server </td>
-<td> Server's certificate signed by the CA.
- (<a href="#Remote_TLS_server_certificates">more info</a>) </td>
-<td> CommonName (CN) must be the hostname of the server as it
- is seen by clients. </td>
-</tr><tr><td> <code>/etc/pki/libvirt/ private/clientkey.pem</code> </td>
-<td> Installed on the client </td>
-<td> Client's private key. (<a href="#Remote_TLS_client_certificates">more info</a>) </td>
-<td> n/a </td>
-</tr><tr><td> <code>/etc/pki/libvirt/ clientcert.pem</code> </td>
-<td> Installed on the client </td>
-<td> Client's certificate signed by the CA
- (<a href="#Remote_TLS_client_certificates">more info</a>) </td>
-<td> Distinguished Name (DN) can be checked against an access
+</p>
+ <table class="top_table"><tr><th> Location </th><th> Machine </th><th> Description </th><th> Required fields </th></tr><tr><td>
+ <code>/etc/pki/CA/cacert.pem</code>
+ </td><td> Installed on all clients and servers </td><td> CA's certificate (<a href="#Remote_TLS_CA">more info</a>)</td><td> n/a </td></tr><tr><td>
+ <code>/etc/pki/libvirt/ private/serverkey.pem</code>
+ </td><td> Installed on the server </td><td> Server's private key (<a href="#Remote_TLS_server_certificates">more info</a>)</td><td> n/a </td></tr><tr><td>
+ <code>/etc/pki/libvirt/ servercert.pem</code>
+ </td><td> Installed on the server </td><td> Server's certificate signed by the CA.
+ (<a href="#Remote_TLS_server_certificates">more info</a>) </td><td> CommonName (CN) must be the hostname of the server as it
+ is seen by clients. </td></tr><tr><td>
+ <code>/etc/pki/libvirt/ private/clientkey.pem</code>
+ </td><td> Installed on the client </td><td> Client's private key. (<a href="#Remote_TLS_client_certificates">more info</a>) </td><td> n/a </td></tr><tr><td>
+ <code>/etc/pki/libvirt/ clientcert.pem</code>
+ </td><td> Installed on the client </td><td> Client's certificate signed by the CA
+ (<a href="#Remote_TLS_client_certificates">more info</a>) </td><td> Distinguished Name (DN) can be checked against an access
control list (<code>tls_allowed_dn_list</code>).
- </td>
-</tr></table><h4><a name="Remote_TLS_background" id="Remote_TLS_background">Background to TLS certificates</a></h4><p>
+ </td></tr></table>
+ <h4>
+ <a name="Remote_TLS_background" id="Remote_TLS_background">Background to TLS certificates</a>
+ </h4>
+ <p>
Libvirt supports TLS certificates for verifying the identity
of the server and clients. There are two distinct checks involved:
-</p><ul><li> The client should know that it is connecting to the right
+</p>
+ <ul><li> The client should know that it is connecting to the right
server. Checking done by client by matching the certificate that
the server sends to the server's hostname. May be disabled by adding
<code>?no_verify=1</code> to the
<a href="#Remote_URI_parameters">remote URI</a>.
-</li>
-
-<li> The server should know that only permitted clients are
+</li><li> The server should know that only permitted clients are
connecting. This can be done based on client's IP address, or on
client's IP address and client's certificate. Checking done by the
server. May be enabled and disabled in the <a href="#Remote_libvirtd_configuration">libvirtd.conf file</a>.
-</li>
+</li></ul>
For full certificate checking you will need to have certificates
issued by a recognised <a href="http://en.wikipedia.org/wiki/Certificate_authority">Certificate
Authority (CA)</a> for your server(s) and all clients. To avoid the
expense of getting certificates from a commercial CA, you can set up
your own CA and tell your server(s) and clients to trust certificates
issues by your own CA. Follow the instructions in the next section.
-</p><p>
+</p>
+ <p>
Be aware that the <a href="#Remote_libvirtd_configuration">default
configuration for libvirtd</a> allows any client to connect provided
they have a valid certificate issued by the CA for their own IP
address. You may want to change this to make it less (or more)
permissive, depending on your needs.
-</p><h4><a name="Remote_TLS_CA" id="Remote_TLS_CA">Setting up a Certificate Authority (CA)</a></h4><p>
+</p>
+ <h4>
+ <a name="Remote_TLS_CA" id="Remote_TLS_CA">Setting up a Certificate Authority (CA)</a>
+ </h4>
+ <p>
You will need the <a href="http://www.gnu.org/software/gnutls/manual/html_node/Invoking-certtool.html">GnuTLS
certtool program documented here</a>. In Fedora, it is in the
<code>gnutls-utils</code> package.
-</p><p>
+</p>
+ <p>
Create a private key for your CA:
-</p><pre>
+</p>
+ <pre>
certtool --generate-privkey > cakey.pem
-</pre><p>
+</pre>
+ <p>
and self-sign it by creating a file with the
signature details called
<code>ca.info</code> containing:
-</p><pre>
+</p>
+ <pre>
cn = <i>Name of your organization</i>
ca
cert_signing_key
-</pre><pre>
+</pre>
+ <pre>
certtool --generate-self-signed --load-privkey cakey.pem \
--template ca.info --outfile cacert.pem
-</pre><p>
+</pre>
+ <p>
(You can delete <code>ca.info</code> file now if you
want).
-</p><p>
+</p>
+ <p>
Now you have two files which matter:
-</p><ul><li>
-<code>cakey.pem</code> - Your CA's private key (keep this very secret!)
-</li>
-<li>
-<code>cacert.pem</code> - Your CA's certificate (this is public).
-</li>
-</ul><p>
-<code>cacert.pem</code> has to be installed on clients and
+</p>
+ <ul><li><code>cakey.pem</code> - Your CA's private key (keep this very secret!)
+</li><li><code>cacert.pem</code> - Your CA's certificate (this is public).
+</li></ul>
+ <p><code>cacert.pem</code> has to be installed on clients and
server(s) to let them know that they can trust certificates issued by
your CA.
-</p><p>
+</p>
+ <p>
The normal installation directory for <code>cacert.pem</code>
is <code>/etc/pki/CA/cacert.pem</code> on all clients and servers.
-</p><p>
+</p>
+ <p>
To see the contents of this file, do:
-</p><pre>
-<b>certtool -i --infile cacert.pem</b>
+</p>
+ <pre><b>certtool -i --infile cacert.pem</b>
X.509 certificate info:
Not Before: Mon Jun 18 16:22:18 2007
Not After: Tue Jun 17 16:22:18 2008
<i>[etc]</i>
-</pre><p>
+</pre>
+ <p>
This is all that is required to set up your CA. Keep the CA's private
key carefully as you will need it when you come to issue certificates
for your clients and servers.
-</p><h4><a name="Remote_TLS_server_certificates" id="Remote_TLS_server_certificates">Issuing server certificates</a></h4><p>
+</p>
+ <h4>
+ <a name="Remote_TLS_server_certificates" id="Remote_TLS_server_certificates">Issuing server certificates</a>
+ </h4>
+ <p>
For each server (libvirtd) you need to issue a certificate
with the X.509 CommonName (CN) field set to the hostname
of the server. The CN must match the hostname which
clients will be using to connect to the server.
-</p><p>
+</p>
+ <p>
In the example below, clients will be connecting to the
server using a <a href="#Remote_URI_reference">URI</a> of
<code>xen://oirase/</code>, so the CN must be "<code>oirase</code>".
-</p><p>
+</p>
+ <p>
Make a private key for the server:
-</p><pre>
+</p>
+ <pre>
certtool --generate-privkey > serverkey.pem
-</pre><p>
+</pre>
+ <p>
and sign that key with the CA's private key by first
creating a template file called <code>server.info</code>
(only the CN field matters, which as explained above must
be the server's hostname):
-</p><pre>
+</p>
+ <pre>
organization = <i>Name of your organization</i>
cn = oirase
tls_www_server
encryption_key
signing_key
-</pre><p>
+</pre>
+ <p>
and sign:
-</p><pre>
+</p>
+ <pre>
certtool --generate-certificate --load-privkey serverkey.pem \
--load-ca-certificate cacert.pem --load-ca-privkey cakey.pem \
--template server.info --outfile servercert.pem
-</pre><p>
+</pre>
+ <p>
This gives two files:
-</p><ul><li>
-<code>serverkey.pem</code> - The server's private key.
-</li>
-<li>
-<code>servercert.pem</code> - The server's public key.
-</li>
-</ul><p>
+</p>
+ <ul><li><code>serverkey.pem</code> - The server's private key.
+</li><li><code>servercert.pem</code> - The server's public key.
+</li></ul>
+ <p>
We can examine this certificate and its signature:
-</p><pre>
-<b>certtool -i --infile servercert.pem</b>
+</p>
+ <pre><b>certtool -i --infile servercert.pem</b>
X.509 certificate info:
Version: 3
Validity:
Not Before: Mon Jun 18 16:34:49 2007
Not After: Tue Jun 17 16:34:49 2008
-</pre><p>
+</pre>
+ <p>
Note the "Issuer" CN is "Red Hat Emerging Technologies" (the CA) and
the "Subject" CN is "oirase" (the server).
-</p><p>
+</p>
+ <p>
Finally we have two files to install:
-</p><ul><li>
-<code>serverkey.pem</code> is
+</p>
+ <ul><li><code>serverkey.pem</code> is
the server's private key which should be copied to the
server <i>only</i> as
<code>/etc/pki/libvirt/private/serverkey.pem</code>.
-</li>
-
-<li>
-<code>servercert.pem</code> is the server's certificate
+</li><li><code>servercert.pem</code> is the server's certificate
which can be installed on the server as
<code>/etc/pki/libvirt/servercert.pem</code>.
-</li>
-</ul><h4><a name="Remote_TLS_client_certificates" id="Remote_TLS_client_certificates">Issuing client certificates</a></h4><p>
+</li></ul>
+ <h4>
+ <a name="Remote_TLS_client_certificates" id="Remote_TLS_client_certificates">Issuing client certificates</a>
+ </h4>
+ <p>
For each client (ie. any program linked with libvirt, such as
<a href="http://virt-manager.et.redhat.com/">virt-manager</a>)
you need to issue a certificate with the X.509 Distinguished Name (DN)
set to a suitable name. You can decide this on a company / organisation
policy. For example, I use:
-</p><pre>
+</p>
+ <pre>
C=GB,ST=London,L=London,O=Red Hat,CN=<i>name_of_client</i>
-</pre><p>
+</pre>
+ <p>
The process is the same as for
<a href="#Remote_TLS_server_certificates">setting up the
server certificate</a> so here we just briefly cover the
steps.
-</p><ol><li>
+</p>
+ <ol><li>
Make a private key:
<pre>
certtool --generate-privkey > clientkey.pem
</pre>
-</li>
-
-<li>
+</li><li>
Act as CA and sign the certificate. Create client.info containing:
<pre>
country = GB
--load-ca-certificate cacert.pem --load-ca-privkey cakey.pem \
--template client.info --outfile clientcert.pem
</pre>
-</li>
-
-<li>
+</li><li>
Install the certificates on the client machine:
<pre>
cp clientkey.pem /etc/pki/libvirt/private/clientkey.pem
cp clientcert.pem /etc/pki/libvirt/clientcert.pem
</pre>
-</li>
-</ol><h4><a name="Remote_TLS_troubleshooting" id="Remote_TLS_troubleshooting">Troubleshooting TLS certificate problems</a></h4><dl><dt> failed to verify client's certificate </dt>
-<dd>
-<p>
+</li></ol>
+ <h4>
+ <a name="Remote_TLS_troubleshooting" id="Remote_TLS_troubleshooting">Troubleshooting TLS certificate problems</a>
+ </h4>
+ <dl><dt> failed to verify client's certificate </dt><dd>
+ <p>
On the server side, run the libvirtd server with
the '--listen' and '--verbose' options while the
client is connecting. The verbose log messages should
tell you enough to diagnose the problem.
</p>
-</dd>
-
</dl><p> You can use the <a href="pki_check.sh">pki_check.sh</a> shell script
+ </dd></dl>
+
<p> You can use the <a href="pki_check.sh">pki_check.sh</a> shell script
to analyze the setup on the client or server machines, preferably as root.
It will try to point out the possible problems and provide solutions to
-fix the set up up to a point where you have secure remote access.</p><h3><a name="Remote_libvirtd_configuration" id="Remote_libvirtd_configuration">libvirtd configuration file</a></h3><p>
+fix the set up up to a point where you have secure remote access.</p>
+ <h3>
+ <a name="Remote_libvirtd_configuration" id="Remote_libvirtd_configuration">libvirtd configuration file</a>
+ </h3>
+ <p>
Libvirtd (the remote daemon) is configured from a file called
<code>/etc/libvirt/libvirtd.conf</code>, or specified on
the command line using <code>-f filename</code> or
<code>--config filename</code>.
-</p><p>
+</p>
+ <p>
This file should contain lines of the form below.
Blank lines and comments beginning with <code>#</code> are ignored.
-</p><pre>setting = value</pre><p>The following settings, values and default are:</p><table class="top_table"><tr><th> Line </th>
-<th> Default </th>
-<th> Meaning </th>
-</tr><tr><td> listen_tls <i>[0|1]</i> </td>
-<td> 1 (on) </td>
-<td>
+</p>
+ <pre>setting = value</pre>
+ <p>The following settings, values and default are:</p>
+ <table class="top_table"><tr><th> Line </th><th> Default </th><th> Meaning </th></tr><tr><td> listen_tls <i>[0|1]</i> </td><td> 1 (on) </td><td>
Listen for secure TLS connections on the public TCP/IP port.
-</td>
-</tr><tr><td> listen_tcp <i>[0|1]</i> </td>
-<td> 0 (off) </td>
-<td>
+</td></tr><tr><td> listen_tcp <i>[0|1]</i> </td><td> 0 (off) </td><td>
Listen for unencrypted TCP connections on the public TCP/IP port.
-</td>
-</tr><tr><td> tls_port <i>"service"</i> </td>
-<td> "16514" </td>
-<td>
+</td></tr><tr><td> tls_port <i>"service"</i> </td><td> "16514" </td><td>
The port number or service name to listen on for secure TLS connections.
-</td>
-</tr><tr><td> tcp_port <i>"service"</i> </td>
-<td> "16509" </td>
-<td>
+</td></tr><tr><td> tcp_port <i>"service"</i> </td><td> "16509" </td><td>
The port number or service name to listen on for unencrypted TCP connections.
-</td>
-</tr><tr><td> mdns_adv <i>[0|1]</i> </td>
-<td> 1 (advertise with mDNS) </td>
-<td>
+</td></tr><tr><td> mdns_adv <i>[0|1]</i> </td><td> 1 (advertise with mDNS) </td><td>
If set to 1 then the virtualization service will be advertised over
mDNS to hosts on the local LAN segment.
-</td>
-</tr><tr><td> mdns_name <i>"name"</i> </td>
-<td> "Virtualization Host HOSTNAME" </td>
-<td>
+</td></tr><tr><td> mdns_name <i>"name"</i> </td><td> "Virtualization Host HOSTNAME" </td><td>
The name to advertise for this host with Avahi mDNS. The default
includes the machine's short hostname. This must be unique to the
local LAN segment.
-</td>
-</tr><tr><td> unix_sock_group <i>"groupname"</i> </td>
-<td> "root" </td>
-<td>
+</td></tr><tr><td> unix_sock_group <i>"groupname"</i> </td><td> "root" </td><td>
The UNIX group to own the UNIX domain socket. If the socket permissions allow
group access, then applications running under matching group can access the
socket. Only valid if running as root
-</td>
-</tr><tr><td> unix_sock_ro_perms <i>"octal-perms"</i> </td>
-<td> "0777" </td>
-<td>
+</td></tr><tr><td> unix_sock_ro_perms <i>"octal-perms"</i> </td><td> "0777" </td><td>
The permissions for the UNIX domain socket for read-only client connections.
The default allows any user to monitor domains.
-</td>
-</tr><tr><td> unix_sock_rw_perms <i>"octal-perms"</i> </td>
-<td> "0700" </td>
-<td>
+</td></tr><tr><td> unix_sock_rw_perms <i>"octal-perms"</i> </td><td> "0700" </td><td>
The permissions for the UNIX domain socket for read-write client connections.
The default allows only root to manage domains.
-</td>
-</tr><tr><td> tls_no_verify_certificate <i>[0|1]</i> </td>
-<td> 0 (certificates are verified) </td>
-<td>
+</td></tr><tr><td> tls_no_verify_certificate <i>[0|1]</i> </td><td> 0 (certificates are verified) </td><td>
If set to 1 then if a client certificate check fails, it is not an error.
-</td>
-</tr><tr><td> tls_no_verify_address <i>[0|1]</i> </td>
-<td> 0 (addresses are verified) </td>
-<td>
+</td></tr><tr><td> tls_no_verify_address <i>[0|1]</i> </td><td> 0 (addresses are verified) </td><td>
If set to 1 then if a client IP address check fails, it is not an error.
-</td>
-</tr><tr><td> key_file <i>"filename"</i> </td>
-<td> "/etc/pki/libvirt/ private/serverkey.pem" </td>
-<td>
+</td></tr><tr><td> key_file <i>"filename"</i> </td><td> "/etc/pki/libvirt/ private/serverkey.pem" </td><td>
Change the path used to find the server's private key.
If you set this to an empty string, then no private key is loaded.
-</td>
-</tr><tr><td> cert_file <i>"filename"</i> </td>
-<td> "/etc/pki/libvirt/ servercert.pem" </td>
-<td>
+</td></tr><tr><td> cert_file <i>"filename"</i> </td><td> "/etc/pki/libvirt/ servercert.pem" </td><td>
Change the path used to find the server's certificate.
If you set this to an empty string, then no certificate is loaded.
-</td>
-</tr><tr><td> ca_file <i>"filename"</i> </td>
-<td> "/etc/pki/CA/cacert.pem" </td>
-<td>
+</td></tr><tr><td> ca_file <i>"filename"</i> </td><td> "/etc/pki/CA/cacert.pem" </td><td>
Change the path used to find the trusted CA certificate.
If you set this to an empty string, then no trusted CA certificate is loaded.
-</td>
-</tr><tr><td> crl_file <i>"filename"</i> </td>
-<td> (no CRL file is used) </td>
-<td>
+</td></tr><tr><td> crl_file <i>"filename"</i> </td><td> (no CRL file is used) </td><td>
Change the path used to find the CA certificate revocation list (CRL) file.
If you set this to an empty string, then no CRL is loaded.
-</td>
-</tr><tr><td> tls_allowed_dn_list ["DN1", "DN2"] </td>
-<td> (none - DNs are not checked) </td>
-<td>
- <p>
+</td></tr><tr><td> tls_allowed_dn_list ["DN1", "DN2"] </td><td> (none - DNs are not checked) </td><td>
+ <p>
Enable an access control list of client certificate Distinguished
Names (DNs) which can connect to the TLS port on this server.
</p>
- <p>
The default is that DNs are not checked.
</p>
- <p>
This list may contain wildcards such as <code>"C=GB,ST=London,L=London,O=Red Hat,CN=*"</code>
See the POSIX <code>fnmatch</code> function for the format
of the wildcards.
</p>
- <p>
Note that if this is an empty list, <i>no client can connect</i>.
</p>
- <p>
Note also that GnuTLS returns DNs without spaces
after commas between the fields (and this is what we check against),
but the <code>openssl x509</code> tool shows spaces.
-</p></td>
-</tr><tr><td> tls_allowed_ip_list ["ip1", "ip2", "ip3"] </td>
-<td> (none - clients can connect from anywhere) </td>
-<td>
- <p>
+</p>
+ </td></tr><tr><td> tls_allowed_ip_list ["ip1", "ip2", "ip3"] </td><td> (none - clients can connect from anywhere) </td><td>
+ <p>
Enable an access control list of the IP addresses of clients
who can connect to the TLS or TCP ports on this server.
</p>
- <p>
The default is that clients can connect from any IP address.
</p>
- <p>
This list may contain wildcards such as <code>192.168.*</code>
See the POSIX <code>fnmatch</code> function for the format
of the wildcards.
</p>
- <p>
Note that if this is an empty list, <i>no client can connect</i>.
</p>
-</td>
-</tr></table><h3><a name="Remote_IPv6" id="Remote_IPv6">IPv6 support</a></h3><p>
+ </td></tr></table>
+ <h3>
+ <a name="Remote_IPv6" id="Remote_IPv6">IPv6 support</a>
+ </h3>
+ <p>
The libvirtd service and libvirt remote client driver both use the
<code>getaddrinfo()</code> functions for name resolution and are
thus fully IPv6 enabled. ie, if a server has IPv6 address configured
address resolved for a service is reachable over IPv6, then an IPv6
connection will be made, otherwise IPv4 will be used. In summary it
should just 'do the right thing(tm)'.
-</p><h3><a name="Remote_limitations" id="Remote_limitations">Limitations</a></h3><ul><li> Remote storage: To be fully useful, particularly for
+</p>
+ <h3>
+ <a name="Remote_limitations" id="Remote_limitations">Limitations</a>
+ </h3>
+ <ul><li> Remote storage: To be fully useful, particularly for
creating new domains, it should be possible to enumerate
and provision storage on the remote machine. This is currently
-in the design phase. </li>
-
-<li> Migration: We expect libvirt will support migration,
+in the design phase. </li><li> Migration: We expect libvirt will support migration,
and obviously remote support is what makes migration worthwhile.
This is also in the design phase. Issues <a href="https://www.redhat.com/mailman/listinfo/libvir-list" title="libvir-list mailing list">to discuss</a> include
which path the migration data should follow (eg. client to
client direct, or client to server to client) and security.
-</li>
-
-<li> Fine-grained authentication: libvirt in general,
+</li><li> Fine-grained authentication: libvirt in general,
but in particular the remote case should support more
fine-grained authentication for operations, rather than
just read-write/read-only as at present.
-</li>
+</li></ul>
Please come and discuss these issues and more on <a href="https://www.redhat.com/mailman/listinfo/libvir-list" title="libvir-list mailing list">the mailing list</a>.
-</p><h3><a name="Remote_implementation_notes" id="Remote_implementation_notes">Implementation notes</a></h3><p>
+</p>
+ <h3>
+ <a name="Remote_implementation_notes" id="Remote_implementation_notes">Implementation notes</a>
+ </h3>
+ <p>
The current implementation uses <a href="http://en.wikipedia.org/wiki/External_Data_Representation" title="External Data Representation">XDR</a>-encoded packets with a
simple remote procedure call implementation which also supports
asynchronous messaging and asynchronous and out-of-order replies,
although these latter features are not used at the moment.
-</p><p>
+</p>
+ <p>
The implementation should be considered <b>strictly internal</b> to
libvirt and <b>subject to change at any time without notice</b>. If
you wish to talk to libvirtd, link to libvirt. If there is a problem
that means you think you need to use the protocol directly, please
first discuss this on <a href="https://www.redhat.com/mailman/listinfo/libvir-list" title="libvir-list mailing list">the mailing list</a>.
-</p><p>
+</p>
+ <p>
The messaging protocol is described in
<code>qemud/remote_protocol.x</code>.
-</p><p>
+</p>
+ <p>
Authentication and encryption (for TLS) is done using <a href="http://www.gnu.org/software/gnutls/" title="GnuTLS project page">GnuTLS</a> and the RPC protocol is unaware of this layer.
-</p><p>
+</p>
+ <p>
Protocol messages are sent using a simple 32 bit length word (encoded
XDR int) followed by the message header (XDR
<code>remote_message_header</code>) followed by the message body. The
server, and the server then replies synchronously with a single
<code>REMOTE_REPLY</code> message, but other forms of messaging are
also possible.
-</p><p>
+</p>
+ <p>
The protocol contains support for multiple program types and protocol
versioning, modelled after SunRPC.
-</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+</p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="active" href="deployment.html">Deployment</a>
+ <ul class="l2"><li>
+ <a title="The URI formats used for connecting to libvirt" class="inactive" href="uri.html">URI format</a>
+ </li><li>
+ <span class="active">Remote access</span>
+ </li><li>
+ <a title="Configure authentication for the libvirt daemon" class="inactive" href="auth.html">Authentication</a>
+ </li><li>
+ <a title="Access the libvirt daemon from a native Windows client" class="inactive" href="windows.html">Windows port</a>
+ </li></ul>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1 >Remote support</h1>
+ <p>
+Libvirt allows you to access hypervisors running on remote
+machines through authenticated and encrypted connections.
+</p>
+ <ul>
+ <li>
+ <a href="#Remote_basic_usage">Basic usage</a>
+ </li>
+ <li>
+ <a href="#Remote_transports">Transports</a>
+ </li>
+ <li>
+ <a href="#Remote_URI_reference">Remote URIs</a>
+ <ul>
+ <li>
+ <a href="#Remote_URI_parameters">Extra parameters</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="#Remote_certificates">Generating TLS certificates</a>
+ <ul>
+ <li>
+ <a href="#Remote_PKI">Public Key Infrastructure set up</a>
+ </li>
+ <li>
+ <a href="#Remote_TLS_background">Background to TLS certificates</a>
+ </li>
+ <li>
+ <a href="#Remote_TLS_CA">Setting up a Certificate Authority (CA)</a>
+ </li>
+ <li>
+ <a href="#Remote_TLS_server_certificates">Issuing server certificates</a>
+ </li>
+ <li>
+ <a href="#Remote_TLS_client_certificates">Issuing client certificates</a>
+ </li>
+ <li>
+ <a href="#Remote_TLS_troubleshooting">Troubleshooting TLS certificate problems</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="#Remote_libvirtd_configuration">libvirtd configuration file</a>
+ </li>
+ <li>
+ <a href="#Remote_IPv6">IPv6 support</a>
+ </li>
+ <li>
+ <a href="#Remote_limitations">Limitations</a>
+ </li>
+ <li>
+ <a href="#Remote_implementation_notes">Implementation notes</a>
+ </li>
+ </ul>
+ <h3>
+ <a name="Remote_basic_usage" id="Remote_basic_usage">Basic usage</a>
+ </h3>
+ <p>
+On the remote machine, <code>libvirtd</code> should be running.
+See <a href="#Remote_libvirtd_configuration">the section
+on configuring libvirtd</a> for more information.
+</p>
+ <p>
+To tell libvirt that you want to access a remote resource,
+you should supply a hostname in the normal <a href="uri.html">URI</a> that is passed
+to <code>virConnectOpen</code> (or <code>virsh -c ...</code>).
+For example, if you normally use <code>qemu:///system</code>
+to access the system-wide QEMU daemon, then to access
+the system-wide QEMU daemon on a remote machine called
+<code>oirase</code> you would use <code>qemu://oirase/system</code>.
+</p>
+ <p>
+The <a href="#Remote_URI_reference">section on remote URIs</a>
+describes in more detail these remote URIs.
+</p>
+ <p>
+From an API point of view, apart from the change in URI, the
+API should behave the same. For example, ordinary calls
+are routed over the remote connection transparently, and
+values or errors from the remote side are returned to you
+as if they happened locally. Some differences you may notice:
+</p>
+ <ul>
+ <li> Additional errors can be generated, specifically ones
+relating to failures in the remote transport itself. </li>
+ <li> Remote calls are handled synchronously, so they will be
+much slower than, say, direct hypervisor calls. </li>
+ </ul>
+ <h3>
+ <a name="Remote_transports" id="Remote_transports">Transports</a>
+ </h3>
+ <p>
+Remote libvirt supports a range of transports:
+</p>
+ <dl>
+ <dt> tls </dt>
+ <dd><a href="http://en.wikipedia.org/wiki/Transport_Layer_Security" title="Transport Layer Security">TLS</a>
+ 1.0 (SSL 3.1) authenticated and encrypted TCP/IP socket, usually
+ listening on a public port number. To use this you will need to
+ <a href="#Remote_certificates" title="Generating TLS certificates">generate client and
+ server certificates</a>.
+ The standard port is 16514.
+ </dd>
+ <dt> unix </dt>
+ <dd> Unix domain socket. Since this is only accessible on the
+ local machine, it is not encrypted, and uses Unix permissions or
+ SELinux for authentication.
+ The standard socket names are
+ <code>/var/run/libvirt/libvirt-sock</code> and
+ <code>/var/run/libvirt/libvirt-sock-ro</code> (the latter
+ for read-only connections).
+ </dd>
+ <dt> ssh </dt>
+ <dd> Transported over an ordinary
+ <a href="http://www.openssh.com/" title="OpenSSH homepage">ssh
+ (secure shell)</a> connection.
+ Requires <a href="http://netcat.sourceforge.net/">Netcat (nc)</a>
+ installed and libvirtd should be running
+ on the remote machine. You should use some sort of
+ ssh key management (eg.
+ <a href="http://mah.everybody.org/docs/ssh" title="Using ssh-agent with ssh">ssh-agent</a>)
+ otherwise programs which use
+ this transport will stop to ask for a password. </dd>
+ <dt> ext </dt>
+ <dd> Any external program which can make a connection to the
+ remote machine by means outside the scope of libvirt. </dd>
+ <dt> tcp </dt>
+ <dd> Unencrypted TCP/IP socket. Not recommended for production
+ use, this is normally disabled, but an administrator can enable
+ it for testing or use over a trusted network.
+ The standard port is 16509.
+ </dd>
+ </dl>
+ <p>
+The default transport, if no other is specified, is <code>tls</code>.
+</p>
+ <h3>
+ <a name="Remote_URI_reference" id="Remote_URI_reference">Remote URIs</a>
+ </h3>
+ <p>
+See also: <a href="uri.html">documentation on ordinary ("local") URIs</a>.
+</p>
+ <p>
+Remote URIs have the general form ("[...]" meaning an optional part):
+</p>
+ <p><code>driver</code>[<code>+transport</code>]<code>://</code>[<code>username@</code>][<code>hostname</code>][<code>:port</code>]<code>/</code>[<code>path</code>][<code>?extraparameters</code>]
+</p>
+ <p>
+Either the transport or the hostname must be given in order
+to distinguish this from a local URI.
+</p>
+ <p>
+Some examples:
+</p>
+ <ul>
+ <li><code>xen+ssh://rjones@towada/</code><br/> — Connect to a
+remote Xen hypervisor on host <code>towada</code> using ssh transport and ssh
+username <code>rjones</code>.
+</li>
+ <li><code>xen://towada/</code><br/> — Connect to a
+remote Xen hypervisor on host <code>towada</code> using TLS.
+</li>
+ <li><code>xen://towada/?no_verify=1</code><br/> — Connect to a
+remote Xen hypervisor on host <code>towada</code> using TLS. Do not verify
+the server's certificate.
+</li>
+ <li><code>qemu+unix:///system?socket=/opt/libvirt/run/libvirt/libvirt-sock</code><br/> —
+Connect to the local qemu instances over a non-standard
+Unix socket (the full path to the Unix socket is
+supplied explicitly in this case).
+</li>
+ <li><code>test+tcp://localhost:5000/default</code><br/> —
+Connect to a libvirtd daemon offering unencrypted TCP/IP connections
+on localhost port 5000 and use the test driver with default
+settings.
+</li>
+ </ul>
+ <h4>
+ <a name="Remote_URI_parameters" id="Remote_URI_parameters">Extra parameters</a>
+ </h4>
+ <p>
+Extra parameters can be added to remote URIs as part
+of the query string (the part following <q><code>?</code></q>).
+Remote URIs understand the extra parameters shown below.
+Any others are passed unmodified through to the back end.
+Note that parameter values must be
+<a href="http://xmlsoft.org/html/libxml-uri.html#xmlURIEscapeStr">URI-escaped</a>.
+</p>
+ <table class="top_table">
+ <tr>
+ <th> Name </th>
+ <th> Transports </th>
+ <th> Meaning </th>
+ </tr>
+ <tr>
+ <td>
+ <code>name</code>
+ </td>
+ <td>
+ <i>any transport</i>
+ </td>
+ <td>
+ The name passed to the remote virConnectOpen function. The
+ name is normally formed by removing transport, hostname, port
+ number, username and extra parameters from the remote URI, but in certain
+ very complex cases it may be better to supply the name explicitly.
+</td>
+ </tr>
+ <tr>
+ <td colspan="2"/>
+ <td> Example: <code>name=qemu:///system</code> </td>
+ </tr>
+ <tr>
+ <td>
+ <code>command</code>
+ </td>
+ <td> ssh, ext </td>
+ <td>
+ The external command. For ext transport this is required.
+ For ssh the default is <code>ssh</code>.
+ The PATH is searched for the command.
+</td>
+ </tr>
+ <tr>
+ <td colspan="2"/>
+ <td> Example: <code>command=/opt/openssh/bin/ssh</code> </td>
+ </tr>
+ <tr>
+ <td>
+ <code>socket</code>
+ </td>
+ <td> unix, ssh </td>
+ <td>
+ The path to the Unix domain socket, which overrides the
+ compiled-in default. For ssh transport, this is passed to
+ the remote netcat command (see next).
+</td>
+ </tr>
+ <tr>
+ <td colspan="2"/>
+ <td> Example: <code>socket=/opt/libvirt/run/libvirt/libvirt-sock</code> </td>
+ </tr>
+ <tr>
+ <td>
+ <code>netcat</code>
+ </td>
+ <td> ssh </td>
+ <td>
+ The name of the netcat command on the remote machine.
+ The default is <code>nc</code>. For ssh transport, libvirt
+ constructs an ssh command which looks like:
+
+<pre><i>command</i> -p <i>port</i> [-l <i>username</i>] <i>hostname</i> <i>netcat</i> -U <i>socket</i>
+</pre>
+
+ where <i>port</i>, <i>username</i>, <i>hostname</i> can be
+ specified as part of the remote URI, and <i>command</i>, <i>netcat</i>
+ and <i>socket</i> come from extra parameters (or
+ sensible defaults).
+
+</td>
+ </tr>
+ <tr>
+ <td colspan="2"/>
+ <td> Example: <code>netcat=/opt/netcat/bin/nc</code> </td>
+ </tr>
+ <tr>
+ <td>
+ <code>no_verify</code>
+ </td>
+ <td> tls </td>
+ <td>
+ If set to a non-zero value, this disables client checks of the
+ server's certificate. Note that to disable server checks of
+ the client's certificate or IP address you must
+ <a href="#Remote_libvirtd_configuration">change the libvirtd
+ configuration</a>.
+</td>
+ </tr>
+ <tr>
+ <td colspan="2"/>
+ <td> Example: <code>no_verify=1</code> </td>
+ </tr>
+ <tr>
+ <td>
+ <code>no_tty</code>
+ </td>
+ <td> ssh </td>
+ <td>
+ If set to a non-zero value, this stops ssh from asking for
+ a password if it cannot log in to the remote machine automatically
+ (eg. using ssh-agent etc.). Use this when you don't have access
+ to a terminal - for example in graphical programs which use libvirt.
+</td>
+ </tr>
+ <tr>
+ <td colspan="2"/>
+ <td> Example: <code>no_tty=1</code> </td>
+ </tr>
+ </table>
+ <h3>
+ <a name="Remote_certificates" id="Remote_certificates">Generating TLS certificates</a>
+ </h3>
+ <h4>
+ <a name="Remote_PKI" id="Remote_PKI">Public Key Infrastructure set up</a>
+ </h4>
+ <p>
+If you are unsure how to create TLS certificates, skip to the
+next section.
+</p>
+ <table class="top_table">
+ <tr>
+ <th> Location </th>
+ <th> Machine </th>
+ <th> Description </th>
+ <th> Required fields </th>
+ </tr>
+ <tr>
+ <td>
+ <code>/etc/pki/CA/cacert.pem</code>
+ </td>
+ <td> Installed on all clients and servers </td>
+ <td> CA's certificate (<a href="#Remote_TLS_CA">more info</a>)</td>
+ <td> n/a </td>
+ </tr>
+ <tr>
+ <td>
+ <code>/etc/pki/libvirt/ private/serverkey.pem</code>
+ </td>
+ <td> Installed on the server </td>
+ <td> Server's private key (<a href="#Remote_TLS_server_certificates">more info</a>)</td>
+ <td> n/a </td>
+ </tr>
+ <tr>
+ <td>
+ <code>/etc/pki/libvirt/ servercert.pem</code>
+ </td>
+ <td> Installed on the server </td>
+ <td> Server's certificate signed by the CA.
+ (<a href="#Remote_TLS_server_certificates">more info</a>) </td>
+ <td> CommonName (CN) must be the hostname of the server as it
+ is seen by clients. </td>
+ </tr>
+ <tr>
+ <td>
+ <code>/etc/pki/libvirt/ private/clientkey.pem</code>
+ </td>
+ <td> Installed on the client </td>
+ <td> Client's private key. (<a href="#Remote_TLS_client_certificates">more info</a>) </td>
+ <td> n/a </td>
+ </tr>
+ <tr>
+ <td>
+ <code>/etc/pki/libvirt/ clientcert.pem</code>
+ </td>
+ <td> Installed on the client </td>
+ <td> Client's certificate signed by the CA
+ (<a href="#Remote_TLS_client_certificates">more info</a>) </td>
+ <td> Distinguished Name (DN) can be checked against an access
+ control list (<code>tls_allowed_dn_list</code>).
+ </td>
+ </tr>
+ </table>
+ <h4>
+ <a name="Remote_TLS_background" id="Remote_TLS_background">Background to TLS certificates</a>
+ </h4>
+ <p>
+Libvirt supports TLS certificates for verifying the identity
+of the server and clients. There are two distinct checks involved:
+</p>
+ <ul>
+ <li> The client should know that it is connecting to the right
+server. Checking done by client by matching the certificate that
+the server sends to the server's hostname. May be disabled by adding
+<code>?no_verify=1</code> to the
+<a href="#Remote_URI_parameters">remote URI</a>.
+</li>
+ <li> The server should know that only permitted clients are
+connecting. This can be done based on client's IP address, or on
+client's IP address and client's certificate. Checking done by the
+server. May be enabled and disabled in the <a href="#Remote_libvirtd_configuration">libvirtd.conf file</a>.
+</li>
+ </ul>
+ <p>
+For full certificate checking you will need to have certificates
+issued by a recognised <a href="http://en.wikipedia.org/wiki/Certificate_authority">Certificate
+Authority (CA)</a> for your server(s) and all clients. To avoid the
+expense of getting certificates from a commercial CA, you can set up
+your own CA and tell your server(s) and clients to trust certificates
+issues by your own CA. Follow the instructions in the next section.
+</p>
+ <p>
+Be aware that the <a href="#Remote_libvirtd_configuration">default
+configuration for libvirtd</a> allows any client to connect provided
+they have a valid certificate issued by the CA for their own IP
+address. You may want to change this to make it less (or more)
+permissive, depending on your needs.
+</p>
+ <h4>
+ <a name="Remote_TLS_CA" id="Remote_TLS_CA">Setting up a Certificate Authority (CA)</a>
+ </h4>
+ <p>
+You will need the <a href="http://www.gnu.org/software/gnutls/manual/html_node/Invoking-certtool.html">GnuTLS
+certtool program documented here</a>. In Fedora, it is in the
+<code>gnutls-utils</code> package.
+</p>
+ <p>
+Create a private key for your CA:
+</p>
+ <pre>
+certtool --generate-privkey > cakey.pem
+</pre>
+ <p>
+and self-sign it by creating a file with the
+signature details called
+<code>ca.info</code> containing:
+</p>
+ <pre>
+cn = <i>Name of your organization</i>
+ca
+cert_signing_key
+</pre>
+ <pre>
+certtool --generate-self-signed --load-privkey cakey.pem \
+ --template ca.info --outfile cacert.pem
+</pre>
+ <p>
+(You can delete <code>ca.info</code> file now if you
+want).
+</p>
+ <p>
+Now you have two files which matter:
+</p>
+ <ul>
+ <li><code>cakey.pem</code> - Your CA's private key (keep this very secret!)
+</li>
+ <li><code>cacert.pem</code> - Your CA's certificate (this is public).
+</li>
+ </ul>
+ <p><code>cacert.pem</code> has to be installed on clients and
+server(s) to let them know that they can trust certificates issued by
+your CA.
+</p>
+ <p>
+The normal installation directory for <code>cacert.pem</code>
+is <code>/etc/pki/CA/cacert.pem</code> on all clients and servers.
+</p>
+ <p>
+To see the contents of this file, do:
+</p>
+ <pre><b>certtool -i --infile cacert.pem</b>
+
+X.509 certificate info:
+
+Version: 3
+Serial Number (hex): 00
+Subject: CN=Red Hat Emerging Technologies
+Issuer: CN=Red Hat Emerging Technologies
+Signature Algorithm: RSA-SHA
+Validity:
+ Not Before: Mon Jun 18 16:22:18 2007
+ Not After: Tue Jun 17 16:22:18 2008
+<i>[etc]</i>
+</pre>
+ <p>
+This is all that is required to set up your CA. Keep the CA's private
+key carefully as you will need it when you come to issue certificates
+for your clients and servers.
+</p>
+ <h4>
+ <a name="Remote_TLS_server_certificates" id="Remote_TLS_server_certificates">Issuing server certificates</a>
+ </h4>
+ <p>
+For each server (libvirtd) you need to issue a certificate
+with the X.509 CommonName (CN) field set to the hostname
+of the server. The CN must match the hostname which
+clients will be using to connect to the server.
+</p>
+ <p>
+In the example below, clients will be connecting to the
+server using a <a href="#Remote_URI_reference">URI</a> of
+<code>xen://oirase/</code>, so the CN must be "<code>oirase</code>".
+</p>
+ <p>
+Make a private key for the server:
+</p>
+ <pre>
+certtool --generate-privkey > serverkey.pem
+</pre>
+ <p>
+and sign that key with the CA's private key by first
+creating a template file called <code>server.info</code>
+(only the CN field matters, which as explained above must
+be the server's hostname):
+</p>
+ <pre>
+organization = <i>Name of your organization</i>
+cn = oirase
+tls_www_server
+encryption_key
+signing_key
+</pre>
+ <p>
+and sign:
+</p>
+ <pre>
+certtool --generate-certificate --load-privkey serverkey.pem \
+ --load-ca-certificate cacert.pem --load-ca-privkey cakey.pem \
+ --template server.info --outfile servercert.pem
+</pre>
+ <p>
+This gives two files:
+</p>
+ <ul>
+ <li><code>serverkey.pem</code> - The server's private key.
+</li>
+ <li><code>servercert.pem</code> - The server's public key.
+</li>
+ </ul>
+ <p>
+We can examine this certificate and its signature:
+</p>
+ <pre><b>certtool -i --infile servercert.pem</b>
+X.509 certificate info:
+
+Version: 3
+Serial Number (hex): 00
+Subject: O=Red Hat Emerging Technologies,CN=oirase
+Issuer: CN=Red Hat Emerging Technologies
+Signature Algorithm: RSA-SHA
+Validity:
+ Not Before: Mon Jun 18 16:34:49 2007
+ Not After: Tue Jun 17 16:34:49 2008
+</pre>
+ <p>
+Note the "Issuer" CN is "Red Hat Emerging Technologies" (the CA) and
+the "Subject" CN is "oirase" (the server).
+</p>
+ <p>
+Finally we have two files to install:
+</p>
+ <ul>
+ <li><code>serverkey.pem</code> is
+the server's private key which should be copied to the
+server <i>only</i> as
+<code>/etc/pki/libvirt/private/serverkey.pem</code>.
+</li>
+ <li><code>servercert.pem</code> is the server's certificate
+which can be installed on the server as
+<code>/etc/pki/libvirt/servercert.pem</code>.
+</li>
+ </ul>
+ <h4>
+ <a name="Remote_TLS_client_certificates" id="Remote_TLS_client_certificates">Issuing client certificates</a>
+ </h4>
+ <p>
+For each client (ie. any program linked with libvirt, such as
+<a href="http://virt-manager.et.redhat.com/">virt-manager</a>)
+you need to issue a certificate with the X.509 Distinguished Name (DN)
+set to a suitable name. You can decide this on a company / organisation
+policy. For example, I use:
+</p>
+ <pre>
+C=GB,ST=London,L=London,O=Red Hat,CN=<i>name_of_client</i>
+</pre>
+ <p>
+The process is the same as for
+<a href="#Remote_TLS_server_certificates">setting up the
+server certificate</a> so here we just briefly cover the
+steps.
+</p>
+ <ol>
+ <li>
+Make a private key:
+<pre>
+certtool --generate-privkey > clientkey.pem
+</pre>
+</li>
+ <li>
+Act as CA and sign the certificate. Create client.info containing:
+<pre>
+country = GB
+state = London
+locality = London
+organization = Red Hat
+cn = client1
+tls_www_client
+encryption_key
+signing_key
+</pre>
+and sign by doing:
+<pre>
+certtool --generate-certificate --load-privkey clientkey.pem \
+ --load-ca-certificate cacert.pem --load-ca-privkey cakey.pem \
+ --template client.info --outfile clientcert.pem
+</pre>
+</li>
+ <li>
+Install the certificates on the client machine:
+<pre>
+cp clientkey.pem /etc/pki/libvirt/private/clientkey.pem
+cp clientcert.pem /etc/pki/libvirt/clientcert.pem
+</pre>
+</li>
+ </ol>
+ <h4>
+ <a name="Remote_TLS_troubleshooting" id="Remote_TLS_troubleshooting">Troubleshooting TLS certificate problems</a>
+ </h4>
+ <dl>
+ <dt> failed to verify client's certificate </dt>
+ <dd>
+ <p>
+On the server side, run the libvirtd server with
+the '--listen' and '--verbose' options while the
+client is connecting. The verbose log messages should
+tell you enough to diagnose the problem.
+</p>
+ </dd>
+ </dl>
+ <p> You can use the <a href="pki_check.sh">pki_check.sh</a> shell script
+to analyze the setup on the client or server machines, preferably as root.
+It will try to point out the possible problems and provide solutions to
+fix the set up up to a point where you have secure remote access.</p>
+ <h3>
+ <a name="Remote_libvirtd_configuration" id="Remote_libvirtd_configuration">libvirtd configuration file</a>
+ </h3>
+ <p>
+Libvirtd (the remote daemon) is configured from a file called
+<code>/etc/libvirt/libvirtd.conf</code>, or specified on
+the command line using <code>-f filename</code> or
+<code>--config filename</code>.
+</p>
+ <p>
+This file should contain lines of the form below.
+Blank lines and comments beginning with <code>#</code> are ignored.
+</p>
+ <pre>setting = value</pre>
+ <p>The following settings, values and default are:</p>
+ <table class="top_table">
+ <tr>
+ <th> Line </th>
+ <th> Default </th>
+ <th> Meaning </th>
+ </tr>
+ <tr>
+ <td> listen_tls <i>[0|1]</i> </td>
+ <td> 1 (on) </td>
+ <td>
+ Listen for secure TLS connections on the public TCP/IP port.
+</td>
+ </tr>
+ <tr>
+ <td> listen_tcp <i>[0|1]</i> </td>
+ <td> 0 (off) </td>
+ <td>
+ Listen for unencrypted TCP connections on the public TCP/IP port.
+</td>
+ </tr>
+ <tr>
+ <td> tls_port <i>"service"</i> </td>
+ <td> "16514" </td>
+ <td>
+ The port number or service name to listen on for secure TLS connections.
+</td>
+ </tr>
+ <tr>
+ <td> tcp_port <i>"service"</i> </td>
+ <td> "16509" </td>
+ <td>
+ The port number or service name to listen on for unencrypted TCP connections.
+</td>
+ </tr>
+ <tr>
+ <td> mdns_adv <i>[0|1]</i> </td>
+ <td> 1 (advertise with mDNS) </td>
+ <td>
+ If set to 1 then the virtualization service will be advertised over
+ mDNS to hosts on the local LAN segment.
+</td>
+ </tr>
+ <tr>
+ <td> mdns_name <i>"name"</i> </td>
+ <td> "Virtualization Host HOSTNAME" </td>
+ <td>
+ The name to advertise for this host with Avahi mDNS. The default
+ includes the machine's short hostname. This must be unique to the
+ local LAN segment.
+</td>
+ </tr>
+ <tr>
+ <td> unix_sock_group <i>"groupname"</i> </td>
+ <td> "root" </td>
+ <td>
+ The UNIX group to own the UNIX domain socket. If the socket permissions allow
+ group access, then applications running under matching group can access the
+ socket. Only valid if running as root
+</td>
+ </tr>
+ <tr>
+ <td> unix_sock_ro_perms <i>"octal-perms"</i> </td>
+ <td> "0777" </td>
+ <td>
+ The permissions for the UNIX domain socket for read-only client connections.
+ The default allows any user to monitor domains.
+</td>
+ </tr>
+ <tr>
+ <td> unix_sock_rw_perms <i>"octal-perms"</i> </td>
+ <td> "0700" </td>
+ <td>
+ The permissions for the UNIX domain socket for read-write client connections.
+ The default allows only root to manage domains.
+</td>
+ </tr>
+ <tr>
+ <td> tls_no_verify_certificate <i>[0|1]</i> </td>
+ <td> 0 (certificates are verified) </td>
+ <td>
+ If set to 1 then if a client certificate check fails, it is not an error.
+</td>
+ </tr>
+ <tr>
+ <td> tls_no_verify_address <i>[0|1]</i> </td>
+ <td> 0 (addresses are verified) </td>
+ <td>
+ If set to 1 then if a client IP address check fails, it is not an error.
+</td>
+ </tr>
+ <tr>
+ <td> key_file <i>"filename"</i> </td>
+ <td> "/etc/pki/libvirt/ private/serverkey.pem" </td>
+ <td>
+ Change the path used to find the server's private key.
+ If you set this to an empty string, then no private key is loaded.
+</td>
+ </tr>
+ <tr>
+ <td> cert_file <i>"filename"</i> </td>
+ <td> "/etc/pki/libvirt/ servercert.pem" </td>
+ <td>
+ Change the path used to find the server's certificate.
+ If you set this to an empty string, then no certificate is loaded.
+</td>
+ </tr>
+ <tr>
+ <td> ca_file <i>"filename"</i> </td>
+ <td> "/etc/pki/CA/cacert.pem" </td>
+ <td>
+ Change the path used to find the trusted CA certificate.
+ If you set this to an empty string, then no trusted CA certificate is loaded.
+</td>
+ </tr>
+ <tr>
+ <td> crl_file <i>"filename"</i> </td>
+ <td> (no CRL file is used) </td>
+ <td>
+ Change the path used to find the CA certificate revocation list (CRL) file.
+ If you set this to an empty string, then no CRL is loaded.
+</td>
+ </tr>
+ <tr>
+ <td> tls_allowed_dn_list ["DN1", "DN2"] </td>
+ <td> (none - DNs are not checked) </td>
+ <td>
+ <p>
+ Enable an access control list of client certificate Distinguished
+ Names (DNs) which can connect to the TLS port on this server.
+ </p>
+ <p>
+ The default is that DNs are not checked.
+ </p>
+ <p>
+ This list may contain wildcards such as <code>"C=GB,ST=London,L=London,O=Red Hat,CN=*"</code>
+ See the POSIX <code>fnmatch</code> function for the format
+ of the wildcards.
+ </p>
+ <p>
+ Note that if this is an empty list, <i>no client can connect</i>.
+ </p>
+ <p>
+ Note also that GnuTLS returns DNs without spaces
+ after commas between the fields (and this is what we check against),
+ but the <code>openssl x509</code> tool shows spaces.
+</p>
+ </td>
+ </tr>
+ <tr>
+ <td> tls_allowed_ip_list ["ip1", "ip2", "ip3"] </td>
+ <td> (none - clients can connect from anywhere) </td>
+ <td>
+ <p>
+ Enable an access control list of the IP addresses of clients
+ who can connect to the TLS or TCP ports on this server.
+ </p>
+ <p>
+ The default is that clients can connect from any IP address.
+ </p>
+ <p>
+ This list may contain wildcards such as <code>192.168.*</code>
+ See the POSIX <code>fnmatch</code> function for the format
+ of the wildcards.
+ </p>
+ <p>
+ Note that if this is an empty list, <i>no client can connect</i>.
+ </p>
+ </td>
+ </tr>
+ </table>
+ <h3>
+ <a name="Remote_IPv6" id="Remote_IPv6">IPv6 support</a>
+ </h3>
+ <p>
+The libvirtd service and libvirt remote client driver both use the
+<code>getaddrinfo()</code> functions for name resolution and are
+thus fully IPv6 enabled. ie, if a server has IPv6 address configured
+the daemon will listen for incoming connections on both IPv4 and IPv6
+protocols. If a client has an IPv6 address configured and the DNS
+address resolved for a service is reachable over IPv6, then an IPv6
+connection will be made, otherwise IPv4 will be used. In summary it
+should just 'do the right thing(tm)'.
+</p>
+ <h3>
+ <a name="Remote_limitations" id="Remote_limitations">Limitations</a>
+ </h3>
+ <ul>
+ <li> Remote storage: To be fully useful, particularly for
+creating new domains, it should be possible to enumerate
+and provision storage on the remote machine. This is currently
+in the design phase. </li>
+ <li> Migration: We expect libvirt will support migration,
+and obviously remote support is what makes migration worthwhile.
+This is also in the design phase. Issues <a href="https://www.redhat.com/mailman/listinfo/libvir-list" title="libvir-list mailing list">to discuss</a> include
+which path the migration data should follow (eg. client to
+client direct, or client to server to client) and security.
+</li>
+ <li> Fine-grained authentication: libvirt in general,
+but in particular the remote case should support more
+fine-grained authentication for operations, rather than
+just read-write/read-only as at present.
+</li>
+ </ul>
+ <p>
+Please come and discuss these issues and more on <a href="https://www.redhat.com/mailman/listinfo/libvir-list" title="libvir-list mailing list">the mailing list</a>.
+</p>
+ <h3>
+ <a name="Remote_implementation_notes" id="Remote_implementation_notes">Implementation notes</a>
+ </h3>
+ <p>
+The current implementation uses <a href="http://en.wikipedia.org/wiki/External_Data_Representation" title="External Data Representation">XDR</a>-encoded packets with a
+simple remote procedure call implementation which also supports
+asynchronous messaging and asynchronous and out-of-order replies,
+although these latter features are not used at the moment.
+</p>
+ <p>
+The implementation should be considered <b>strictly internal</b> to
+libvirt and <b>subject to change at any time without notice</b>. If
+you wish to talk to libvirtd, link to libvirt. If there is a problem
+that means you think you need to use the protocol directly, please
+first discuss this on <a href="https://www.redhat.com/mailman/listinfo/libvir-list" title="libvir-list mailing list">the mailing list</a>.
+</p>
+ <p>
+The messaging protocol is described in
+<code>qemud/remote_protocol.x</code>.
+</p>
+ <p>
+Authentication and encryption (for TLS) is done using <a href="http://www.gnu.org/software/gnutls/" title="GnuTLS project page">GnuTLS</a> and the RPC protocol is unaware of this layer.
+</p>
+ <p>
+Protocol messages are sent using a simple 32 bit length word (encoded
+XDR int) followed by the message header (XDR
+<code>remote_message_header</code>) followed by the message body. The
+length count includes the length word itself, and is measured in
+bytes. Maximum message size is <code>REMOTE_MESSAGE_MAX</code> and to
+avoid denial of services attacks on the XDR decoders strings are
+individually limited to <code>REMOTE_STRING_MAX</code> bytes. In the
+TLS case, messages may be split over TLS records, but a TLS record
+cannot contain parts of more than one message. In the common RPC case
+a single <code>REMOTE_CALL</code> message is sent from client to
+server, and the server then replies synchronously with a single
+<code>REMOTE_REPLY</code> message, but other forms of messaging are
+also possible.
+</p>
+ <p>
+The protocol contains support for multiple program types and protocol
+versioning, modelled after SunRPC.
+</p>
+ </body>
+</html>
<?xml version="1.0"?>
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
- <xsl:output method="xml" encoding="ISO-8859-1" indent="yes"
- doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
- doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"/>
+<xsl:stylesheet
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ xmlns:exsl="http://exslt.org/common"
+ exclude-result-prefixes="xsl exsl"
+ version="1.0">
- <xsl:variable name="href_base" select="''"/>
- <xsl:variable name="menu_name">Main Menu</xsl:variable>
-<!--
- - returns the filename associated to an ID in the original file
- -->
- <xsl:template name="filename">
- <xsl:param name="name" select="string(@href)"/>
- <xsl:choose>
- <xsl:when test="$name = '#Introducti'">
- <xsl:text>intro.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Documentat'">
- <xsl:text>docs.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Reporting'">
- <xsl:text>bugs.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#help'">
- <xsl:text>help.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Help'">
- <xsl:text>help.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Errors'">
- <xsl:text>errors.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Downloads'">
- <xsl:text>downloads.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#News'">
- <xsl:text>news.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Contributi'">
- <xsl:text>contribs.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Format'">
- <xsl:text>format.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#architecture'">
- <xsl:text>architecture.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Python'">
- <xsl:text>python.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#FAQ'">
- <xsl:text>FAQ.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Remote'">
- <xsl:text>remote.html</xsl:text>
- </xsl:when>
- <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 = '#ACL'">
- <xsl:text>auth.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Windows'">
- <xsl:text>windows.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Storage'">
- <xsl:text>storage.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = ''">
- <xsl:text>unknown.html</xsl:text>
- </xsl:when>
- <xsl:otherwise>
- <xsl:value-of select="$name"/>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
-<!--
- - The global title
- -->
- <xsl:variable name="globaltitle" select="string(/html/body/h1[1])"/>
-
-<!--
- the main menu box
- -->
- <xsl:template name="linkList">
- <div class="linkList">
- <div class="llinks">
- <h3 class="links"><span>main menu</span></h3>
- <ul>
- <li>Home</li>
- <xsl:for-each select="/html/body/h2">
- <xsl:variable name="filename">
- <xsl:call-template name="filename">
- <xsl:with-param name="name" select="concat('#', string(a[1]/@name))"/>
- </xsl:call-template>
- </xsl:variable>
- <xsl:if test="$filename != ''">
- <li>
- <xsl:element name="a">
- <xsl:attribute name="href">
- <xsl:value-of select="$filename"/>
- </xsl:attribute>
- <xsl:if test="$filename = 'docs.html'">
- <xsl:attribute name="style">font-weight:bold</xsl:attribute>
- </xsl:if>
- <xsl:value-of select="."/>
- </xsl:element>
- </li>
- </xsl:if>
- </xsl:for-each>
- <li><a href="{$href_base}html/index.html">API Menu</a></li>
- <li><a href="{$href_base}examples/index.html">C code examples</a></li>
- <li><a href="{$href_base}ChangeLog.html">Recent Changes</a></li>
-
- </ul>
- </div>
- <div class="llinks">
- <h3 class="links"><span>related links</span></h3>
- <ul>
- <li> <a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li>
- <li> <a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li>
- <li> <a href="http://virt-manager.et.redhat.com/">virt-manager</a></li>
- <li> <a href="http://libvirt.org/CIM/">CIM provider</a></li>
- <li> <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li>
- <li> <a href="http://libvirt.org/ocaml/">OCaml bindings</a></li>
- <li> <a href="http://libvirt.org/ruby/">Ruby bindings</a></li>
- <li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li>
- <li><form action="{$href_base}search.php" enctype="application/x-www-form-urlencoded" method="get">
- <input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" />
- </form></li>
- <li><a href="http://xmlsoft.org/"> <img src="{$href_base}Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li>
- </ul>
- <p class='credits'>Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p>
- </div>
- </div>
- </xsl:template>
- <xsl:template name="linkList2">
- <div class="linkList2">
- <div class="llinks2">
- <h3 class="links2"><span>main menu</span></h3>
- <ul>
- <li><a href="{$href_base}index.html">Home</a></li>
- <xsl:for-each select="/html/body/h2">
- <xsl:variable name="filename">
- <xsl:call-template name="filename">
- <xsl:with-param name="name" select="concat('#', string(a[1]/@name))"/>
- </xsl:call-template>
- </xsl:variable>
- <xsl:if test="$filename != ''">
- <li>
- <xsl:element name="a">
- <xsl:attribute name="href">
- <xsl:value-of select="$filename"/>
- </xsl:attribute>
- <xsl:if test="$filename = 'docs.html'">
- <xsl:attribute name="style">font-weight:bold</xsl:attribute>
- </xsl:if>
- <xsl:value-of select="."/>
- </xsl:element>
- </li>
- </xsl:if>
- </xsl:for-each>
- <li><a href="{$href_base}html/index.html">API Menu</a></li>
- <li><a href="{$href_base}examples/index.html">C code examples</a></li>
- <li><a href="{$href_base}ChangeLog.html">Recent Changes</a></li>
-
- </ul>
- </div>
- <div class="llinks2">
- <h3 class="links2"><span>related links</span></h3>
- <ul>
- <li> <a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li>
- <li> <a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li>
- <li> <a href="http://virt-manager.et.redhat.com/">virt-manager</a></li>
- <li> <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li>
- <li> <a href="http://libvirt.org/ocaml/">OCaml bindings</a></li>
- <li> <a href="http://libvirt.org/ruby/">Ruby bindings</a></li>
- <li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li>
- <li><form action="{$href_base}search.php" enctype="application/x-www-form-urlencoded" method="get">
- <input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" />
- </form></li>
- <li><a href="http://xmlsoft.org/"> <img src="{$href_base}Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li>
- </ul>
- <p class='credits'>Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p>
- </div>
- </div>
- </xsl:template>
-
-<!--
- the main menu box
- -->
- <xsl:template name="develtoc">
- <div class="left">
- <form action="{$href_base}search.php"
- enctype="application/x-www-form-urlencoded" method="get">
- <input name="query" type="text" size="20" value=""/>
- <input name="submit" type="submit" value="Search ..."/>
- </form>
- <div class="box">
- <h2 class="box_title">API menu</h2>
- </div>
- <p><a href="{$href_base}index.html">Main menu</a></p>
- <p><a href="{$href_base}/html/index.html">API menu</a></p>
- <p><a href="{$href_base}ChangeLog.html">ChangeLog</a></p>
- <div class="box">
- <h2 class="box_title">related links</h2>
- </div>
- <p><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></p>
- <p> <a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></p>
- <p> <a href="http://virt-manager.et.redhat.com/">virt-manager</a></p>
- <p> <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></p>
- <p> <a href="http://libvirt.org/ocaml/">OCaml bindings</a></p>
- <p> <a href="http://libvirt.org/ruby/">Ruby bindings</a></p>
- <p><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></p>
- <a href="http://xmlsoft.org/"><img src="{$href_base}Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo"/></a>
- </div>
- <div class="linkList2">
- <div class="llinks2">
- <h3 class="links2"><span>API menu</span></h3>
- <ul>
- <li><a href="{$href_base}index.html">Main menu</a></li>
- <li><a href="{$href_base}/html/index.html">API menu</a></li>
- <li><a href="{$href_base}ChangeLog.html">ChangeLog</a></li>
- </ul>
- </div>
- <div class="llinks2">
- <h3 class="links2"><span>related links</span></h3>
- <ul>
- <li> <a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li>
- <li> <a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li>
- <li> <a href="http://virt-manager.et.redhat.com/">virt-manager</a></li>
- <li> <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li>
- <li> <a href="http://libvirt.org/ocaml/">OCaml bindings</a></li>
- <li> <a href="http://libvirt.org/ruby/">Ruby bindings</a></li>
- <li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li>
- <li><form action="{$href_base}search.php" enctype="application/x-www-form-urlencoded" method="get">
- <input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" />
- </form></li>
- <li><a href="http://xmlsoft.org/"> <img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li>
- </ul>
- </div>
- </div>
- </xsl:template>
-
-<!--
- the menu box for developer's pages
- -->
-<!--
- the page title
- -->
-
- <xsl:template name="titlebox">
- <xsl:param name="title"/>
- <h1 class="style1"><xsl:value-of select="$title"/></h1>
- </xsl:template>
-
-<!--
- - Write the styles in the head
- -->
- <xsl:template name="style">
- <link rel="stylesheet" type="text/css" href="{$href_base}libvirt.css" />
- <link rel="SHORTCUT ICON" href="/32favicon.png" />
- </xsl:template>
+ <xsl:import href="page.xsl"/>
-<!--
- - The top section
- -->
- <xsl:template name="top">
- <div id="top">
- <img src="{$href_base}libvirtHeader.png" alt="Libvirt the virtualization API" />
- </div>
- </xsl:template>
-
-<!--
- - The top section for the main page
- -->
- <xsl:template name="topmain">
- <div id="topmain">
- <img src="{$href_base}libvirtLogo.png" alt="Libvirt the virtualization API" />
- </div>
- </xsl:template>
-
-<!--
- - The bottom section
- -->
- <xsl:template name="bottom">
- <div id="bottom">
- <p class="p1"></p>
- </div>
- </xsl:template>
-
-<!--
- - Handling of nodes in the body after an H2
- - Open a new file and dump all the siblings up to the next H2
- -->
- <xsl:template name="subfile">
- <xsl:param name="header" select="following-sibling::h2[1]"/>
- <xsl:variable name="filename">
- <xsl:call-template name="filename">
- <xsl:with-param name="name" select="concat('#', string($header/a[1]/@name))"/>
- </xsl:call-template>
- </xsl:variable>
- <xsl:variable name="title">
- <xsl:value-of select="$header"/>
- </xsl:variable>
- <xsl:document href="{$filename}" method="xml" encoding="ISO-8859-1"
- doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
- doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html>
- <head>
- <xsl:call-template name="style"/>
- <xsl:element name="title">
- <xsl:value-of select="$title"/>
- </xsl:element>
- </head>
- <body>
- <div id="container">
- <div id="intro">
- <div id="adjustments"/>
- <div id="pageHeader"/>
- <div id="content2">
- <xsl:call-template name="titlebox">
- <xsl:with-param name="title" select="$title"/>
- </xsl:call-template>
- <xsl:apply-templates mode="subfile" select="$header/following-sibling::*[preceding-sibling::h2[1] = $header and name() != 'h2' ]"/>
- </div>
- </div>
- <xsl:call-template name="linkList2"/>
- <xsl:call-template name="bottom"/>
- </div>
- </body>
- </html>
- </xsl:document>
- </xsl:template>
+ <xsl:output
+ method="xml"
+ encoding="ISO-8859-1"
+ indent="yes"
+ doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"/>
- <xsl:template mode="subcontent" match="@*|node()">
- <xsl:copy>
- <xsl:apply-templates mode="subcontent" select="@*|node()"/>
- </xsl:copy>
- </xsl:template>
-
- <xsl:template mode="content" match="@*|node()">
- <xsl:if test="name() != 'h1' and name() != 'h2'">
- <xsl:copy>
- <xsl:apply-templates mode="subcontent" select="@*|node()"/>
- </xsl:copy>
- </xsl:if>
- </xsl:template>
+ <xsl:variable name="href_base" select="''"/>
- <xsl:template mode="subfile" match="@*|node()">
- <xsl:copy>
- <xsl:apply-templates mode="content" select="@*|node()"/>
- </xsl:copy>
+ <xsl:template match="/">
+ <xsl:apply-templates select="." mode="page">
+ <xsl:with-param name="pagename" select="$pagename"/>
+ </xsl:apply-templates>
</xsl:template>
-<!--
- - Handling of the initial body and head HTML document
- -->
- <xsl:template match="body">
- <xsl:variable name="firsth2" select="./h2[1]"/>
- <body>
- <div id="container">
- <div id="intro">
- <div id="adjustments">
- <p class="p1"></p>
- </div>
- <div id="content">
- <xsl:apply-templates mode="content" select="($firsth2/preceding-sibling::*)"/>
- <xsl:for-each select="./h2">
- <xsl:call-template name="subfile">
- <xsl:with-param name="header" select="."/>
- </xsl:call-template>
- </xsl:for-each>
- </div>
- </div>
- <xsl:call-template name="linkList"/>
- <xsl:call-template name="bottom"/>
- </div>
- </body>
- </xsl:template>
- <xsl:template match="head">
- </xsl:template>
- <xsl:template match="html">
- <xsl:message>Generating the Web pages</xsl:message>
- <html>
- <head>
- <xsl:call-template name="style"/>
- <title>the virtualization API</title>
- </head>
- <xsl:apply-templates/>
- </html>
- </xsl:template>
</xsl:stylesheet>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from sitemap.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Sitemap</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Sitemap</h1>
+ <div id="sitemap">
+ <ul><li>
+ <a href="index.html">Home</a>
+ <span>Front page of the libvirt website</span>
+ </li><li>
+ <a href="news.html">News</a>
+ <span>Details of new features and bugs fixed in each release</span>
+ <ul><li>
+ <a href="ChangeLog.html">Changelog</a>
+ <span>Latest commit messages from the source repository </span>
+ </li></ul></li><li>
+ <a href="downloads.html">Downloads</a>
+ <span>Get the latest source releases, binary builds and get access to the source repository</span>
+ </li><li>
+ <a href="docs.html">Documentation</a>
+ <span>Information for users, administrators and developers</span>
+ <ul><li>
+ <a href="deployment.html">Deployment</a>
+ <span>Information about deploying and using libvirt</span>
+ <ul><li>
+ <a href="uri.html">URI format</a>
+ <span>The URI formats used for connecting to libvirt</span>
+ </li><li>
+ <a href="remote.html">Remote access</a>
+ <span>Enable remote access over TCP</span>
+ </li><li>
+ <a href="auth.html">Authentication</a>
+ <span>Configure authentication for the libvirt daemon</span>
+ </li><li>
+ <a href="windows.html">Windows port</a>
+ <span>Access the libvirt daemon from a native Windows client</span>
+ </li></ul></li><li>
+ <a href="intro.html">Architecture</a>
+ <span>Overview of the logical subsystems in the libvirt API</span>
+ <ul><li>
+ <a href="archdomain.html">Domains</a>
+ <span>Managing virtual machines</span>
+ </li><li>
+ <a href="archnetwork.html">Network</a>
+ <span>Providing isolated networks and NAT based network connectivity</span>
+ </li><li>
+ <a href="archstorage.html">Storage</a>
+ <span>Managing storage pools and volumes</span>
+ </li><li>
+ <a href="archnode.html">Node Devices</a>
+ <span>Enumerating host node devices</span>
+ </li></ul></li><li>
+ <a href="format.html">XML format</a>
+ <span>Description of the XML formats used in libvirt</span>
+ <ul><li>
+ <a href="formatdomain.html">Domains</a>
+ <span>The domain XML format</span>
+ </li><li>
+ <a href="formatnetwork.html">Networks</a>
+ <span>The virtual network XML format</span>
+ </li><li>
+ <a href="formatstorage.html">Storage</a>
+ <span>The storage pool and volume XML format</span>
+ </li><li>
+ <a href="formatcaps.html">Capabilities</a>
+ <span>The driver capabilities XML format</span>
+ </li><li>
+ <a href="formatnode.html">Node Devices</a>
+ <span>The host device XML format</span>
+ </li></ul></li><li>
+ <a href="drivers.html">Drivers</a>
+ <span>Hypervisor specific driver information</span>
+ <ul><li>
+ <a href="drvxen.html">Xen</a>
+ <span>Driver the Xen hypervisor</span>
+ </li><li>
+ <a href="drvqemu.html">QEMU / KVM</a>
+ <span>Driver for QEMU, KQEMU, KVM and Xenner</span>
+ </li><li>
+ <a href="drvlxc.html">Linux Container</a>
+ <span>Driver for the Linux native container API</span>
+ </li><li>
+ <a href="drvtest.html">Test</a>
+ <span>Psuedo-driver simulating APIs in memory for test suites</span>
+ </li><li>
+ <a href="drvremote.html">Remote</a>
+ <span>Driver providing secure remote to the libvirt APIs</span>
+ </li><li>
+ <a href="drvopenvz.html">OpenVZ</a>
+ <span>Driver for the OpenVZ container technology</span>
+ </li><li>
+ <a href="storage.html">Storage</a>
+ <span>Driver for the storage management APIs</span>
+ </li></ul></li><li>
+ <a href="html/index.html">API reference</a>
+ <span>Reference manual for the C public API</span>
+ <!-- This is the desired new style API breakdown
+ <ul>
+ <li>
+ <a href="apiconn.html">Connection</a>
+ <span>API reference for virConnectPtr objects</span>
+ </li>
+ <li>
+ <a href="apidomain.html">Domain</a>
+ <span>API reference for virDomainPtr objects</span>
+ </li>
+ <li>
+ <a href="apierror.html">Error</a>
+ <span>API reference for virErrorPtr objects</span>
+ </li>
+ <li>
+ <a href="apinetwork.html">Network</a>
+ <span>API reference for virNetworkPtr objects</span>
+ </li>
+ <li>
+ <a href="apistorage.html">Storage</a>
+ <span>API reference for virStoragePoolptr and virStorageVolPtr objects</span>
+ </li>
+ <li>
+ <a href="apinode.html">Node Device</a>
+ <span>API reference for virNodeDevicePtr objects</span>
+ </li>
+ </ul>
+ -->
+ <ul><li>
+ <a href="html/libvirt-libvirt.html">libvirt</a>
+ <span>core interfaces for the libvirt library</span>
+ </li><li>
+ <a href="html/libvirt-virterror.html">virterror</a>
+ <span>error handling interfaces for the libvirt library</span>
+ </li><li>
+ <a href="hvsupport.html">Driver support</a>
+ <span>matrix of API support per hypervisor per release</span>
+ </li></ul></li><li>
+ <a href="bindings.html">Language bindings</a>
+ <span>Bindings of the libvirt API for other languages</span>
+ <ul><li>
+ <a href="python.html">Python</a>
+ <span>overview of the python API bindings</span>
+ </li></ul></li></ul></li><li>
+ <a href="http://wiki.libvirt.org">Wiki</a>
+ <span>User contributed content</span>
+ </li><li>
+ <a href="FAQ.html">FAQ</a>
+ <span>Frequently asked questions</span>
+ </li><li>
+ <a href="bugs.html">Bug reports</a>
+ <span>How and where to report bugs and request features</span>
+ </li><li>
+ <a href="contact.html">Contact</a>
+ <span>How to contact the developers via email and IRC</span>
+ </li><li>
+ <a href="relatedlinks.html">Related Links</a>
+ <span>Miscellaneous links of interest related to libvirt</span>
+ <ul><li>
+ <a href="apps.html">Applications</a>
+ <span>Overview of applications using the libvirt APIs</span>
+ </li></ul></li><li>
+ <a href="sitemap.html">Sitemap</a>
+ <span>Overview of all content on the website</span>
+ </li></ul></div>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <span class="active">Sitemap</span>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<html>
+ <body>
+ <h1>Sitemap</h1>
+
+ <div id="sitemap">
+ <ul>
+ <li>
+ <a href="index.html">Home</a>
+ <span>Front page of the libvirt website</span>
+ </li>
+ <li>
+ <a href="news.html">News</a>
+ <span>Details of new features and bugs fixed in each release</span>
+ <ul>
+ <li>
+ <a href="ChangeLog.html">Changelog</a>
+ <span>Latest commit messages from the source repository </span>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="downloads.html">Downloads</a>
+ <span>Get the latest source releases, binary builds and get access to the source repository</span>
+ </li>
+ <li>
+ <a href="docs.html">Documentation</a>
+ <span>Information for users, administrators and developers</span>
+ <ul>
+ <li>
+ <a href="deployment.html">Deployment</a>
+ <span>Information about deploying and using libvirt</span>
+ <ul>
+ <li>
+ <a href="uri.html">URI format</a>
+ <span>The URI formats used for connecting to libvirt</span>
+ </li>
+ <li>
+ <a href="remote.html">Remote access</a>
+ <span>Enable remote access over TCP</span>
+ </li>
+ <li>
+ <a href="auth.html">Authentication</a>
+ <span>Configure authentication for the libvirt daemon</span>
+ </li>
+ <li>
+ <a href="windows.html">Windows port</a>
+ <span>Access the libvirt daemon from a native Windows client</span>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="intro.html">Architecture</a>
+ <span>Overview of the logical subsystems in the libvirt API</span>
+ <ul>
+ <li>
+ <a href="archdomain.html">Domains</a>
+ <span>Managing virtual machines</span>
+ </li>
+ <li>
+ <a href="archnetwork.html">Network</a>
+ <span>Providing isolated networks and NAT based network connectivity</span>
+ </li>
+ <li>
+ <a href="archstorage.html">Storage</a>
+ <span>Managing storage pools and volumes</span>
+ </li>
+ <li>
+ <a href="archnode.html">Node Devices</a>
+ <span>Enumerating host node devices</span>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="format.html">XML format</a>
+ <span>Description of the XML formats used in libvirt</span>
+ <ul>
+ <li>
+ <a href="formatdomain.html">Domains</a>
+ <span>The domain XML format</span>
+ </li>
+ <li>
+ <a href="formatnetwork.html">Networks</a>
+ <span>The virtual network XML format</span>
+ </li>
+ <li>
+ <a href="formatstorage.html">Storage</a>
+ <span>The storage pool and volume XML format</span>
+ </li>
+ <li>
+ <a href="formatcaps.html">Capabilities</a>
+ <span>The driver capabilities XML format</span>
+ </li>
+ <li>
+ <a href="formatnode.html">Node Devices</a>
+ <span>The host device XML format</span>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="drivers.html">Drivers</a>
+ <span>Hypervisor specific driver information</span>
+ <ul>
+ <li>
+ <a href="drvxen.html">Xen</a>
+ <span>Driver the Xen hypervisor</span>
+ </li>
+ <li>
+ <a href="drvqemu.html">QEMU / KVM</a>
+ <span>Driver for QEMU, KQEMU, KVM and Xenner</span>
+ </li>
+ <li>
+ <a href="drvlxc.html">Linux Container</a>
+ <span>Driver for the Linux native container API</span>
+ </li>
+ <li>
+ <a href="drvtest.html">Test</a>
+ <span>Psuedo-driver simulating APIs in memory for test suites</span>
+ </li>
+ <li>
+ <a href="drvremote.html">Remote</a>
+ <span>Driver providing secure remote to the libvirt APIs</span>
+ </li>
+ <li>
+ <a href="drvopenvz.html">OpenVZ</a>
+ <span>Driver for the OpenVZ container technology</span>
+ </li>
+ <li>
+ <a href="storage.html">Storage</a>
+ <span>Driver for the storage management APIs</span>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="html/index.html">API reference</a>
+ <span>Reference manual for the C public API</span>
+ <!-- This is the desired new style API breakdown
+ <ul>
+ <li>
+ <a href="apiconn.html">Connection</a>
+ <span>API reference for virConnectPtr objects</span>
+ </li>
+ <li>
+ <a href="apidomain.html">Domain</a>
+ <span>API reference for virDomainPtr objects</span>
+ </li>
+ <li>
+ <a href="apierror.html">Error</a>
+ <span>API reference for virErrorPtr objects</span>
+ </li>
+ <li>
+ <a href="apinetwork.html">Network</a>
+ <span>API reference for virNetworkPtr objects</span>
+ </li>
+ <li>
+ <a href="apistorage.html">Storage</a>
+ <span>API reference for virStoragePoolptr and virStorageVolPtr objects</span>
+ </li>
+ <li>
+ <a href="apinode.html">Node Device</a>
+ <span>API reference for virNodeDevicePtr objects</span>
+ </li>
+ </ul>
+ -->
+ <ul>
+ <li>
+ <a href="html/libvirt-libvirt.html">libvirt</a>
+ <span>core interfaces for the libvirt library</span>
+ </li>
+ <li>
+ <a href="html/libvirt-virterror.html">virterror</a>
+ <span>error handling interfaces for the libvirt library</span>
+ </li>
+ <li>
+ <a href="hvsupport.html">Driver support</a>
+ <span>matrix of API support per hypervisor per release</span>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="bindings.html">Language bindings</a>
+ <span>Bindings of the libvirt API for other languages</span>
+ <ul>
+ <li>
+ <a href="python.html">Python</a>
+ <span>overview of the python API bindings</span>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="http://wiki.libvirt.org">Wiki</a>
+ <span>User contributed content</span>
+ </li>
+ <li>
+ <a href="FAQ.html">FAQ</a>
+ <span>Frequently asked questions</span>
+ </li>
+ <li>
+ <a href="bugs.html">Bug reports</a>
+ <span>How and where to report bugs and request features</span>
+ </li>
+ <li>
+ <a href="contact.html">Contact</a>
+ <span>How to contact the developers via email and IRC</span>
+ </li>
+ <li>
+ <a href="relatedlinks.html">Related Links</a>
+ <span>Miscellaneous links of interest related to libvirt</span>
+ <ul>
+ <li>
+ <a href="apps.html">Applications</a>
+ <span>Overview of applications using the libvirt APIs</span>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="sitemap.html">Sitemap</a>
+ <span>Overview of all content on the website</span>
+ </li>
+ </ul>
+ </div>
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Storage Management</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Storage Management</h1><p>
-This page describes the storage management capabilities in
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from storage.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Storage Management</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Storage Management</h1>
+ <p>
+This page describes the backends for the storage management capabilities in
libvirt.
-</p><ul><li><a href="#StorageCore">Core concepts</a></li>
-<li><a href="#StoragePool">Storage pool XML</a>
- <ul><li><a href="#StoragePoolFirst">First level elements</a></li>
- <li><a href="#StoragePoolSource">Source elements</a></li>
- <li><a href="#StoragePoolTarget">Target elements</a></li>
- <li><a href="#StoragePoolExtents">Device extents</a></li>
- </ul></li>
-<li><a href="#StorageVol">Storage volume XML</a>
- <ul><li><a href="#StorageVolFirst">First level elements</a></li>
- <li><a href="#StorageVolSource">Source elements</a></li>
- <li><a href="#StorageVolTarget">Target elements</a></li>
- </ul></li>
-<li><a href="#StorageBackend">Storage backend drivers</a>
- <ul><li><a href="#StorageBackendDir">Directory backend</a></li>
- <li><a href="#StorageBackendFS">Local filesystem backend</a></li>
- <li><a href="#StorageBackendNetFS">Network filesystem backend</a></li>
- <li><a href="#StorageBackendLogical">Logical backend</a></li>
- <li><a href="#StorageBackendDisk">Disk backend</a></li>
- <li><a href="#StorageBackendISCSI">iSCSI backend</a></li>
-</ul><h3><a name="StorageCore" id="StorageCore">Core concepts</a></h3>
-
-<p>
-The storage management APIs are based around 2 core concepts
-</p>
-
-<ol><li><strong>Volume</strong> - a single storage volume which can
-be assigned to a guest, or used for creating further pools. A
-volume is either a block device, a raw file, or a special format
-file.</li>
-<li><strong>Pool</strong> - provides a means for taking a chunk
-of storage and carving it up into volumes. A pool can be used to
-manage things such as a physical disk, a NFS server, a iSCSI target,
-a host adapter, an LVM group.</li>
-</ol><p>
-These two concepts are mapped through to two libvirt objects, a
-<code>virStorageVolPtr</code> and a <code>virStoragePoolPtr</code>,
-each with a collection of APIs for their management.
-</p>
-
-
-<h3><a name="StoragePool" id="StoragePool">Storage pool XML</a></h3>
-
-<p>
-Although all storage pool backends share the same public APIs and
-XML format, they have varying levels of capabilities. Some may
-allow creation of volumes, others may only allow use of pre-existing
-volumes. Some may have constraints on volume size, or placement.
-</p>
-
-<p>The is the top level tag for a storage pool document is 'pool'. It has
-a single attribute <code>type</code>, which is one of <code>dir</code>,
-<code>fs</code>,<code>netfs</code>,<code>disk</code>,<code>iscsi</code>,
-<code>logical</code>. This corresponds to the storage backend drivers
-listed further along in this document.
-</p>
-
-
-<h4><a name="StoragePoolFirst" id="StoragePoolFirst">First level elements</a></h4>
-
-<dl><dt>name</dt>
-<dd>Providing a name for the pool which is unique to the host.
-This is mandatory when defining a pool</dd>
-
-<dt>uuid</dt>
-<dd>Providing an identifier for the pool which is globally unique.
-This is optional when defining a pool, a UUID will be generated if
-omitted</dd>
-
-<dt>allocation</dt>
-<dd>Providing the total storage allocation for the pool. This may
-be larger than the sum of the allocation of all volumes due to
-metadata overhead. This value is in bytes. This is not applicable
-when creating a pool.</dd>
-
-<dt>capacity</dt>
-<dd>Providing the total storage capacity for the pool. Due to
-underlying device constraints it may not be possible to use the
-full capacity for storage volumes. This value is in bytes. This
-is not applicable when creating a pool.</dd>
-
-<dt>available</dt>
-<dd>Providing the free space available for allocating new volumes
-in the pool. Due to underlying device constraints it may not be
-possible to allocate the entire free space to a single volume.
-This value is in bytes. This is not applicable when creating a
-pool.</dd>
-
-<dt>source</dt>
-<dd>Provides information about the source of the pool, such as
-the underlying host devices, or remote server</dd>
-
-<dt>target</dt>
-<dd>Provides information about the representation of the pool
-on the local host.</dd>
-</dl><h4><a name="StoragePoolSource" id="StoragePoolSource">Source elements</a></h4>
-
-<dl><dt>device</dt>
-<dd>Provides the source for pools backed by physical devices.
-May be repeated multiple times depending on backend driver. Contains
-a single attribute <code>path</code> which is the fully qualified
-path to the block device node.</dd>
-<dt>directory</dt>
-<dd>Provides the source for pools backed by directories. May
-only occur once. Contains a single attribute <code>path</code>
-which is the fully qualified path to the block device node.</dd>
-<dt>host</dt>
-<dd>Provides the source for pools backed by storage from a
-remote server. Will be used in combination with a <code>directory</code>
-or <code>device</code> element. Contains an attribute <code>name<code>
-which is the hostname or IP address of the server. May optionally
-contain a <code>port</code> attribute for the protocol specific
-port number.</code></code></dd>
-<dt>format</dt>
-<dd>Provides information about the format of the pool. This
-contains a single attribute <code>type</code> whose value is
-backend specific. This is typically used to indicate filesystem
-type, or network filesystem type, or partition table type, or
-LVM metadata type. All drivers are required to have a default
-value for this, so it is optional.</dd>
-</dl><h4><a name="StoragePoolTarget" id="StoragePoolTarget">Target elements</a></h4>
-
-<dl><dt>path</dt>
-<dd>Provides the location at which the pool will be mapped into
-the local filesystem namespace. For a filesystem/directory based
-pool it will be the name of the directory in which volumes will
-be created. For device based pools it will be the name of the directory in which
-devices nodes exist. For the latter <code>/dev/</code> may seem
-like the logical choice, however, devices nodes there are not
-guaranteed stable across reboots, since they are allocated on
-demand. It is preferable to use a stable location such as one
-of the <code>/dev/disk/by-{path,id,uuid,label</code> locations.
-</dd>
-<dt>permissions<dt>
-</dt></dt><dd>Provides information about the default permissions to use
-when creating volumes. This is currently only useful for directory
-or filesystem based pools, where the volumes allocated are simple
-files. For pools where the volumes are device nodes, the hotplug
-scripts determine permissions. It contains 4 child elements. The
-<code>mode</code> element contains the octal permission set. The
-<code>owner</code> element contains the numeric user ID. The <code>group</code>
-element contains the numeric group ID. The <code>label</code> element
-contains the MAC (eg SELinux) label string.
-</dd>
-</dl><h4><a name="StoragePoolExtents" id="StoragePoolExtents">Device extents</a></h4>
-
-<p>
-If a storage pool exposes information about its underlying
-placement / allocation scheme, the <code>device</code> element
-within the <code>source</code> element may contain information
-about its available extents. Some pools have a constraint that
-a volume must be allocated entirely within a single constraint
-(eg disk partition pools). Thus the extent information allows an
-application to determine the maximum possible size for a new
-volume
-</p>
-
-<p>
-For storage pools supporting extent information, within each
-<code>device</code> element there will be zero or more <code>freeExtent</code>
-elements. Each of these elements contains two attributes, <code>start</code>
-and <code>end</code> which provide the boundaries of the extent on the
-device, measured in bytes.
-</p>
-
-<h3><a name="StorageVol" id="StorageVol">Storage volume XML</a></h3>
-
-<p>
-A storage volume will be either a file or a device node.
-</p>
-
-<h4><a name="StorageVolFirst" id="StorageVolFirst">First level elements</a></h4>
-
-<dl><dt>name</dt>
-<dd>Providing a name for the pool which is unique to the host.
-This is mandatory when defining a pool</dd>
-
-<dt>uuid</dt>
-<dd>Providing an identifier for the pool which is globally unique.
-This is optional when defining a pool, a UUID will be generated if
-omitted</dd>
-
-<dt>allocation</dt>
-<dd>Providing the total storage allocation for the volume. This
-may be smaller than the logical capacity if the volume is sparsely
-allocated. It may also be larger than the logical capacity if the
-volume has substantial metadata overhead. This value is in bytes.
-If omitted when creating a volume, the volume will be fully
-allocated at time of creation. If set to a value smaller than the
-capacity, the pool has the <strong>option</strong> of deciding
-to sparsely allocate a volume. It does not have to honour requests
-for sparse allocation though.</dd>
-
-<dt>capacity</dt>
-<dd>Providing the logical capacity for the volume. This value is
-in bytes. This is compulsory when creating a volume</dd>
-
-<dt>source</dt>
-<dd>Provides information about the underlying storage allocation
-of the volume. This may not be available for some pool types.</dd>
-
-<dt>target</dt>
-<dd>Provides information about the representation of the volume
-on the local host.</dd>
-</dl><h4><a name="StorageVolTarget" id="StorageVolTarget">Target elements</a></h4>
-
-<dl><dt>path</dt>
-<dd>Provides the location at which the pool will be mapped into
-the local filesystem namespace. For a filesystem/directory based
-pool it will be the name of the directory in which volumes will
-be created. For device based pools it will be the name of the directory in which
-devices nodes exist. For the latter <code>/dev/</code> may seem
-like the logical choice, however, devices nodes there are not
-guaranteed stable across reboots, since they are allocated on
-demand. It is preferrable to use a stable location such as one
-of the <code>/dev/disk/by-{path,id,uuid,label</code> locations.
-</dd>
-<dt>format</dt>
-<dd>Provides information about the pool specific volume format.
-For disk pools it will provide the partition type. For filesystem
-or directory pools it will provide the file format type, eg cow,
-qcow, vmdk, raw. If omitted when creating a volume, the pool's
-default format will be used. The actual format is specified via
-the <code>type</code>. Consult the pool-specific docs for the
-list of valid values.</dd>
-<dt>permissions<dt>
-</dt></dt><dd>Provides information about the default permissions to use
-when creating volumes. This is currently only useful for directory
-or filesystem based pools, where the volumes allocated are simple
-files. For pools where the volumes are device nodes, the hotplug
-scripts determine permissions. It contains 4 child elements. The
-<code>mode</code> element contains the octal permission set. The
-<code>owner</code> element contains the numeric user ID. The <code>group</code>
-element contains the numeric group ID. The <code>label</code> element
-contains the MAC (eg SELinux) label string.
-</dd>
-</dl><h3><a name="StorageBackend" id="StorageBackend">Storage backend drivers</a></h3>
-
-<p>
-This section illustrates the capabilities / format for each of
-the different backend storage pool drivers
-</p>
-
-<h4><a name="StorageBackendDir" id="StorageBackendDir">Directory pool</a></h4>
-
-<p>
-A pool with a type of <code>dir</code> provides the means to manage
-files within a directory. The files can be fully allocated raw files,
-sparsely allocated raw files, or one of the special disk formats
-such as <code>qcow</code>,<code>qcow2</code>,<code>vmdk</code>,
-<code>cow</code>, etc as supported by the <code>qemu-img</code>
-program. If the directory does not exist at the time the pool is
-defined, the <code>build</code> operation can be used to create it.
-</p>
-
-<h5>Example pool input definition</h5>
-
-<pre>
-<pool type="dir">
- <name>virtimages</name>
- <target>
- <path>/var/lib/virt/images</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The directory pool does not use the pool format type element.
-</p>
-
-<h5>Valid volume format types</h5>
-
-<p>
-One of the following options:
-</p>
-
-<ul><li><code>raw</code>: a plain file</li>
-<li><code>bochs</code>: Bochs disk image format</li>
-<li><code>cloop</code>: compressed loopback disk image format</li>
-<li><code>cow</code>: User Mode Linux disk image format</li>
-<li><code>dmg</code>: Mac disk image format</li>
-<li><code>iso</code>: CDROM disk image format</li>
-<li><code>qcow</code>: QEMU v1 disk image format</li>
-<li><code>qcow2</code>: QEMU v2 disk image format</li>
-<li><code>vmdk</code>: VMWare disk image format</li>
-<li><code>vpc</code>: VirtualPC disk image format</li>
-</ul><p>
-When listing existing volumes all these formats are supported
-natively. When creating new volumes, only a subset may be
-available. The <code>raw</code> type is guaranteed always
-available. The <code>qcow2</code> type can be created if
-either <code>qemu-img</code> or <code>qcow-create</code> tools
-are present. The others are dependent on support of the
-<code>qemu-img</code> tool.
-
-</p><h4><a name="StorageBackendFS" id="StorageBackendFS">Filesystem pool</a></h4>
-
-<p>
-This is a variant of the directory pool. Instead of creating a
-directory on an existing mounted filesystem though, it expects
-a source block device to be named. This block device will be
-mounted and files managed in the directory of its mount point.
-It will default to allowing the kernel to automatically discover
-the filesystem type, though it can be specified manually if
-required.
-</p>
-
-<h5>Example pool input</h5>
-
-<pre>
-<pool type="fs">
- <name>virtimages</name>
- <source>
- <device path="/dev/VolGroup00/VirtImages"/>
- </source>
- <target>
- <path>/var/lib/virt/images</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The filesystem pool supports the following formats:
-</p>
-
-<ul><li><code>auto</code> - automatically determine format</li>
-<li><code>ext2</code></li>
-<li><code>ext3</code></li>
-<li><code>ext4</code></li>
-<li><code>ufs</code></li>
-<li><code>iso9660</code></li>
-<li><code>udf</code></li>
-<li><code>gfs</code></li>
-<li><code>gfs2</code></li>
-<li><code>vfat</code></li>
-<li><code>hfs+</code></li>
-<li><code>xfs</code></li>
-</ul><h5>Valid volume format types</h5>
-
-<p>
-The valid volume types are the same as for the <code>directory</code>
-pool type.
-</p>
-
-<h4><a name="StorageBackendNetFS" id="StorageBackendNetFS">Network filesystem pool</a></h4>
-
-<p>
-This is a variant of the filesystem pool. Instead of requiring
-a local block device as the source, it requires the name of a
-host and path of an exported directory. It will mount this network
-filesystem and manage files within the directory of its mount
-point. It will default to using NFS as the protocol.
-</p>
-
-<h5>Example pool input</h5>
-
-<pre>
-<pool type="netfs">
- <name>virtimages</name>
- <source>
- <host name="nfs.example.com"/>
- <dir path="/var/lib/virt/images"/>
- </source>
- <target>
- <path>/var/lib/virt/images</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The network filesystem pool supports the following formats:
-</p>
-
-<ul><li><code>auto</code> - automatically determine format</li>
-<li><code>nfs</code></li>
-</ul><h5>Valid volume format types</h5>
-
-<p>
-The valid volume types are the same as for the <code>directory</code>
-pool type.
-</p>
-
-<h4><a name="StorageBackendLogical" id="StorageBackendLogical">Logical volume pools</a></h4>
-
-<p>
-This provides a pool based on an LVM volume group. For a
-pre-defined LVM volume group, simply providing the group
-name is sufficient, while to build a new group requires
-providing a list of source devices to serve as physical
-volumes. Volumes will be allocated by carving out chunks
-of storage from the volume group.
-</p>
-
-<h5>Example pool input</h5>
-
-<pre>
-<pool type="logical">
- <name>HostVG</name>
- <source>
- <device path="/dev/sda1"/>
- <device path="/dev/sdb1"/>
- <device path="/dev/sdc1"/>
- </source>
- <target>
- <path>/dev/HostVG</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The logical volume pool does not use the pool format type element.
</p>
-
-<h5>Valid volume format types</h5>
-
-<p>
-The logical volume pool does not use the volume format type element.
-</p>
-
-
-<h4><a name="StorageBackendDisk" id="StorageBackendDisk">Disk volume pools</a></h4>
-
-<p>
-This provides a pool based on a physical disk. Volumes are created
-by adding partitions to the disk. Disk pools are have constraints
-on the size and placement of volumes. The 'free extents'
-information will detail the regions which are available for creating
-new volumes. A volume cannot span across 2 different free extents.
-</p>
-
-<h5>Example pool input</h5>
-
-<pre>
-<pool type="disk">
- <name>sda</name>
- <source>
- <device path='/dev/sda'/>
- </source>
- <target>
- <path>/dev</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The disk volume pool accepts the following pool format types, representing
-the common partition table types:
-</p>
-
-<ul><li><code>dos</code></li>
-<li><code>dvh</code></li>
-<li><code>gpt</code></li>
-<li><code>mac</code></li>
-<li><code>bsd</code></li>
-<li><code>pc98</code></li>
-<li><code>sun</code></li>
-</ul><p>
-The <code>dos</code> or <code>gpt</code> formats are recommended for
-best portability - the latter is needed for disks larger than 2TB.
-</p>
-
-<h5>Valid volume format types</h5>
-
-<p>
-The disk volume pool accepts the following volume format types, representing
-the common partition entry types:
-</p>
-
-<ul><li><code>none</code></li>
-<li><code>linux</code></li>
-<li><code>fat16</code></li>
-<li><code>fat32</code></li>
-<li><code>linux-swap</code></li>
-<li><code>linux-lvm</code></li>
-<li><code>linux-raid</code></li>
-<li><code>extended</code></li>
-</ul><h4><a name="StorageBackendISCSI" id="StorageBackendISCSI">iSCSI volume pools</a></h4>
-
-<p>
-This provides a pool based on an iSCSI target. Volumes must be
-pre-allocated on the iSCSI server, and cannot be created via
-the libvirt APIs. Since /dev/XXX names may change each time libvirt
-logs into the iSCSI target, it is recommended to configure the pool
-to use <code>/dev/disk/by-path</code> or <code>/dev/disk/by-id</code>
-for the target path. These provide persistent stable naming for LUNs
-</p>
-
-<h5>Example pool input</h5>
-
-<pre>
-<pool type="iscsi">
- <name>virtimages</name>
- <source>
- <host name="iscsi.example.com"/>
- <device path="demo-target"/>
- </source>
- <target>
- <path>/dev/disk/by-path</path>
- </target>
-</pool>
-</pre>
-
-<h5>Valid pool format types</h5>
-
-<p>
-The logical volume pool does not use the pool format type element.
-</p>
-
-<h5>Valid volume format types</h5>
-
-<p>
-The logical volume pool does not use the volume format type element.
-</p>
-
-
-
-</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+ <ul><li>
+ <a href="#StorageBackendDir">Directory backend</a>
+ </li><li>
+ <a href="#StorageBackendFS">Local filesystem backend</a>
+ </li><li>
+ <a href="#StorageBackendNetFS">Network filesystem backend</a>
+ </li><li>
+ <a href="#StorageBackendLogical">Logical backend</a>
+ </li><li>
+ <a href="#StorageBackendDisk">Disk backend</a>
+ </li><li>
+ <a href="#StorageBackendISCSI">iSCSI backend</a>
+ </li></ul>
+ <h2>
+ <a name="StorageBackendDir" id="StorageBackendDir">Directory pool</a>
+ </h2>
+ <p>
+ A pool with a type of <code>dir</code> provides the means to manage
+ files within a directory. The files can be fully allocated raw files,
+ sparsely allocated raw files, or one of the special disk formats
+ such as <code>qcow</code>,<code>qcow2</code>,<code>vmdk</code>,
+ <code>cow</code>, etc as supported by the <code>qemu-img</code>
+ program. If the directory does not exist at the time the pool is
+ defined, the <code>build</code> operation can be used to create it.
+ </p>
+ <h3>Example pool input definition</h3>
+ <pre>
+ <pool type="dir">
+ <name>virtimages</name>
+ <target>
+ <path>/var/lib/virt/images</path>
+ </target>
+ </pool>
+ </pre>
+ <h3>Valid pool format types</h3>
+ <p>
+ The directory pool does not use the pool format type element.
+ </p>
+ <h3>Valid volume format types</h3>
+ <p>
+ One of the following options:
+ </p>
+ <ul><li><code>raw</code>: a plain file</li><li><code>bochs</code>: Bochs disk image format</li><li><code>cloop</code>: compressed loopback disk image format</li><li><code>cow</code>: User Mode Linux disk image format</li><li><code>dmg</code>: Mac disk image format</li><li><code>iso</code>: CDROM disk image format</li><li><code>qcow</code>: QEMU v1 disk image format</li><li><code>qcow2</code>: QEMU v2 disk image format</li><li><code>vmdk</code>: VMWare disk image format</li><li><code>vpc</code>: VirtualPC disk image format</li></ul>
+ <p>
+ When listing existing volumes all these formats are supported
+ natively. When creating new volumes, only a subset may be
+ available. The <code>raw</code> type is guaranteed always
+ available. The <code>qcow2</code> type can be created if
+ either <code>qemu-img</code> or <code>qcow-create</code> tools
+ are present. The others are dependent on support of the
+ <code>qemu-img</code> tool.
+
+ </p>
+ <h2>
+ <a name="StorageBackendFS" id="StorageBackendFS">Filesystem pool</a>
+ </h2>
+ <p>
+ This is a variant of the directory pool. Instead of creating a
+ directory on an existing mounted filesystem though, it expects
+ a source block device to be named. This block device will be
+ mounted and files managed in the directory of its mount point.
+ It will default to allowing the kernel to automatically discover
+ the filesystem type, though it can be specified manually if
+ required.
+ </p>
+ <h3>Example pool input</h3>
+ <pre>
+ <pool type="fs">
+ <name>virtimages</name>
+ <source>
+ <device path="/dev/VolGroup00/VirtImages"/>
+ </source>
+ <target>
+ <path>/var/lib/virt/images</path>
+ </target>
+ </pool>
+ </pre>
+ <h3>Valid pool format types</h3>
+ <p>
+ The filesystem pool supports the following formats:
+ </p>
+ <ul><li><code>auto</code> - automatically determine format</li><li>
+ <code>ext2</code>
+ </li><li>
+ <code>ext3</code>
+ </li><li>
+ <code>ext4</code>
+ </li><li>
+ <code>ufs</code>
+ </li><li>
+ <code>iso9660</code>
+ </li><li>
+ <code>udf</code>
+ </li><li>
+ <code>gfs</code>
+ </li><li>
+ <code>gfs2</code>
+ </li><li>
+ <code>vfat</code>
+ </li><li>
+ <code>hfs+</code>
+ </li><li>
+ <code>xfs</code>
+ </li></ul>
+ <h3>Valid volume format types</h3>
+ <p>
+ The valid volume types are the same as for the <code>directory</code>
+ pool type.
+ </p>
+ <h2>
+ <a name="StorageBackendNetFS" id="StorageBackendNetFS">Network filesystem pool</a>
+ </h2>
+ <p>
+ This is a variant of the filesystem pool. Instead of requiring
+ a local block device as the source, it requires the name of a
+ host and path of an exported directory. It will mount this network
+ filesystem and manage files within the directory of its mount
+ point. It will default to using NFS as the protocol.
+ </p>
+ <h3>Example pool input</h3>
+ <pre>
+ <pool type="netfs">
+ <name>virtimages</name>
+ <source>
+ <host name="nfs.example.com"/>
+ <dir path="/var/lib/virt/images"/>
+ </source>
+ <target>
+ <path>/var/lib/virt/images</path>
+ </target>
+ </pool>
+ </pre>
+ <h3>Valid pool format types</h3>
+ <p>
+ The network filesystem pool supports the following formats:
+ </p>
+ <ul><li><code>auto</code> - automatically determine format</li><li>
+ <code>nfs</code>
+ </li></ul>
+ <h3>Valid volume format types</h3>
+ <p>
+ The valid volume types are the same as for the <code>directory</code>
+ pool type.
+ </p>
+ <h2>
+ <a name="StorageBackendLogical" id="StorageBackendLogical">Logical volume pools</a>
+ </h2>
+ <p>
+ This provides a pool based on an LVM volume group. For a
+ pre-defined LVM volume group, simply providing the group
+ name is sufficient, while to build a new group requires
+ providing a list of source devices to serve as physical
+ volumes. Volumes will be allocated by carving out chunks
+ of storage from the volume group.
+ </p>
+ <h3>Example pool input</h3>
+ <pre>
+ <pool type="logical">
+ <name>HostVG</name>
+ <source>
+ <device path="/dev/sda1"/>
+ <device path="/dev/sdb1"/>
+ <device path="/dev/sdc1"/>
+ </source>
+ <target>
+ <path>/dev/HostVG</path>
+ </target>
+ </pool>
+ </pre>
+ <h3>Valid pool format types</h3>
+ <p>
+ The logical volume pool does not use the pool format type element.
+ </p>
+ <h3>Valid volume format types</h3>
+ <p>
+ The logical volume pool does not use the volume format type element.
+ </p>
+ <h2>
+ <a name="StorageBackendDisk" id="StorageBackendDisk">Disk volume pools</a>
+ </h2>
+ <p>
+ This provides a pool based on a physical disk. Volumes are created
+ by adding partitions to the disk. Disk pools are have constraints
+ on the size and placement of volumes. The 'free extents'
+ information will detail the regions which are available for creating
+ new volumes. A volume cannot span across 2 different free extents.
+ </p>
+ <h3>Example pool input</h3>
+ <pre>
+ <pool type="disk">
+ <name>sda</name>
+ <source>
+ <device path='/dev/sda'/>
+ </source>
+ <target>
+ <path>/dev</path>
+ </target>
+ </pool>
+ </pre>
+ <h3>Valid pool format types</h3>
+ <p>
+ The disk volume pool accepts the following pool format types, representing
+ the common partition table types:
+ </p>
+ <ul><li>
+ <code>dos</code>
+ </li><li>
+ <code>dvh</code>
+ </li><li>
+ <code>gpt</code>
+ </li><li>
+ <code>mac</code>
+ </li><li>
+ <code>bsd</code>
+ </li><li>
+ <code>pc98</code>
+ </li><li>
+ <code>sun</code>
+ </li></ul>
+ <p>
+ The <code>dos</code> or <code>gpt</code> formats are recommended for
+ best portability - the latter is needed for disks larger than 2TB.
+ </p>
+ <h3>Valid volume format types</h3>
+ <p>
+ The disk volume pool accepts the following volume format types, representing
+ the common partition entry types:
+ </p>
+ <ul><li>
+ <code>none</code>
+ </li><li>
+ <code>linux</code>
+ </li><li>
+ <code>fat16</code>
+ </li><li>
+ <code>fat32</code>
+ </li><li>
+ <code>linux-swap</code>
+ </li><li>
+ <code>linux-lvm</code>
+ </li><li>
+ <code>linux-raid</code>
+ </li><li>
+ <code>extended</code>
+ </li></ul>
+ <h2>
+ <a name="StorageBackendISCSI" id="StorageBackendISCSI">iSCSI volume pools</a>
+ </h2>
+ <p>
+ This provides a pool based on an iSCSI target. Volumes must be
+ pre-allocated on the iSCSI server, and cannot be created via
+ the libvirt APIs. Since /dev/XXX names may change each time libvirt
+ logs into the iSCSI target, it is recommended to configure the pool
+ to use <code>/dev/disk/by-path</code> or <code>/dev/disk/by-id</code>
+ for the target path. These provide persistent stable naming for LUNs
+ </p>
+ <h3>Example pool input</h3>
+ <pre>
+ <pool type="iscsi">
+ <name>virtimages</name>
+ <source>
+ <host name="iscsi.example.com"/>
+ <device path="demo-target"/>
+ </source>
+ <target>
+ <path>/dev/disk/by-path</path>
+ </target>
+ </pool>
+ </pre>
+ <h3>Valid pool format types</h3>
+ <p>
+ The logical volume pool does not use the pool format type element.
+ </p>
+ <h3>Valid volume format types</h3>
+ <p>
+ The logical volume pool does not use the volume format type element.
+ </p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+ <ul class="l2"><li>
+ <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+ </li><li>
+ <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+ </li><li>
+ <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+ </li><li>
+ <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+ </li><li>
+ <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+ </li><li>
+ <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+ </li><li>
+ <span class="active">Storage</span>
+ </li></ul>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1 >Storage Management</h1>
+ <p>
+This page describes the backends for the storage management capabilities in
+libvirt.
+</p>
+ <ul>
+ <li>
+ <a href="#StorageBackendDir">Directory backend</a>
+ </li>
+ <li>
+ <a href="#StorageBackendFS">Local filesystem backend</a>
+ </li>
+ <li>
+ <a href="#StorageBackendNetFS">Network filesystem backend</a>
+ </li>
+ <li>
+ <a href="#StorageBackendLogical">Logical backend</a>
+ </li>
+ <li>
+ <a href="#StorageBackendDisk">Disk backend</a>
+ </li>
+ <li>
+ <a href="#StorageBackendISCSI">iSCSI backend</a>
+ </li>
+ </ul>
+
+ <h2><a name="StorageBackendDir" id="StorageBackendDir">Directory pool</a></h2>
+ <p>
+ A pool with a type of <code>dir</code> provides the means to manage
+ files within a directory. The files can be fully allocated raw files,
+ sparsely allocated raw files, or one of the special disk formats
+ such as <code>qcow</code>,<code>qcow2</code>,<code>vmdk</code>,
+ <code>cow</code>, etc as supported by the <code>qemu-img</code>
+ program. If the directory does not exist at the time the pool is
+ defined, the <code>build</code> operation can be used to create it.
+ </p>
+
+ <h3>Example pool input definition</h3>
+ <pre>
+ <pool type="dir">
+ <name>virtimages</name>
+ <target>
+ <path>/var/lib/virt/images</path>
+ </target>
+ </pool>
+ </pre>
+
+ <h3>Valid pool format types</h3>
+ <p>
+ The directory pool does not use the pool format type element.
+ </p>
+
+ <h3>Valid volume format types</h3>
+ <p>
+ One of the following options:
+ </p>
+ <ul>
+ <li><code>raw</code>: a plain file</li>
+ <li><code>bochs</code>: Bochs disk image format</li>
+ <li><code>cloop</code>: compressed loopback disk image format</li>
+ <li><code>cow</code>: User Mode Linux disk image format</li>
+ <li><code>dmg</code>: Mac disk image format</li>
+ <li><code>iso</code>: CDROM disk image format</li>
+ <li><code>qcow</code>: QEMU v1 disk image format</li>
+ <li><code>qcow2</code>: QEMU v2 disk image format</li>
+ <li><code>vmdk</code>: VMWare disk image format</li>
+ <li><code>vpc</code>: VirtualPC disk image format</li>
+ </ul>
+ <p>
+ When listing existing volumes all these formats are supported
+ natively. When creating new volumes, only a subset may be
+ available. The <code>raw</code> type is guaranteed always
+ available. The <code>qcow2</code> type can be created if
+ either <code>qemu-img</code> or <code>qcow-create</code> tools
+ are present. The others are dependent on support of the
+ <code>qemu-img</code> tool.
+
+ </p>
+
+ <h2><a name="StorageBackendFS" id="StorageBackendFS">Filesystem pool</a></h2>
+ <p>
+ This is a variant of the directory pool. Instead of creating a
+ directory on an existing mounted filesystem though, it expects
+ a source block device to be named. This block device will be
+ mounted and files managed in the directory of its mount point.
+ It will default to allowing the kernel to automatically discover
+ the filesystem type, though it can be specified manually if
+ required.
+ </p>
+
+ <h3>Example pool input</h3>
+ <pre>
+ <pool type="fs">
+ <name>virtimages</name>
+ <source>
+ <device path="/dev/VolGroup00/VirtImages"/>
+ </source>
+ <target>
+ <path>/var/lib/virt/images</path>
+ </target>
+ </pool>
+ </pre>
+
+ <h3>Valid pool format types</h3>
+ <p>
+ The filesystem pool supports the following formats:
+ </p>
+ <ul>
+ <li><code>auto</code> - automatically determine format</li>
+ <li>
+ <code>ext2</code>
+ </li>
+ <li>
+ <code>ext3</code>
+ </li>
+ <li>
+ <code>ext4</code>
+ </li>
+ <li>
+ <code>ufs</code>
+ </li>
+ <li>
+ <code>iso9660</code>
+ </li>
+ <li>
+ <code>udf</code>
+ </li>
+ <li>
+ <code>gfs</code>
+ </li>
+ <li>
+ <code>gfs2</code>
+ </li>
+ <li>
+ <code>vfat</code>
+ </li>
+ <li>
+ <code>hfs+</code>
+ </li>
+ <li>
+ <code>xfs</code>
+ </li>
+ </ul>
+
+ <h3>Valid volume format types</h3>
+ <p>
+ The valid volume types are the same as for the <code>directory</code>
+ pool type.
+ </p>
+
+
+ <h2><a name="StorageBackendNetFS" id="StorageBackendNetFS">Network filesystem pool</a></h2>
+ <p>
+ This is a variant of the filesystem pool. Instead of requiring
+ a local block device as the source, it requires the name of a
+ host and path of an exported directory. It will mount this network
+ filesystem and manage files within the directory of its mount
+ point. It will default to using NFS as the protocol.
+ </p>
+
+ <h3>Example pool input</h3>
+ <pre>
+ <pool type="netfs">
+ <name>virtimages</name>
+ <source>
+ <host name="nfs.example.com"/>
+ <dir path="/var/lib/virt/images"/>
+ </source>
+ <target>
+ <path>/var/lib/virt/images</path>
+ </target>
+ </pool>
+ </pre>
+
+ <h3>Valid pool format types</h3>
+ <p>
+ The network filesystem pool supports the following formats:
+ </p>
+ <ul>
+ <li><code>auto</code> - automatically determine format</li>
+ <li>
+ <code>nfs</code>
+ </li>
+ </ul>
+
+ <h3>Valid volume format types</h3>
+ <p>
+ The valid volume types are the same as for the <code>directory</code>
+ pool type.
+ </p>
+
+
+ <h2><a name="StorageBackendLogical" id="StorageBackendLogical">Logical volume pools</a></h2>
+ <p>
+ This provides a pool based on an LVM volume group. For a
+ pre-defined LVM volume group, simply providing the group
+ name is sufficient, while to build a new group requires
+ providing a list of source devices to serve as physical
+ volumes. Volumes will be allocated by carving out chunks
+ of storage from the volume group.
+ </p>
+
+ <h3>Example pool input</h3>
+ <pre>
+ <pool type="logical">
+ <name>HostVG</name>
+ <source>
+ <device path="/dev/sda1"/>
+ <device path="/dev/sdb1"/>
+ <device path="/dev/sdc1"/>
+ </source>
+ <target>
+ <path>/dev/HostVG</path>
+ </target>
+ </pool>
+ </pre>
+
+ <h3>Valid pool format types</h3>
+ <p>
+ The logical volume pool does not use the pool format type element.
+ </p>
+
+ <h3>Valid volume format types</h3>
+ <p>
+ The logical volume pool does not use the volume format type element.
+ </p>
+
+
+ <h2><a name="StorageBackendDisk" id="StorageBackendDisk">Disk volume pools</a></h2>
+ <p>
+ This provides a pool based on a physical disk. Volumes are created
+ by adding partitions to the disk. Disk pools are have constraints
+ on the size and placement of volumes. The 'free extents'
+ information will detail the regions which are available for creating
+ new volumes. A volume cannot span across 2 different free extents.
+ </p>
+
+ <h3>Example pool input</h3>
+ <pre>
+ <pool type="disk">
+ <name>sda</name>
+ <source>
+ <device path='/dev/sda'/>
+ </source>
+ <target>
+ <path>/dev</path>
+ </target>
+ </pool>
+ </pre>
+
+ <h3>Valid pool format types</h3>
+ <p>
+ The disk volume pool accepts the following pool format types, representing
+ the common partition table types:
+ </p>
+ <ul>
+ <li>
+ <code>dos</code>
+ </li>
+ <li>
+ <code>dvh</code>
+ </li>
+ <li>
+ <code>gpt</code>
+ </li>
+ <li>
+ <code>mac</code>
+ </li>
+ <li>
+ <code>bsd</code>
+ </li>
+ <li>
+ <code>pc98</code>
+ </li>
+ <li>
+ <code>sun</code>
+ </li>
+ </ul>
+ <p>
+ The <code>dos</code> or <code>gpt</code> formats are recommended for
+ best portability - the latter is needed for disks larger than 2TB.
+ </p>
+
+ <h3>Valid volume format types</h3>
+ <p>
+ The disk volume pool accepts the following volume format types, representing
+ the common partition entry types:
+ </p>
+ <ul>
+ <li>
+ <code>none</code>
+ </li>
+ <li>
+ <code>linux</code>
+ </li>
+ <li>
+ <code>fat16</code>
+ </li>
+ <li>
+ <code>fat32</code>
+ </li>
+ <li>
+ <code>linux-swap</code>
+ </li>
+ <li>
+ <code>linux-lvm</code>
+ </li>
+ <li>
+ <code>linux-raid</code>
+ </li>
+ <li>
+ <code>extended</code>
+ </li>
+ </ul>
+
+
+ <h2><a name="StorageBackendISCSI" id="StorageBackendISCSI">iSCSI volume pools</a></h2>
+ <p>
+ This provides a pool based on an iSCSI target. Volumes must be
+ pre-allocated on the iSCSI server, and cannot be created via
+ the libvirt APIs. Since /dev/XXX names may change each time libvirt
+ logs into the iSCSI target, it is recommended to configure the pool
+ to use <code>/dev/disk/by-path</code> or <code>/dev/disk/by-id</code>
+ for the target path. These provide persistent stable naming for LUNs
+ </p>
+
+ <h3>Example pool input</h3>
+ <pre>
+ <pool type="iscsi">
+ <name>virtimages</name>
+ <source>
+ <host name="iscsi.example.com"/>
+ <device path="demo-target"/>
+ </source>
+ <target>
+ <path>/dev/disk/by-path</path>
+ </target>
+ </pool>
+ </pre>
+
+ <h3>Valid pool format types</h3>
+ <p>
+ The logical volume pool does not use the pool format type element.
+ </p>
+
+ <h3>Valid volume format types</h3>
+ <p>
+ The logical volume pool does not use the volume format type element.
+ </p>
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Connection URIs</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Connection URIs</h1><p>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from uri.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Connection URIs</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Connection URIs</h1>
+ <p>
Since libvirt supports many different kinds of virtualization
(often referred to as "drivers" or "hypervisors"), we need a
way to be able to specify which driver a connection refers to.
Additionally we may want to refer to a driver on a remote
machine over the network.
-</p><p>
+</p>
+ <p>
To this end, libvirt uses URIs as used on the Web and as defined in <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>. This page
documents libvirt URIs.
-</p><ul><li><a href="#URI_libvirt">Specifying URIs to libvirt</a></li>
- <li><a href="#URI_virsh">Specifying URIs to virsh, virt-manager and virt-install</a></li>
- <li><a href="#URI_xen">xen:/// URI</a></li>
- <li><a href="#URI_qemu">qemu:///... QEMU and KVM URIs</a></li>
- <li><a href="#URI_remote">Remote URIs</a></li>
- <li><a href="#URI_test">test:///... Test URIs</a></li>
- <li><a href="#URI_legacy">Other & legacy URI formats</a></li>
-</ul><h3><a name="URI_libvirt" id="URI_libvirt">Specifying URIs to libvirt</a></h3><p>
+</p>
+ <ul><li>
+ <a href="#URI_libvirt">Specifying URIs to libvirt</a>
+ </li><li>
+ <a href="#URI_virsh">Specifying URIs to virsh, virt-manager and virt-install</a>
+ </li><li>
+ <a href="#URI_xen">xen:/// URI</a>
+ </li><li>
+ <a href="#URI_qemu">qemu:///... QEMU and KVM URIs</a>
+ </li><li>
+ <a href="#URI_remote">Remote URIs</a>
+ </li><li>
+ <a href="#URI_test">test:///... Test URIs</a>
+ </li><li>
+ <a href="#URI_legacy">Other & legacy URI formats</a>
+ </li></ul>
+ <h3>
+ <a name="URI_libvirt" id="URI_libvirt">Specifying URIs to libvirt</a>
+ </h3>
+ <p>
The URI is passed as the <code>name</code> parameter to <a href="html/libvirt-libvirt.html#virConnectOpen"><code>virConnectOpen</code></a> or <a href="html/libvirt-libvirt.html#virConnectOpenReadOnly"><code>virConnectOpenReadOnly</code></a>. For example:
-</p><pre>
+</p>
+ <pre>
virConnectPtr conn = virConnectOpenReadOnly (<b>"test:///default"</b>);
-</pre><h3><a name="URI_virsh" id="URI_virsh">Specifying URIs to virsh, virt-manager and virt-install</a></h3><p>
+</pre>
+ <h3>
+ <a name="URI_virsh" id="URI_virsh">Specifying URIs to virsh, virt-manager and virt-install</a>
+ </h3>
+ <p>
In virsh use the <code>-c</code> or <code>--connect</code> option:
-</p><pre>
+</p>
+ <pre>
virsh <b>-c test:///default</b> list
-</pre><p>
+</pre>
+ <p>
If virsh finds the environment variable
<code>VIRSH_DEFAULT_CONNECT_URI</code> set, it will try this URI by
default.
-</p><p>
+</p>
+ <p>
When using the interactive virsh shell, you can also use the
<code>connect</code> <i>URI</i> command to reconnect to another
hypervisor.
-</p><p>
+</p>
+ <p>
In virt-manager use the <code>-c</code> or <code>--connect=</code><i>URI</i> option:
-</p><pre>
+</p>
+ <pre>
virt-manager <b>-c test:///default</b>
-</pre><p>
+</pre>
+ <p>
In virt-install use the <code>--connect=</code><i>URI</i> option:
-</p><pre>
+</p>
+ <pre>
virt-install <b>--connect=test:///default</b> <i>[other options]</i>
-</pre><h3><a name="URI_xen" id="URI_xen">xen:/// URI</a></h3><p><i>This section describes a feature which is new in libvirt >
+</pre>
+ <h3>
+ <a name="URI_xen" id="URI_xen">xen:/// URI</a>
+ </h3>
+ <p>
+ <i>This section describes a feature which is new in libvirt >
0.2.3. For libvirt ≤ 0.2.3 use <a href="#URI_legacy_xen"><code>"xen"</code></a>.</i>
-</p><p>
+ </p>
+ <p>
To access a Xen hypervisor running on the local machine
use the URI <code>xen:///</code>.
-</p><h3><a name="URI_qemu" id="URI_qemu">qemu:///... QEMU and KVM URIs</a></h3><p>
+</p>
+ <h3>
+ <a name="URI_qemu" id="URI_qemu">qemu:///... QEMU and KVM URIs</a>
+ </h3>
+ <p>
To use QEMU support in libvirt you must be running the
<code>libvirtd</code> daemon (named <code>libvirt_qemud</code>
in releases prior to 0.3.0). The purpose of this
daemon is to manage qemu instances.
-</p><p>
+</p>
+ <p>
The <code>libvirtd</code> daemon should be started by the
init scripts when the machine boots. It should appear as
a process <code>libvirtd --daemon</code> running as root
in the background and will handle qemu instances on behalf
-of all users of the machine (among other things). </p><p>
+of all users of the machine (among other things). </p>
+ <p>
So to connect to the daemon, one of two different URIs is used:
-</p><ul><li> <code>qemu:///system</code> connects to a system mode daemon. </li>
-<li> <code>qemu:///session</code> connects to a session mode daemon. </li>
+</p>
+ <ul><li><code>qemu:///system</code> connects to a system mode daemon. </li><li><code>qemu:///session</code> connects to a session mode daemon. </li></ul>
(If you do <code>libvirtd --help</code>, the daemon will print
out the paths of the Unix domain socket(s) that it listens on in
the various different modes).
-</p><p>
+</p>
+ <p>
KVM URIs are identical. You select between qemu, qemu accelerated and
KVM guests in the <a href="format.html#KVM1">guest XML as described
here</a>.
-</p><h3><a name="URI_remote" id="URI_remote">Remote URIs</a></h3><p>
+</p>
+ <h3>
+ <a name="URI_remote" id="URI_remote">Remote URIs</a>
+ </h3>
+ <p>
Remote URIs are formed by taking ordinary local URIs and adding a
hostname and/or transport name. For example:
-</p><table class="top_table"><tr><th> Local URI </th>
-<th> Remote URI </th>
-<th> Meaning </th>
-</tr><tr><td> <code>xen:///</code> </td>
-<td> <code>xen://oirase/</code> </td>
-<td> Connect to the Xen hypervisor running on host <code>oirase</code>
- using TLS. </td>
-</tr><tr><td> <code>xen:///</code> </td>
-<td> <code>xen+ssh://oirase/</code> </td>
-<td> Connect to the Xen hypervisor running on host <code>oirase</code>
- by going over an <code>ssh</code> connection. </td>
-</tr><tr><td> <code>test:///default</code> </td>
-<td> <code>test+tcp://oirase/default</code> </td>
-<td> Connect to the test driver on host <code>oirase</code>
- using an unsecured TCP connection. </td>
-</tr></table><p>
+</p>
+ <table class="top_table"><tr><th> Local URI </th><th> Remote URI </th><th> Meaning </th></tr><tr><td>
+ <code>xen:///</code>
+ </td><td>
+ <code>xen://oirase/</code>
+ </td><td> Connect to the Xen hypervisor running on host <code>oirase</code>
+ using TLS. </td></tr><tr><td>
+ <code>xen:///</code>
+ </td><td>
+ <code>xen+ssh://oirase/</code>
+ </td><td> Connect to the Xen hypervisor running on host <code>oirase</code>
+ by going over an <code>ssh</code> connection. </td></tr><tr><td>
+ <code>test:///default</code>
+ </td><td>
+ <code>test+tcp://oirase/default</code>
+ </td><td> Connect to the test driver on host <code>oirase</code>
+ using an unsecured TCP connection. </td></tr></table>
+ <p>
Remote URIs in libvirt offer a rich syntax and many features.
We refer you to <a href="remote.html#Remote_URI_reference">the libvirt
remote URI reference</a> and <a href="remote.html">full documentation
for libvirt remote support</a>.
-</p><h3><a name="URI_test" id="URI_test">test:///... Test URIs</a></h3><p>
+</p>
+ <h3>
+ <a name="URI_test" id="URI_test">test:///... Test URIs</a>
+ </h3>
+ <p>
The test driver is a dummy hypervisor for test purposes.
The URIs supported are:
-</p><ul><li> <code>test:///default</code> connects to a default set of
-host definitions built into the driver. </li>
-<li> <code>test:///path/to/host/definitions</code> connects to
+</p>
+ <ul><li><code>test:///default</code> connects to a default set of
+host definitions built into the driver. </li><li><code>test:///path/to/host/definitions</code> connects to
a set of host definitions held in the named file.
-</li></ul><h3><a name="URI_legacy" id="URI_legacy">Other & legacy URI formats</a></h3><h4><a name="URI_NULL" id="URI_NULL">NULL and empty string URIs</a></h4><p>
+</li></ul>
+ <h3>
+ <a name="URI_legacy" id="URI_legacy">Other & legacy URI formats</a>
+ </h3>
+ <h4>
+ <a name="URI_NULL" id="URI_NULL">NULL and empty string URIs</a>
+ </h4>
+ <p>
Libvirt allows you to pass a <code>NULL</code> pointer to
<code>virConnectOpen*</code>. Empty string (<code>""</code>) acts in
the same way. Traditionally this has meant
<q>connect to the local Xen hypervisor</q>. However in future this
may change to mean <q>connect to the best available hypervisor</q>.
-</p><p>
+</p>
+ <p>
The theory is that if, for example, Xen is unavailable but the
machine is running an OpenVZ kernel, then we should not try to
connect to the Xen hypervisor since that is obviously the wrong
thing to do.
-</p><p>
+</p>
+ <p>
In any case applications linked to libvirt can continue to pass
<code>NULL</code> as a default choice, but should always allow the
user to override the URI, either by constructing one or by allowing
the user to type a URI in directly (if that is appropriate). If your
application wishes to connect specifically to a Xen hypervisor, then
for future proofing it should choose a full <a href="#URI_xen"><code>xen:///</code> URI</a>.
-</p><h4><a name="URI_file" id="URI_file">File paths (xend-unix-server)</a></h4><p>
+</p>
+ <h4>
+ <a name="URI_file" id="URI_file">File paths (xend-unix-server)</a>
+ </h4>
+ <p>
If XenD is running and configured in <code>/etc/xen/xend-config.sxp</code>:
-</p><pre>
+</p>
+ <pre>
(xend-unix-server yes)
-</pre><p>
+</pre>
+ <p>
then it listens on a Unix domain socket, usually at
<code>/var/lib/xend/xend-socket</code>. You may pass a different path
using a file URI such as:
-</p><pre>
+</p>
+ <pre>
virsh -c ///var/run/xend/xend-socket
-</pre><h4><a name="URI_http" id="URI_http">Legacy: <code>http://...</code> (xend-http-server)</a></h4><p>
+</pre>
+ <h4>
+ <a name="URI_http" id="URI_http">Legacy: <code>http://...</code> (xend-http-server)</a>
+ </h4>
+ <p>
If XenD is running and configured in <code>/etc/xen/xend-config.sxp</code>:
-</p><pre>
+</p>
+ <pre>
(xend-http-server yes)
-</pre><p>
+</pre>
+ <p>
then it listens on TCP port 8000. libvirt allows you to
try to connect to xend running on remote machines by passing
<code>http://<i>hostname</i>[:<i>port</i>]/</code>, for example:
-</p><pre>
+</p>
+ <pre>
virsh -c http://oirase/ list
-</pre><p>
+</pre>
+ <p>
This method is unencrypted and insecure and is definitely not
recommended for production use. Instead use <a href="remote.html">libvirt's remote support</a>.
-</p><p>
+</p>
+ <p>
Notes:
-</p><ol><li> The HTTP client does not fully support IPv6. </li>
-<li> Many features do not work as expected across HTTP connections, in
+</p>
+ <ol><li> The HTTP client does not fully support IPv6. </li><li> Many features do not work as expected across HTTP connections, in
particular, <a href="html/libvirt-libvirt.html#virConnectGetCapabilities">virConnectGetCapabilities</a>.
The <a href="remote.html">remote support</a> however does work
- correctly. </li>
-<li> XenD's new-style XMLRPC interface is not supported by
+ correctly. </li><li> XenD's new-style XMLRPC interface is not supported by
libvirt, only the old-style sexpr interface known in the Xen
- documentation as "unix server" or "http server".</li>
-</ol><h4><a name="URI_legacy_xen" id="URI_legacy_xen">Legacy: <code>"xen"</code></a></h4><p>
+ documentation as "unix server" or "http server".</li></ol>
+ <h4>
+ <a name="URI_legacy_xen" id="URI_legacy_xen">Legacy: <code>"xen"</code></a>
+ </h4>
+ <p>
Another legacy URI is to specify name as the string
<code>"xen"</code>. This will continue to refer to the Xen
hypervisor. However you should prefer a full <a href="#URI_xen"><code>xen:///</code> URI</a> in all future code.
-</p><h4><a name="URI_http" id="URI_http">Legacy: Xen proxy</a></h4><p>
+</p>
+ <h4>
+ <a name="URI_legacy_proxy" id="URI_legacy_proxy">Legacy: Xen proxy</a>
+ </h4>
+ <p>
Libvirt continues to support connections to a separately running Xen
proxy daemon. This provides a way to allow non-root users to make a
safe (read-only) subset of queries to the hypervisor.
-</p><p>
+</p>
+ <p>
There is no specific "Xen proxy" URI. However if a Xen URI of any of
the ordinary or legacy forms is used (eg. <code>NULL</code>,
<code>""</code>, <code>"xen"</code>, ...) which fails, <i>and</i> the
user is not root, <i>and</i> the Xen proxy socket can be connected to
(<code>/tmp/libvirt_proxy_conn</code>), then libvirt will use a proxy
connection.
-</p><p>
+</p>
+ <p>
You should consider using <a href="remote.html">libvirt remote support</a>
in future.
-</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+</p>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="active" href="deployment.html">Deployment</a>
+ <ul class="l2"><li>
+ <span class="active">URI format</span>
+ </li><li>
+ <a title="Enable remote access over TCP" class="inactive" href="remote.html">Remote access</a>
+ </li><li>
+ <a title="Configure authentication for the libvirt daemon" class="inactive" href="auth.html">Authentication</a>
+ </li><li>
+ <a title="Access the libvirt daemon from a native Windows client" class="inactive" href="windows.html">Windows port</a>
+ </li></ul>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1 >Connection URIs</h1>
+ <p>
+Since libvirt supports many different kinds of virtualization
+(often referred to as "drivers" or "hypervisors"), we need a
+way to be able to specify which driver a connection refers to.
+Additionally we may want to refer to a driver on a remote
+machine over the network.
+</p>
+ <p>
+To this end, libvirt uses URIs as used on the Web and as defined in <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>. This page
+documents libvirt URIs.
+</p>
+ <ul>
+ <li>
+ <a href="#URI_libvirt">Specifying URIs to libvirt</a>
+ </li>
+ <li>
+ <a href="#URI_virsh">Specifying URIs to virsh, virt-manager and virt-install</a>
+ </li>
+ <li>
+ <a href="#URI_xen">xen:/// URI</a>
+ </li>
+ <li>
+ <a href="#URI_qemu">qemu:///... QEMU and KVM URIs</a>
+ </li>
+ <li>
+ <a href="#URI_remote">Remote URIs</a>
+ </li>
+ <li>
+ <a href="#URI_test">test:///... Test URIs</a>
+ </li>
+ <li>
+ <a href="#URI_legacy">Other & legacy URI formats</a>
+ </li>
+ </ul>
+ <h3>
+ <a name="URI_libvirt" id="URI_libvirt">Specifying URIs to libvirt</a>
+ </h3>
+ <p>
+The URI is passed as the <code>name</code> parameter to <a href="html/libvirt-libvirt.html#virConnectOpen"><code>virConnectOpen</code></a> or <a href="html/libvirt-libvirt.html#virConnectOpenReadOnly"><code>virConnectOpenReadOnly</code></a>. For example:
+</p>
+ <pre>
+virConnectPtr conn = virConnectOpenReadOnly (<b>"test:///default"</b>);
+</pre>
+ <h3>
+ <a name="URI_virsh" id="URI_virsh">Specifying URIs to virsh, virt-manager and virt-install</a>
+ </h3>
+ <p>
+In virsh use the <code>-c</code> or <code>--connect</code> option:
+</p>
+ <pre>
+virsh <b>-c test:///default</b> list
+</pre>
+ <p>
+If virsh finds the environment variable
+<code>VIRSH_DEFAULT_CONNECT_URI</code> set, it will try this URI by
+default.
+</p>
+ <p>
+When using the interactive virsh shell, you can also use the
+<code>connect</code> <i>URI</i> command to reconnect to another
+hypervisor.
+</p>
+ <p>
+In virt-manager use the <code>-c</code> or <code>--connect=</code><i>URI</i> option:
+</p>
+ <pre>
+virt-manager <b>-c test:///default</b>
+</pre>
+ <p>
+In virt-install use the <code>--connect=</code><i>URI</i> option:
+</p>
+ <pre>
+virt-install <b>--connect=test:///default</b> <i>[other options]</i>
+</pre>
+ <h3>
+ <a name="URI_xen" id="URI_xen">xen:/// URI</a>
+ </h3>
+ <p>
+ <i>This section describes a feature which is new in libvirt >
+0.2.3. For libvirt ≤ 0.2.3 use <a href="#URI_legacy_xen"><code>"xen"</code></a>.</i>
+ </p>
+ <p>
+To access a Xen hypervisor running on the local machine
+use the URI <code>xen:///</code>.
+</p>
+ <h3>
+ <a name="URI_qemu" id="URI_qemu">qemu:///... QEMU and KVM URIs</a>
+ </h3>
+ <p>
+To use QEMU support in libvirt you must be running the
+<code>libvirtd</code> daemon (named <code>libvirt_qemud</code>
+in releases prior to 0.3.0). The purpose of this
+daemon is to manage qemu instances.
+</p>
+ <p>
+The <code>libvirtd</code> daemon should be started by the
+init scripts when the machine boots. It should appear as
+a process <code>libvirtd --daemon</code> running as root
+in the background and will handle qemu instances on behalf
+of all users of the machine (among other things). </p>
+ <p>
+So to connect to the daemon, one of two different URIs is used:
+</p>
+ <ul>
+ <li><code>qemu:///system</code> connects to a system mode daemon. </li>
+ <li><code>qemu:///session</code> connects to a session mode daemon. </li>
+ </ul>
+ <p>
+(If you do <code>libvirtd --help</code>, the daemon will print
+out the paths of the Unix domain socket(s) that it listens on in
+the various different modes).
+</p>
+ <p>
+KVM URIs are identical. You select between qemu, qemu accelerated and
+KVM guests in the <a href="format.html#KVM1">guest XML as described
+here</a>.
+</p>
+ <h3>
+ <a name="URI_remote" id="URI_remote">Remote URIs</a>
+ </h3>
+ <p>
+Remote URIs are formed by taking ordinary local URIs and adding a
+hostname and/or transport name. For example:
+</p>
+ <table class="top_table">
+ <tr>
+ <th> Local URI </th>
+ <th> Remote URI </th>
+ <th> Meaning </th>
+ </tr>
+ <tr>
+ <td>
+ <code>xen:///</code>
+ </td>
+ <td>
+ <code>xen://oirase/</code>
+ </td>
+ <td> Connect to the Xen hypervisor running on host <code>oirase</code>
+ using TLS. </td>
+ </tr>
+ <tr>
+ <td>
+ <code>xen:///</code>
+ </td>
+ <td>
+ <code>xen+ssh://oirase/</code>
+ </td>
+ <td> Connect to the Xen hypervisor running on host <code>oirase</code>
+ by going over an <code>ssh</code> connection. </td>
+ </tr>
+ <tr>
+ <td>
+ <code>test:///default</code>
+ </td>
+ <td>
+ <code>test+tcp://oirase/default</code>
+ </td>
+ <td> Connect to the test driver on host <code>oirase</code>
+ using an unsecured TCP connection. </td>
+ </tr>
+ </table>
+ <p>
+Remote URIs in libvirt offer a rich syntax and many features.
+We refer you to <a href="remote.html#Remote_URI_reference">the libvirt
+remote URI reference</a> and <a href="remote.html">full documentation
+for libvirt remote support</a>.
+</p>
+ <h3>
+ <a name="URI_test" id="URI_test">test:///... Test URIs</a>
+ </h3>
+ <p>
+The test driver is a dummy hypervisor for test purposes.
+The URIs supported are:
+</p>
+ <ul>
+ <li><code>test:///default</code> connects to a default set of
+host definitions built into the driver. </li>
+ <li><code>test:///path/to/host/definitions</code> connects to
+a set of host definitions held in the named file.
+</li>
+ </ul>
+ <h3>
+ <a name="URI_legacy" id="URI_legacy">Other & legacy URI formats</a>
+ </h3>
+ <h4>
+ <a name="URI_NULL" id="URI_NULL">NULL and empty string URIs</a>
+ </h4>
+ <p>
+Libvirt allows you to pass a <code>NULL</code> pointer to
+<code>virConnectOpen*</code>. Empty string (<code>""</code>) acts in
+the same way. Traditionally this has meant
+<q>connect to the local Xen hypervisor</q>. However in future this
+may change to mean <q>connect to the best available hypervisor</q>.
+</p>
+ <p>
+The theory is that if, for example, Xen is unavailable but the
+machine is running an OpenVZ kernel, then we should not try to
+connect to the Xen hypervisor since that is obviously the wrong
+thing to do.
+</p>
+ <p>
+In any case applications linked to libvirt can continue to pass
+<code>NULL</code> as a default choice, but should always allow the
+user to override the URI, either by constructing one or by allowing
+the user to type a URI in directly (if that is appropriate). If your
+application wishes to connect specifically to a Xen hypervisor, then
+for future proofing it should choose a full <a href="#URI_xen"><code>xen:///</code> URI</a>.
+</p>
+ <h4>
+ <a name="URI_file" id="URI_file">File paths (xend-unix-server)</a>
+ </h4>
+ <p>
+If XenD is running and configured in <code>/etc/xen/xend-config.sxp</code>:
+</p>
+ <pre>
+(xend-unix-server yes)
+</pre>
+ <p>
+then it listens on a Unix domain socket, usually at
+<code>/var/lib/xend/xend-socket</code>. You may pass a different path
+using a file URI such as:
+</p>
+ <pre>
+virsh -c ///var/run/xend/xend-socket
+</pre>
+ <h4>
+ <a name="URI_http" id="URI_http">Legacy: <code>http://...</code> (xend-http-server)</a>
+ </h4>
+ <p>
+If XenD is running and configured in <code>/etc/xen/xend-config.sxp</code>:
+
+</p>
+ <pre>
+(xend-http-server yes)
+</pre>
+ <p>
+then it listens on TCP port 8000. libvirt allows you to
+try to connect to xend running on remote machines by passing
+<code>http://<i>hostname</i>[:<i>port</i>]/</code>, for example:
+
+</p>
+ <pre>
+virsh -c http://oirase/ list
+</pre>
+ <p>
+This method is unencrypted and insecure and is definitely not
+recommended for production use. Instead use <a href="remote.html">libvirt's remote support</a>.
+</p>
+ <p>
+Notes:
+</p>
+ <ol>
+ <li> The HTTP client does not fully support IPv6. </li>
+ <li> Many features do not work as expected across HTTP connections, in
+ particular, <a href="html/libvirt-libvirt.html#virConnectGetCapabilities">virConnectGetCapabilities</a>.
+ The <a href="remote.html">remote support</a> however does work
+ correctly. </li>
+ <li> XenD's new-style XMLRPC interface is not supported by
+ libvirt, only the old-style sexpr interface known in the Xen
+ documentation as "unix server" or "http server".</li>
+ </ol>
+ <h4>
+ <a name="URI_legacy_xen" id="URI_legacy_xen">Legacy: <code>"xen"</code></a>
+ </h4>
+ <p>
+Another legacy URI is to specify name as the string
+<code>"xen"</code>. This will continue to refer to the Xen
+hypervisor. However you should prefer a full <a href="#URI_xen"><code>xen:///</code> URI</a> in all future code.
+</p>
+ <h4>
+ <a name="URI_legacy_proxy" id="URI_legacy_proxy">Legacy: Xen proxy</a>
+ </h4>
+ <p>
+Libvirt continues to support connections to a separately running Xen
+proxy daemon. This provides a way to allow non-root users to make a
+safe (read-only) subset of queries to the hypervisor.
+</p>
+ <p>
+There is no specific "Xen proxy" URI. However if a Xen URI of any of
+the ordinary or legacy forms is used (eg. <code>NULL</code>,
+<code>""</code>, <code>"xen"</code>, ...) which fails, <i>and</i> the
+user is not root, <i>and</i> the Xen proxy socket can be connected to
+(<code>/tmp/libvirt_proxy_conn</code>), then libvirt will use a proxy
+connection.
+</p>
+ <p>
+You should consider using <a href="remote.html">libvirt remote support</a>
+in future.
+</p>
+ </body>
+</html>
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Windows support</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Windows support</h1><p>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+ This file is autogenerated from windows.html.in
+ Do not edit this file. Changes will be lost.
+ -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" type="text/css" href="main.css" />
+ <link rel="SHORTCUT ICON" href="32favicon.png" />
+ <title>libvirt: Windows support</title>
+ <meta name="description" content="libvirt, virtualization, virtualization API" />
+ </head>
+ <body>
+ <div id="header">
+ <div id="headerLogo"></div>
+ <div id="headerSearch">
+ <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
+ <input id="query" name="query" type="text" size="12" value="" />
+ <input id="submit" name="submit" type="submit" value="Search" />
+ </form>
+ </div>
+ </div>
+ <div id="body">
+ <div id="content">
+ <h1>Windows support</h1>
+ <p>
Instructions for compiling and installing libvirt on Windows.
-</p><ul><li><a href="#Windows_binaries">Binaries</a></li>
- <li><a href="#Windows_compiling">Compiling from source</a></li>
-</ul><h3><a name="Windows_binaries" id="Windows_binaries">Binaries</a></h3><p>
+</p>
+ <ul><li>
+ <a href="#Windows_binaries">Binaries</a>
+ </li><li>
+ <a href="#Windows_compiling">Compiling from source</a>
+ </li></ul>
+ <h3>
+ <a name="Windows_binaries" id="Windows_binaries">Binaries</a>
+ </h3>
+ <p>
Binaries will be available from
<a href="ftp://libvirt.org/libvirt/win32">the download area</a>
(but we don't have binaries at the moment).
-</p><h3><a name="Windows_compiling" id="Windows_compiling">Compiling from source</a></h3><p>
+</p>
+ <h3>
+ <a name="Windows_compiling" id="Windows_compiling">Compiling from source</a>
+ </h3>
+ <p>
These are the steps to compile libvirt and the other
tools from source on Windows.
-</p><p>
+</p>
+ <p>
You will need:
-</p><ol><li> MS Windows. Microsoft makes free (as beer) versions
+</p>
+ <ol><li> MS Windows. Microsoft makes free (as beer) versions
of some of its operating systems available to
<a href="http://msdn.microsoft.com/">MSDN subscribers</a>.
We used Windows 2008 Server for testing, virtualized under
Linux using KVM-53 (earlier versions of KVM and QEMU won't
run recent versions of Windows because of lack of full ACPI
support, so make sure you have the latest KVM).
-</li>
-
-<li> <a href="http://www.cygwin.com/">Cygwin</a>'s
+</li><li><a href="http://www.cygwin.com/">Cygwin</a>'s
<a href="http://www.cygwin.com/setup.exe">setup.exe</a>.
-</li>
-
-<li> A large amount of free disk space to install Cygwin.
+</li><li> A large amount of free disk space to install Cygwin.
Make sure you have 10 GB free to install most Cygwin packages,
although if you pare down the list of dependencies you may
-get away with much less. </li>
-
-<li> A network connection for Windows, since Cygwin downloads packages
-from the net as it installs. </li>
-
-<li> <a href="http://www.libvirt.org/downloads.html">Libvirt
-latest version from CVS</a> </li>
-
-<li> The latest source patch from
-<a href="ftp://libvirt.org/libvirt/win32">the download area</a>. </li>
-
-<li> A version of Cygwin sunrpc, patched to support building
+get away with much less. </li><li> A network connection for Windows, since Cygwin downloads packages
+from the net as it installs. </li><li>
+ <a href="http://www.libvirt.org/downloads.html">Libvirt
+latest version from CVS</a>
+ </li><li> The latest source patch from
+<a href="ftp://libvirt.org/libvirt/win32">the download area</a>. </li><li> A version of Cygwin sunrpc, patched to support building
<code>librpc.dll</code>.
A patch and a binary package are available from
- <a href="ftp://libvirt.org/libvirt/win32">the download area</a>. </li>
+ <a href="ftp://libvirt.org/libvirt/win32">the download area</a>. </li></ol>
These are the steps to take to compile libvirt from
source on Windows:
-</p><ol><li>
- <p>Run Cygwin
+</p>
+ <ol><li>
+ <p>Run Cygwin
<a href="http://www.cygwin.com/setup.exe">setup.exe</a>.
When it starts up it will show a dialog like this:
</p>
-
- <img src="windows-cygwin-1.png" width="504" height="388" alt="Cygwin Net Release Setup Program" /></li>
-
-<li>
- <p>Step through the setup program accepting defaults
+ <img src="windows-cygwin-1.png" width="504" height="388" alt="Cygwin Net Release Setup Program" /></li><li>
+ <p>Step through the setup program accepting defaults
or making choices as appropriate, until you get to the
screen for selecting packages:</p>
-
- <img src="windows-cygwin-2.png" width="505" height="388" alt="Cygwin Select Packages screen" /><p>
+ <img src="windows-cygwin-2.png" width="505" height="388" alt="Cygwin Select Packages screen" /><p>
The user interface here is very confusing. You have to
click the "recycling icon" as shown by the arrow:
</p>
-
- <img src="windows-cygwin-3.png" width="298" height="200" alt="Cygwin Recycling Icon" /><p>
+ <img src="windows-cygwin-3.png" width="298" height="200" alt="Cygwin Recycling Icon" /><p>
which takes the package (and all packages in the subtree)
through several states such as "Install", "Reinstall", "Keep",
"Skip", "Uninstall", etc.
</p>
-
-</li>
-
-<li>
- <p>You can install "All" (everything) or better select
+ </li><li>
+ <p>You can install "All" (everything) or better select
just the groups and packages needed. Select the following
groups and packages for installation:
</p>
-
- <table><tr><th valign="top" align="right"> Groups </th>
- <td>
+ <table><tr><th valign="top" align="right"> Groups </th><td>
Archive <br />
Base <br />
Devel <br />
Mingw <br />
Perl <br />
Python <br />
- Shells <br /></td>
- </tr><tr><th valign="top" align="right"> Packages </th>
- <td>
+ Shells <br /></td></tr><tr><th valign="top" align="right"> Packages </th><td>
openssh <br />
- sunrpc ≥ 4.0-4 (see below) <br /></td>
- </tr></table></li>
-
-<li>
- <p> Once Cygwin has finished installing, start a Cygwin bash shell
+ sunrpc ≥ 4.0-4 (see below) <br /></td></tr></table></li><li>
+ <p> Once Cygwin has finished installing, start a Cygwin bash shell
(either click on the desktop icon or look for Cygwin bash shell
in the Start menu). </p>
-
- <p> The very first time you start the Cygwin bash shell, you may
+ <p> The very first time you start the Cygwin bash shell, you may
find you need to run the <code>mkpasswd</code> and <code>mkgroup</code>
commands in order to create <code>/etc/passwd</code> and
<code>/etc/group</code> files from Windows users. If this
is needed then a message is printed in the shell.
Note that you need to do this as Windows Administrator. </p>
-</li>
-
-<li>
- <p> Install Cygwin sunrpc ≥ 4.0-4 package, patched to include
+ </li><li>
+ <p> Install Cygwin sunrpc ≥ 4.0-4 package, patched to include
<code>librpc.dll</code>.
To do this, first check to see whether <code>/usr/lib/librpc.dll</code>
exists. If it does, you're good to go and can skip to the next
step. </p>
-
- <p>
+ <p>
If you don't have this file, either install the binary package
<a href="ftp://libvirt.org/libvirt/win32/sunrpc-4.0-4.tar.bz2">sunrpc-4.0-4.tar.bz2</a> (just unpack it, as Administrator, in the Cygwin root directory).
Or you can download the
and apply it by hand to the Cygwin sunrpc package (eg. using
cygport).
</p>
-</li>
-
-<li>
- <p>
+ </li><li>
+ <p>
Check out
<a href="http://www.libvirt.org/downloads.html">Libvirt from CVS</a> and
<a href="ftp://libvirt.org/libvirt/win32">apply the latest Windows patch</a>
to the source.
</p>
-</li>
-
-<li>
- <p> Configure libvirt by doing: </p>
-<pre>
+ </li><li>
+ <p> Configure libvirt by doing: </p>
+ <pre>
autoreconf
./configure --without-xen --without-qemu
</pre>
- <p> (The autoreconf step is probably optional). </p>
- <p> The configure step will tell you if you have all the
+
<p> (The autoreconf step is probably optional). </p>
+
<p> The configure step will tell you if you have all the
required parts installed. If something is missing you
will need to go back through Cygwin setup and install it.
</p>
-</li>
-
-<li>
- <p> Rebuild the XDR structures: </p>
-<pre>
+ </li><li>
+ <p> Rebuild the XDR structures: </p>
+ <pre>
rm qemud/remote_protocol.[ch] qemud/remote_dispatch_*.h
make -C qemud remote_protocol.c
</pre>
-</li>
-
-<li>
- <p> Build: </p>
-<pre>
+ </li><li>
+ <p> Build: </p>
+ <pre>
make
</pre>
- <p> If this step is not successful, you should post a full
+
<p> If this step is not successful, you should post a full
report <i>including complete messages</i> to
<a href="http://www.redhat.com/mailman/listinfo/libvir-list">the
libvirt mailing list</a>.
</p>
-</li>
-
-<li>
- <p> Test it. If you have access to a remote machine
+ </li><li>
+ <p> Test it. If you have access to a remote machine
running Xen or QEMU/KVM, and the libvirt daemon (<code>libvirtd</code>)
then you should be able to connect to it and display
domains using, eg:
</p>
-<pre>
src/virsh.exe <a href="http://libvirt.org/uri.html">-c qemu://remote/system</a> list --all
</pre>
- <p>
Please read more about <a href="http://libvirt.org/remote.html">remote
support</a> before sending bug reports, to make sure that
any problems are really Windows and not just with remote
configuration / security.
</p>
-</li>
-
-<li>
- <p>
+ </li><li>
+ <p>
You may want to install the library and programs by doing:
</p>
-<pre>
make install
</pre>
-</li>
-
-<li>
- <p>
+ </li><li>
+ <p>
The above steps should also build and install Python modules.
However for reasons which I don't fully understand, Python won't
look in the
directory by default so you may need to set the environment
variable PYTHONPATH:
</p>
-
-<pre>
+ <pre>
export PYTHONPATH=/usr/local/lib/python2.5/site-packages
</pre>
-
- <p>
+ <p>
(Change the version number to your version of Python). You
can test Python support from the command line:
</p>
-
-<pre>
+ <pre>
python
>>> import libvirt
>>> conn = libvirt.open ("test:///default")
>>> dom.XMLDesc (0)
"<domain type='test' id='1'> ..."
</pre>
-
- <p>
+ <p>
The most common failure will be with <code>import libvirt</code>
which usually indicates that either <code>PYTHONPATH</code> is
wrong or a DLL cannot be loaded.
</p>
-</li>
-
-</ol></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+ </li></ol>
+ </div>
+ <div id="menu">
+ <ul class="l0"><li>
+ <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+ </li><li>
+ <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+ </li><li>
+ <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+ </li><li>
+ <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+ <ul class="l1"><li>
+ <a title="Information about deploying and using libvirt" class="active" href="deployment.html">Deployment</a>
+ <ul class="l2"><li>
+ <a title="The URI formats used for connecting to libvirt" class="inactive" href="uri.html">URI format</a>
+ </li><li>
+ <a title="Enable remote access over TCP" class="inactive" href="remote.html">Remote access</a>
+ </li><li>
+ <a title="Configure authentication for the libvirt daemon" class="inactive" href="auth.html">Authentication</a>
+ </li><li>
+ <span class="active">Windows port</span>
+ </li></ul>
+ </li><li>
+ <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+ </li><li>
+ <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+ </li><li>
+ <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+ </li><li>
+ <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+ </li><li>
+ <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+ </li></ul>
+ </li><li>
+ <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+ </li><li>
+ <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+ </li><li>
+ <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+ </li><li>
+ <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+ </li><li>
+ <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+ </li><li>
+ <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+ </li></ul>
+ </div>
+ </div>
+ <div id="footer">
+ <div id="projects">
+ <dl id="p1"><dt>
+ <a href="http://augeas.net/">Augeas</a>
+ </dt><dd>
+ <span>A configuration editing tool and API</span>
+ </dd><dt>
+ <a href="http://libvirt.org/">libvirt</a>
+ </dt><dd>
+ <span>The open source virtualization API</span>
+ </dd></dl>
+ <dl id="p2"><dt>
+ <a href="http://cobbler.et.redhat.com/">Cobbler</a>
+ </dt><dd>
+ <span>OS provisioning and profile management</span>
+ </dd><dt>
+ <a href="http://ovirt.org/">oVirt</a>
+ </dt><dd>
+ <span>Virtualization management across the data center</span>
+ </dd></dl>
+ <dl id="p3"><dt>
+ <a href="http://freeipa.org/">FreeIPA</a>
+ </dt><dd>
+ <span>Identity, policy and audit management</span>
+ </dd><dt>
+ <a href="http://virt-manager.org/">Virtual Machine Manager</a>
+ </dt><dd>
+ <span>Virtualization management from the desktop</span>
+ </dd></dl>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1 >Windows support</h1>
+ <p>
+Instructions for compiling and installing libvirt on Windows.
+</p>
+ <ul>
+ <li>
+ <a href="#Windows_binaries">Binaries</a>
+ </li>
+ <li>
+ <a href="#Windows_compiling">Compiling from source</a>
+ </li>
+ </ul>
+ <h3>
+ <a name="Windows_binaries" id="Windows_binaries">Binaries</a>
+ </h3>
+ <p>
+Binaries will be available from
+<a href="ftp://libvirt.org/libvirt/win32">the download area</a>
+(but we don't have binaries at the moment).
+</p>
+ <h3>
+ <a name="Windows_compiling" id="Windows_compiling">Compiling from source</a>
+ </h3>
+ <p>
+These are the steps to compile libvirt and the other
+tools from source on Windows.
+</p>
+ <p>
+You will need:
+</p>
+ <ol>
+ <li> MS Windows. Microsoft makes free (as beer) versions
+of some of its operating systems available to
+<a href="http://msdn.microsoft.com/">MSDN subscribers</a>.
+We used Windows 2008 Server for testing, virtualized under
+Linux using KVM-53 (earlier versions of KVM and QEMU won't
+run recent versions of Windows because of lack of full ACPI
+support, so make sure you have the latest KVM).
+</li>
+ <li><a href="http://www.cygwin.com/">Cygwin</a>'s
+<a href="http://www.cygwin.com/setup.exe">setup.exe</a>.
+</li>
+ <li> A large amount of free disk space to install Cygwin.
+Make sure you have 10 GB free to install most Cygwin packages,
+although if you pare down the list of dependencies you may
+get away with much less. </li>
+ <li> A network connection for Windows, since Cygwin downloads packages
+from the net as it installs. </li>
+ <li>
+ <a href="http://www.libvirt.org/downloads.html">Libvirt
+latest version from CVS</a>
+ </li>
+ <li> The latest source patch from
+<a href="ftp://libvirt.org/libvirt/win32">the download area</a>. </li>
+ <li> A version of Cygwin sunrpc, patched to support building
+ <code>librpc.dll</code>.
+ A patch and a binary package are available from
+ <a href="ftp://libvirt.org/libvirt/win32">the download area</a>. </li>
+ </ol>
+ <p>
+These are the steps to take to compile libvirt from
+source on Windows:
+</p>
+ <ol>
+ <li>
+ <p>Run Cygwin
+ <a href="http://www.cygwin.com/setup.exe">setup.exe</a>.
+ When it starts up it will show a dialog like this:
+ </p>
+ <img src="windows-cygwin-1.png" width="504" height="388" alt="Cygwin Net Release Setup Program"/>
+ </li>
+ <li>
+ <p>Step through the setup program accepting defaults
+ or making choices as appropriate, until you get to the
+ screen for selecting packages:</p>
+ <img src="windows-cygwin-2.png" width="505" height="388" alt="Cygwin Select Packages screen"/>
+ <p>
+ The user interface here is very confusing. You have to
+ click the "recycling icon" as shown by the arrow:
+ </p>
+ <img src="windows-cygwin-3.png" width="298" height="200" alt="Cygwin Recycling Icon"/>
+ <p>
+ which takes the package (and all packages in the subtree)
+ through several states such as "Install", "Reinstall", "Keep",
+ "Skip", "Uninstall", etc.
+ </p>
+ </li>
+ <li>
+ <p>You can install "All" (everything) or better select
+ just the groups and packages needed. Select the following
+ groups and packages for installation:
+ </p>
+ <table>
+ <tr>
+ <th valign="top" align="right"> Groups </th>
+ <td>
+ Archive <br/>
+ Base <br/>
+ Devel <br/>
+ Editors <br/>
+ Mingw <br/>
+ Perl <br/>
+ Python <br/>
+ Shells <br/></td>
+ </tr>
+ <tr>
+ <th valign="top" align="right"> Packages </th>
+ <td>
+ openssh <br/>
+ sunrpc ≥ 4.0-4 (see below) <br/></td>
+ </tr>
+ </table>
+ </li>
+ <li>
+ <p> Once Cygwin has finished installing, start a Cygwin bash shell
+ (either click on the desktop icon or look for Cygwin bash shell
+ in the Start menu). </p>
+ <p> The very first time you start the Cygwin bash shell, you may
+ find you need to run the <code>mkpasswd</code> and <code>mkgroup</code>
+ commands in order to create <code>/etc/passwd</code> and
+ <code>/etc/group</code> files from Windows users. If this
+ is needed then a message is printed in the shell.
+ Note that you need to do this as Windows Administrator. </p>
+ </li>
+ <li>
+ <p> Install Cygwin sunrpc ≥ 4.0-4 package, patched to include
+ <code>librpc.dll</code>.
+ To do this, first check to see whether <code>/usr/lib/librpc.dll</code>
+ exists. If it does, you're good to go and can skip to the next
+ step. </p>
+ <p>
+ If you don't have this file, either install the binary package
+ <a href="ftp://libvirt.org/libvirt/win32/sunrpc-4.0-4.tar.bz2">sunrpc-4.0-4.tar.bz2</a> (just unpack it, as Administrator, in the Cygwin root directory).
+ Or you can download the
+ <a href="ftp://libvirt.org/libvirt/win32/sunrpc-4.0-dll.patch">source patch</a>
+ and apply it by hand to the Cygwin sunrpc package (eg. using
+ cygport).
+ </p>
+ </li>
+ <li>
+ <p>
+ Check out
+ <a href="http://www.libvirt.org/downloads.html">Libvirt from CVS</a> and
+ <a href="ftp://libvirt.org/libvirt/win32">apply the latest Windows patch</a>
+ to the source.
+ </p>
+ </li>
+ <li>
+ <p> Configure libvirt by doing: </p>
+ <pre>
+autoreconf
+./configure --without-xen --without-qemu
+</pre>
+ <p> (The autoreconf step is probably optional). </p>
+ <p> The configure step will tell you if you have all the
+ required parts installed. If something is missing you
+ will need to go back through Cygwin setup and install it.
+ </p>
+ </li>
+ <li>
+ <p> Rebuild the XDR structures: </p>
+ <pre>
+rm qemud/remote_protocol.[ch] qemud/remote_dispatch_*.h
+make -C qemud remote_protocol.c
+</pre>
+ </li>
+ <li>
+ <p> Build: </p>
+ <pre>
+make
+</pre>
+ <p> If this step is not successful, you should post a full
+ report <i>including complete messages</i> to
+ <a href="http://www.redhat.com/mailman/listinfo/libvir-list">the
+ libvirt mailing list</a>.
+ </p>
+ </li>
+ <li>
+ <p> Test it. If you have access to a remote machine
+ running Xen or QEMU/KVM, and the libvirt daemon (<code>libvirtd</code>)
+ then you should be able to connect to it and display
+ domains using, eg:
+ </p>
+ <pre>
+src/virsh.exe <a href="http://libvirt.org/uri.html">-c qemu://remote/system</a> list --all
+</pre>
+ <p>
+ Please read more about <a href="http://libvirt.org/remote.html">remote
+ support</a> before sending bug reports, to make sure that
+ any problems are really Windows and not just with remote
+ configuration / security.
+ </p>
+ </li>
+ <li>
+ <p>
+ You may want to install the library and programs by doing:
+ </p>
+ <pre>
+make install
+</pre>
+ </li>
+ <li>
+ <p>
+ The above steps should also build and install Python modules.
+ However for reasons which I don't fully understand, Python won't
+ look in the
+ non-standard <code>/usr/local/lib/python*/site-packages/</code>
+ directory by default so you may need to set the environment
+ variable PYTHONPATH:
+ </p>
+ <pre>
+export PYTHONPATH=/usr/local/lib/python2.5/site-packages
+</pre>
+ <p>
+ (Change the version number to your version of Python). You
+ can test Python support from the command line:
+ </p>
+ <pre>
+python
+>>> import libvirt
+>>> conn = libvirt.open ("test:///default")
+>>> conn.listDomainsID ()
+[1]
+>>> dom = conn.lookupByID (1)
+>>> dom.XMLDesc (0)
+"<domain type='test' id='1'> ..."
+</pre>
+ <p>
+ The most common failure will be with <code>import libvirt</code>
+ which usually indicates that either <code>PYTHONPATH</code> is
+ wrong or a DLL cannot be loaded.
+ </p>
+ </li>
+ </ol>
+ </body>
+</html>
projects / libvirt.git / commitdiff
