]> xenbits.xensource.com Git - people/liuw/libxenctrl-split/libvirt.git/commitdiff
Updated docs and comments, Daniel
authorDaniel Veillard <veillard@redhat.com>
Thu, 15 Dec 2005 14:51:18 +0000 (14:51 +0000)
committerDaniel Veillard <veillard@redhat.com>
Thu, 15 Dec 2005 14:51:18 +0000 (14:51 +0000)
docs/APIchunk0.html
docs/APIchunk1.html
docs/APIchunk2.html
docs/APIfiles.html
docs/APIfunctions.html
docs/APIsymbols.html
docs/html/libvir-libvir.html
docs/libvir-api.xml
docs/libvir-refs.xml
src/libvir.c

index 438f7c513bd31b6e8475b330a2a746efecb5ec5f..3eb3fd7af6cf0a8aefdf590ae40193c4845f4bf5 100644 (file)
@@ -7,10 +7,12 @@ H1 {font-family: Verdana,Arial,Helvetica}
 H2 {font-family: Verdana,Arial,Helvetica}
 H3 {font-family: Verdana,Arial,Helvetica}
 A:link, A:visited, A:active { text-decoration: underline }
-</style><title>API Alphabetic Index A-g for libvir</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000"><table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr><td width="120"><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo" /></a></td><td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center"><h1>Libvir the virtualization API</h1><h2>API Alphabetic Index A-g for libvir</h2></td></tr></table></td></tr></table></td></tr></table><table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Developer Menu</b></center></td></tr><tr><td bgcolor="#fffacd"><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><li><a href="index.html" style="font-weight:bold">Main Menu</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">ChangeLog</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="libvir.html">flat page</a>, <a href="site.xsl">stylesheet</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="APIchunk0.html">Alphabetic</a></li><li><a href="APIconstructors.html">Constructors</a></li><li><a href="APIfunctions.html">Functions/Types</a></li><li><a href="APIfiles.html">Modules</a></li><li><a href="APIsymbols.html">Symbols</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li></ul></td></tr></table></td></tr></table></td><td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd"><h2 align="center"><a href="APIchunk0.html">A-g</a>
-<a href="APIchunk1.html">h-t</a>
-<a href="APIchunk2.html">u-z</a>
+</style><title>API Alphabetic Index A-f for libvir</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000"><table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr><td width="120"><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo" /></a></td><td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center"><h1>Libvir the virtualization API</h1><h2>API Alphabetic Index A-f for libvir</h2></td></tr></table></td></tr></table></td></tr></table><table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Developer Menu</b></center></td></tr><tr><td bgcolor="#fffacd"><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><li><a href="index.html" style="font-weight:bold">Main Menu</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">ChangeLog</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="libvir.html">flat page</a>, <a href="site.xsl">stylesheet</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="APIchunk0.html">Alphabetic</a></li><li><a href="APIconstructors.html">Constructors</a></li><li><a href="APIfunctions.html">Functions/Types</a></li><li><a href="APIfiles.html">Modules</a></li><li><a href="APIsymbols.html">Symbols</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li></ul></td></tr></table></td></tr></table></td><td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd"><h2 align="center"><a href="APIchunk0.html">A-f</a>
+<a href="APIchunk1.html">g-s</a>
+<a href="APIchunk2.html">t-z</a>
 </h2><h2>Letter A:</h2><dl><dt>ABI</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
+</dd><dt>API</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd><dt>APIs</dt><dd><a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
 </dd></dl><h2>Letter C:</h2><dl><dt>CPU</dt><dd><a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd><dt>Collect</dt><dd><a href="html/libvir-libvir.html#virConnectListDomains">virConnectListDomains</a><br />
@@ -34,13 +36,14 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd></dl><h2>Letter L:</h2><dl><dt>Launch</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
 </dd><dt>Linux</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
 </dd></dl><h2>Letter M:</h2><dl><dt>Macro</dt><dd><a href="html/libvir-libvir.html#LIBVIR_VERSION_NUMBER">LIBVIR_VERSION_NUMBER</a><br />
-</dd></dl><h2>Letter N:</h2><dl><dt>NULL</dt><dd><a href="html/libvir-libvir.html#virConnectGetType">virConnectGetType</a><br />
+</dd></dl><h2>Letter N:</h2><dl><dt>NOTE:</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
+</dd><dt>NULL</dt><dd><a href="html/libvir-libvir.html#virConnectGetType">virConnectGetType</a><br />
 <a href="html/libvir-libvir.html#virConnectOpen">virConnectOpen</a><br />
 <a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
 <a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
-<a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
 <a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
 <a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByID">virDomainLookupByID</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
 <a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
@@ -48,7 +51,8 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd><dt>Note</dt><dd><a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
 </dd></dl><h2>Letter O:</h2><dl><dt>OUT</dt><dd><a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
-</dd></dl><h2>Letter P:</h2><dl><dt>Provides</dt><dd><a href="html/libvir-libvir.html#virConnectNumOfDomains">virConnectNumOfDomains</a><br />
+</dd></dl><h2>Letter P:</h2><dl><dt>Provide</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
+</dd><dt>Provides</dt><dd><a href="html/libvir-libvir.html#virConnectNumOfDomains">virConnectNumOfDomains</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd></dl><h2>Letter R:</h2><dl><dt>Read-Only</dt><dd><a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 </dd><dt>Resume</dt><dd><a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
@@ -59,13 +63,24 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 <a href="html/libvir-libvir.html#virConnectOpen">virConnectOpen</a><br />
 <a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
+<a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
+<a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
+<a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
+<a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
+<a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd><dt>Try</dt><dd><a href="html/libvir-libvir.html#virDomainLookupByID">virDomainLookupByID</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
-</dd></dl><h2>Letter U:</h2><dl><dt>Use</dt><dd><a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
-</dd></dl><h2>Letter X:</h2><dl><dt>Xen</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
+</dd></dl><h2>Letter U:</h2><dl><dt>UTF-8</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
+</dd><dt>Use</dt><dd><a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
+</dd></dl><h2>Letter X:</h2><dl><dt>XML</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
+</dd><dt>Xen</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd></dl><h2>Letter a:</h2><dl><dt>about</dt><dd><a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
 </dd><dt>access</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
 <a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
+<a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
+<a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
+<a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
+<a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
 <a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd><dt>active</dt><dd><a href="html/libvir-libvir.html#virConnectListDomains">virConnectListDomains</a><br />
 <a href="html/libvir-libvir.html#virConnectNumOfDomains">virConnectNumOfDomains</a><br />
@@ -98,6 +113,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd></dl><h2>Letter b:</h2><dl><dt>back</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>based</dt><dd><a href="html/libvir-libvir.html#virDomainLookupByID">virDomainLookupByID</a><br />
+<a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
 </dd><dt>below</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
 </dd><dt>but</dt><dd><a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd></dl><h2>Letter c:</h2><dl><dt>call</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
@@ -106,6 +122,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd><dt>called</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
 <a href="html/libvir-libvir.html#virConnectOpen">virConnectOpen</a><br />
 <a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
+</dd><dt>caller</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd><dt>calling</dt><dd><a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
 </dd><dt>can</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
 <a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
@@ -124,6 +141,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainGetID">virDomainGetID</a><br />
 <a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
 <a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByID">virDomainLookupByID</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
 <a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
@@ -131,6 +149,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>change</dt><dd><a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
+</dd><dt>changes</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd><dt>check</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
 </dd><dt>clients</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
 </dd><dt>closes</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
@@ -155,11 +174,14 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd></dl><h2>Letter d:</h2><dl><dt>data</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
 </dd><dt>deallocated</dt><dd><a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
+</dd><dt>defined</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
+</dd><dt>description</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd><dt>does</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 </dd><dt>domains</dt><dd><a href="html/libvir-libvir.html#virConnectListDomains">virConnectListDomains</a><br />
 <a href="html/libvir-libvir.html#virConnectNumOfDomains">virConnectNumOfDomains</a><br />
 </dd><dt>down</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
-</dd></dl><h2>Letter e:</h2><dl><dt>error</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
+</dd></dl><h2>Letter e:</h2><dl><dt>encoded</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
+</dd><dt>error</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
 <a href="html/libvir-libvir.html#virConnectGetType">virConnectGetType</a><br />
 <a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 <a href="html/libvir-libvir.html#virConnectListDomains">virConnectListDomains</a><br />
@@ -169,11 +191,13 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virDomainGetID">virDomainGetID</a><br />
 <a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>especially</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
 </dd><dt>extracted</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
 <a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 <a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
+</dd><dt>extraction</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd></dl><h2>Letter f:</h2><dl><dt>failure</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
 <a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
@@ -188,6 +212,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd><dt>find</dt><dd><a href="html/libvir-libvir.html#virDomainLookupByID">virDomainLookupByID</a><br />
 </dd><dt>first</dt><dd><a href="html/libvir-libvir.html#virConnectOpen">virConnectOpen</a><br />
 <a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
+</dd><dt>flags</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd><dt>for</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
 <a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 <a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
@@ -198,6 +223,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd><dt>format</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>found</dt><dd><a href="html/libvir-libvir.html#virConnectListDomains">virConnectListDomains</a><br />
 <a href="html/libvir-libvir.html#virConnectNumOfDomains">virConnectNumOfDomains</a><br />
+</dd><dt>free</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd><dt>freed</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
 </dd><dt>from</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
@@ -208,16 +234,14 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd><dt>function</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
 <a href="html/libvir-libvir.html#virConnectOpen">virConnectOpen</a><br />
 <a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
+<a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
+<a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
+<a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
+<a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
+<a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd><dt>further</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
 <a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
-</dd></dl><h2>Letter g:</h2><dl><dt>get</dt><dd><a href="html/libvir-libvir.html#virConnectOpen">virConnectOpen</a><br />
-<a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
-<a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
-<a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
-</dd><dt>given</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
-<a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
-</dd><dt>guest</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
-</dd></dl><h2 align="center"><a href="APIchunk0.html">A-g</a>
-<a href="APIchunk1.html">h-t</a>
-<a href="APIchunk2.html">u-z</a>
+</dd></dl><h2 align="center"><a href="APIchunk0.html">A-f</a>
+<a href="APIchunk1.html">g-s</a>
+<a href="APIchunk2.html">t-z</a>
 </h2><p><a href="bugs.html">Daniel Veillard</a></p></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></body></html>
index c1e6c17a7fa99f1556d96320a9a145ae348504fd..be05b8d9ec46581bd77e4ab8a2eb97a4bb35eae7 100644 (file)
@@ -7,10 +7,17 @@ H1 {font-family: Verdana,Arial,Helvetica}
 H2 {font-family: Verdana,Arial,Helvetica}
 H3 {font-family: Verdana,Arial,Helvetica}
 A:link, A:visited, A:active { text-decoration: underline }
-</style><title>API Alphabetic Index h-t for libvir</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000"><table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr><td width="120"><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo" /></a></td><td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center"><h1>Libvir the virtualization API</h1><h2>API Alphabetic Index h-t for libvir</h2></td></tr></table></td></tr></table></td></tr></table><table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Developer Menu</b></center></td></tr><tr><td bgcolor="#fffacd"><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><li><a href="index.html" style="font-weight:bold">Main Menu</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">ChangeLog</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="libvir.html">flat page</a>, <a href="site.xsl">stylesheet</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="APIchunk0.html">Alphabetic</a></li><li><a href="APIconstructors.html">Constructors</a></li><li><a href="APIfunctions.html">Functions/Types</a></li><li><a href="APIfiles.html">Modules</a></li><li><a href="APIsymbols.html">Symbols</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li></ul></td></tr></table></td></tr></table></td><td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd"><h2 align="center"><a href="APIchunk0.html">A-g</a>
-<a href="APIchunk1.html">h-t</a>
-<a href="APIchunk2.html">u-z</a>
-</h2><h2>Letter h:</h2><dl><dt>have</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
+</style><title>API Alphabetic Index g-s for libvir</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000"><table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr><td width="120"><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo" /></a></td><td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center"><h1>Libvir the virtualization API</h1><h2>API Alphabetic Index g-s for libvir</h2></td></tr></table></td></tr></table></td></tr></table><table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Developer Menu</b></center></td></tr><tr><td bgcolor="#fffacd"><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><li><a href="index.html" style="font-weight:bold">Main Menu</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">ChangeLog</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="libvir.html">flat page</a>, <a href="site.xsl">stylesheet</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="APIchunk0.html">Alphabetic</a></li><li><a href="APIconstructors.html">Constructors</a></li><li><a href="APIfunctions.html">Functions/Types</a></li><li><a href="APIfiles.html">Modules</a></li><li><a href="APIsymbols.html">Symbols</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li></ul></td></tr></table></td></tr></table></td><td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd"><h2 align="center"><a href="APIchunk0.html">A-f</a>
+<a href="APIchunk1.html">g-s</a>
+<a href="APIchunk2.html">t-z</a>
+</h2><h2>Letter g:</h2><dl><dt>get</dt><dd><a href="html/libvir-libvir.html#virConnectOpen">virConnectOpen</a><br />
+<a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
+<a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
+<a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
+</dd><dt>given</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
+<a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
+</dd><dt>guest</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
+</dd></dl><h2>Letter h:</h2><dl><dt>have</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>hypervisor</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
 <a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
 <a href="html/libvir-libvir.html#virConnectGetType">virConnectGetType</a><br />
@@ -24,6 +31,8 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainGetID">virDomainGetID</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByID">virDomainLookupByID</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
+<a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
+<a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
 <a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd></dl><h2>Letter i:</h2><dl><dt>image</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
@@ -33,9 +42,11 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd><dt>initrd</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
 </dd><dt>instance</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd><dt>int</dt><dd><a href="html/libvir-libvir.html#virDomainGetID">virDomainGetID</a><br />
 </dd><dt>interaction</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
 </dd><dt>its</dt><dd><a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
+<a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
 </dd></dl><h2>Letter k:</h2><dl><dt>kept</dt><dd><a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
 </dd><dt>kernel</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
 </dd><dt>kilobytes</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
@@ -69,6 +80,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>monitoring</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
+</dd><dt>must</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd></dl><h2>Letter n:</h2><dl><dt>name</dt><dd><a href="html/libvir-libvir.html#virConnectGetType">virConnectGetType</a><br />
 <a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
@@ -83,6 +95,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
 <a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>number</dt><dd><a href="html/libvir-libvir.html#virConnectListDomains">virConnectListDomains</a><br />
 <a href="html/libvir-libvir.html#virConnectNumOfDomains">virConnectNumOfDomains</a><br />
@@ -95,6 +108,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
 <a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
 <a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByID">virDomainLookupByID</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
 <a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
@@ -132,6 +146,11 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainLookupByName">virDomainLookupByName</a><br />
 </dd><dt>private</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
 </dd><dt>priviledged</dt><dd><a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
+<a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
+<a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
+<a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
+<a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
+<a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd><dt>process</dt><dd><a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
 <a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd><dt>protection</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
@@ -142,6 +161,11 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd><dt>read-only</dt><dd><a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
 </dd><dt>release</dt><dd><a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
+</dd><dt>requires</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
+<a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
+<a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
+<a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
+<a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd><dt>reserved</dt><dd><a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
 <a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
 </dd><dt>resources</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
@@ -151,7 +175,8 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd><dt>return</dt><dd><a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 <a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
-</dd><dt>returned</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
+</dd><dt>returned</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
+<a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>returns</dt><dd><a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 </dd><dt>running</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
 <a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
@@ -164,6 +189,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 </dd><dt>set</dt><dd><a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
 <a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
 <a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd><dt>should</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
 <a href="html/libvir-libvir.html#virConnectOpen">virConnectOpen</a><br />
 <a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
@@ -188,6 +214,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
 <a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
+</dd><dt>subject</dt><dd><a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd><dt>success</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
 <a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
@@ -196,23 +223,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
 <a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd><dt>suspended</dt><dd><a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
-</dd></dl><h2>Letter t:</h2><dl><dt>term</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
-</dd><dt>terminated</dt><dd><a href="html/libvir-libvir.html#virConnectGetType">virConnectGetType</a><br />
-</dd><dt>that</dt><dd><a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
-<a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
-</dd><dt>their</dt><dd><a href="html/libvir-libvir.html#virConnectListDomains">virConnectListDomains</a><br />
-</dd><dt>then</dt><dd><a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
-<a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
-<a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
-</dd><dt>there</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
-</dd><dt>thereafter</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
-<a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
-</dd><dt>this</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
-<a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
-<a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
-</dd><dt>two</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
-</dd><dt>type</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
-</dd></dl><h2 align="center"><a href="APIchunk0.html">A-g</a>
-<a href="APIchunk1.html">h-t</a>
-<a href="APIchunk2.html">u-z</a>
+</dd></dl><h2 align="center"><a href="APIchunk0.html">A-f</a>
+<a href="APIchunk1.html">g-s</a>
+<a href="APIchunk2.html">t-z</a>
 </h2><p><a href="bugs.html">Daniel Veillard</a></p></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></body></html>
index ef4642eb4b08cc1a840ddc7ad7e09a0393c729df..3dd0abe6cde2074c0ed1ba8be4bc370b8d042045 100644 (file)
@@ -7,10 +7,29 @@ H1 {font-family: Verdana,Arial,Helvetica}
 H2 {font-family: Verdana,Arial,Helvetica}
 H3 {font-family: Verdana,Arial,Helvetica}
 A:link, A:visited, A:active { text-decoration: underline }
-</style><title>API Alphabetic Index u-z for libvir</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000"><table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr><td width="120"><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo" /></a></td><td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center"><h1>Libvir the virtualization API</h1><h2>API Alphabetic Index u-z for libvir</h2></td></tr></table></td></tr></table></td></tr></table><table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Developer Menu</b></center></td></tr><tr><td bgcolor="#fffacd"><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><li><a href="index.html" style="font-weight:bold">Main Menu</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">ChangeLog</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="libvir.html">flat page</a>, <a href="site.xsl">stylesheet</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="APIchunk0.html">Alphabetic</a></li><li><a href="APIconstructors.html">Constructors</a></li><li><a href="APIfunctions.html">Functions/Types</a></li><li><a href="APIfiles.html">Modules</a></li><li><a href="APIsymbols.html">Symbols</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li></ul></td></tr></table></td></tr></table></td><td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd"><h2 align="center"><a href="APIchunk0.html">A-g</a>
-<a href="APIchunk1.html">h-t</a>
-<a href="APIchunk2.html">u-z</a>
-</h2><h2>Letter u:</h2><dl><dt>unknown</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
+</style><title>API Alphabetic Index t-z for libvir</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000"><table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr><td width="120"><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo" /></a></td><td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center"><h1>Libvir the virtualization API</h1><h2>API Alphabetic Index t-z for libvir</h2></td></tr></table></td></tr></table></td></tr></table><table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Developer Menu</b></center></td></tr><tr><td bgcolor="#fffacd"><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><li><a href="index.html" style="font-weight:bold">Main Menu</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">ChangeLog</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="libvir.html">flat page</a>, <a href="site.xsl">stylesheet</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="APIchunk0.html">Alphabetic</a></li><li><a href="APIconstructors.html">Constructors</a></li><li><a href="APIfunctions.html">Functions/Types</a></li><li><a href="APIfiles.html">Modules</a></li><li><a href="APIsymbols.html">Symbols</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li></ul></td></tr></table></td></tr></table></td><td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd"><h2 align="center"><a href="APIchunk0.html">A-f</a>
+<a href="APIchunk1.html">g-s</a>
+<a href="APIchunk2.html">t-z</a>
+</h2><h2>Letter t:</h2><dl><dt>term</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
+</dd><dt>terminated</dt><dd><a href="html/libvir-libvir.html#virConnectGetType">virConnectGetType</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
+</dd><dt>that</dt><dd><a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
+<a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
+</dd><dt>their</dt><dd><a href="html/libvir-libvir.html#virConnectListDomains">virConnectListDomains</a><br />
+</dd><dt>then</dt><dd><a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
+<a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
+<a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
+</dd><dt>there</dt><dd><a href="html/libvir-libvir.html#virConnectClose">virConnectClose</a><br />
+</dd><dt>thereafter</dt><dd><a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
+<a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
+</dd><dt>this</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
+<a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
+<a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
+</dd><dt>two</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
+</dd><dt>type</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
+</dd></dl><h2>Letter u:</h2><dl><dt>unimplemented</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
+</dd><dt>unknown</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>unsigned</dt><dd><a href="html/libvir-libvir.html#virDomainGetID">virDomainGetID</a><br />
 </dd><dt>unused</dt><dd><a href="html/libvir-libvir.html#virConnectOpen">virConnectOpen</a><br />
 <a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
@@ -20,9 +39,11 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainDestroy">virDomainDestroy</a><br />
 <a href="html/libvir-libvir.html#virDomainFree">virDomainFree</a><br />
 <a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 <a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd><dt>user</dt><dd><a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
 </dd></dl><h2>Letter v:</h2><dl><dt>value</dt><dd><a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 <a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>values</dt><dd><a href="html/libvir-libvir.html#virGetVersion">virGetVersion</a><br />
 </dd><dt>version</dt><dd><a href="html/libvir-libvir.html#LIBVIR_VERSION_NUMBER">LIBVIR_VERSION_NUMBER</a><br />
@@ -50,11 +71,14 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
 </dd><dt>without</dt><dd><a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
 </dd><dt>work</dt><dd><a href="html/libvir-libvir.html#virConnectGetVersion">virConnectGetVersion</a><br />
+</dd><dt>would</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
 </dd></dl><h2>Letter x:</h2><dl><dt>xen</dt><dd><a href="html/libvir-libvir.html#virConnectOpen">virConnectOpen</a><br />
 <a href="html/libvir-libvir.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a><br />
 </dd><dt>xenstore</dt><dd><a href="html/libvir-libvir.html#_virDomainInfo">_virDomainInfo</a><br />
+</dd></dl><h2>Letter y:</h2><dl><dt>yet</dt><dd><a href="html/libvir-libvir.html#virDomainCreateLinux">virDomainCreateLinux</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 </dd></dl><h2>Letter z:</h2><dl><dt>zero</dt><dd><a href="html/libvir-libvir.html#virConnectGetType">virConnectGetType</a><br />
-</dd></dl><h2 align="center"><a href="APIchunk0.html">A-g</a>
-<a href="APIchunk1.html">h-t</a>
-<a href="APIchunk2.html">u-z</a>
+</dd></dl><h2 align="center"><a href="APIchunk0.html">A-f</a>
+<a href="APIchunk1.html">g-s</a>
+<a href="APIchunk2.html">t-z</a>
 </h2><p><a href="bugs.html">Daniel Veillard</a></p></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></body></html>
index 148f041fad43463fae5da9890251a77b38282421..a57f7c865de547852300745e84e808491b46f2e4 100644 (file)
@@ -34,6 +34,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
 <a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
 <a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 <a href="html/libvir-libvir.html#virDomainInfo">virDomainInfo</a><br />
 <a href="html/libvir-libvir.html#virDomainInfoPtr">virDomainInfoPtr</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByID">virDomainLookupByID</a><br />
index ca3094986e295d3642334b53a30f01c19dcd0ec0..6c9d9f86e4d7c65e9d5c0f8d244ed7f456555387 100644 (file)
@@ -28,6 +28,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
 <a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
 <a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 <a href="html/libvir-libvir.html#virDomainResume">virDomainResume</a><br />
 <a href="html/libvir-libvir.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a><br />
 <a href="html/libvir-libvir.html#virDomainSuspend">virDomainSuspend</a><br />
index 8552693e7c88927f6885f642ee1b8ad40296c668..069896aa057447ea3cee48aebca5bf5dff9cabc3 100644 (file)
@@ -34,6 +34,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 <a href="html/libvir-libvir.html#virDomainGetInfo">virDomainGetInfo</a><br />
 <a href="html/libvir-libvir.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
 <a href="html/libvir-libvir.html#virDomainGetName">virDomainGetName</a><br />
+<a href="html/libvir-libvir.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a><br />
 <a href="html/libvir-libvir.html#virDomainInfo">virDomainInfo</a><br />
 <a href="html/libvir-libvir.html#virDomainInfoPtr">virDomainInfoPtr</a><br />
 <a href="html/libvir-libvir.html#virDomainLookupByID">virDomainLookupByID</a><br />
index 54c457534723be7ed5ce8ed422aa3d0e59bf827b..08841a39985fb72d6b97a3b95c2d28fadb1f2af2 100644 (file)
@@ -34,6 +34,7 @@ The content of this structure is not made public by the API.
 <pre class="programlisting">int        <a href="#virDomainGetInfo">virDomainGetInfo</a>                (<a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a> domain, <br />                                       <a href="libvir-libvir.html#virDomainInfoPtr">virDomainInfoPtr</a> info)</pre>
 <pre class="programlisting">unsigned long      <a href="#virDomainGetMaxMemory">virDomainGetMaxMemory</a>      (<a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a> domain)</pre>
 <pre class="programlisting">const char *       <a href="#virDomainGetName">virDomainGetName</a>        (<a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a> domain)</pre>
+<pre class="programlisting">char *     <a href="#virDomainGetXMLDesc">virDomainGetXMLDesc</a>          (<a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a> domain, <br />                                       int flags)</pre>
 <pre class="programlisting"><a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainLookupByID">virDomainLookupByID</a>  (<a href="libvir-libvir.html#virConnectPtr">virConnectPtr</a> conn, <br />                                       int id)</pre>
 <pre class="programlisting"><a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a> <a href="#virDomainLookupByName">virDomainLookupByName</a>      (<a href="libvir-libvir.html#virConnectPtr">virConnectPtr</a> conn, <br />                                       const char * name)</pre>
 <pre class="programlisting">int        <a href="#virDomainResume">virDomainResume</a>                  (<a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a> domain)</pre>
@@ -84,29 +85,31 @@ The content of this structure is not made public by the API.
 <div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>optional argument currently unused, pass NULL</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</td></tr></tbody></table></div><h3><a name="virConnectOpenReadOnly" id="virConnectOpenReadOnly"></a>Function: virConnectOpenReadOnly</h3><pre class="programlisting"><a href="libvir-libvir.html#virConnectPtr">virConnectPtr</a>     virConnectOpenReadOnly  (const char * name)<br />
 </pre><p>This function should be called first to get a read-only connection to the xen store. The set of APIs usable are then restricted.</p>
 <div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>optional argument currently unused, pass NULL</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</td></tr></tbody></table></div><h3><a name="virDomainCreateLinux" id="virDomainCreateLinux"></a>Function: virDomainCreateLinux</h3><pre class="programlisting"><a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a>     virDomainCreateLinux    (<a href="libvir-libvir.html#virConnectPtr">virConnectPtr</a> conn, <br />                                       const char * kernel_path, <br />                                        const char * initrd_path, <br />                                        const char * cmdline, <br />                                    unsigned long memory, <br />                                    unsigned int flags)<br />
-</pre><p>Launch a new Linux guest domain</p>
+</pre><p>Launch a new Linux guest domain, unimplemented yet, API to be defined. This would function requires priviledged 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>kernel_path</tt></i>:</span></td><td>the file path to the kernel image</td></tr><tr><td><span class="term"><i><tt>initrd_path</tt></i>:</span></td><td>an optional file path to an initrd</td></tr><tr><td><span class="term"><i><tt>cmdline</tt></i>:</span></td><td>optional command line parameters for the kernel</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>flags</tt></i>:</span></td><td>an optional set of <a href="libvir-libvir.html#virDomainFlags">virDomainFlags</a></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="virDomainDestroy" id="virDomainDestroy"></a>Function: virDomainDestroy</h3><pre class="programlisting">int     virDomainDestroy                (<a href="libvir-libvir.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.</p>
+</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 requires priviledged 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</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="virDomainFree" id="virDomainFree"></a>Function: virDomainFree</h3><pre class="programlisting">int     virDomainFree                   (<a href="libvir-libvir.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="virDomainGetID" id="virDomainGetID"></a>Function: virDomainGetID</h3><pre class="programlisting">unsigned int virDomainGetID          (<a href="libvir-libvir.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="libvir-libvir.html#virDomainPtr">virDomainPtr</a> domain, <br />                                       <a href="libvir-libvir.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 informations 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 or NULL</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer to a <a href="libvir-libvir.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="libvir-libvir.html#virDomainPtr">virDomainPtr</a> domain)<br />
+<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="libvir-libvir.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="libvir-libvir.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="virDomainGetName" id="virDomainGetName"></a>Function: virDomainGetName</h3><pre class="programlisting">const char *       virDomainGetName        (<a href="libvir-libvir.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="virDomainLookupByID" id="virDomainLookupByID"></a>Function: virDomainLookupByID</h3><pre class="programlisting"><a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a>      virDomainLookupByID     (<a href="libvir-libvir.html#virConnectPtr">virConnectPtr</a> conn, <br />                                       int id)<br />
+<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="virDomainGetXMLDesc" id="virDomainGetXMLDesc"></a>Function: virDomainGetXMLDesc</h3><pre class="programlisting">char *  virDomainGetXMLDesc             (<a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a> domain, <br />                                       int flags)<br />
+</pre><p>Provide an XML description of the domain. NOTE: this API is subject to changes.</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>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="virDomainLookupByID" id="virDomainLookupByID"></a>Function: virDomainLookupByID</h3><pre class="programlisting"><a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a>  virDomainLookupByID     (<a href="libvir-libvir.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</td></tr></tbody></table></div><h3><a name="virDomainLookupByName" id="virDomainLookupByName"></a>Function: virDomainLookupByName</h3><pre class="programlisting"><a href="libvir-libvir.html#virDomainPtr">virDomainPtr</a>        virDomainLookupByName   (<a href="libvir-libvir.html#virConnectPtr">virConnectPtr</a> conn, <br />                                       const char * name)<br />
-</pre><p>Try to lookup a domain on the given hypervisor</p>
+</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</td></tr></tbody></table></div><h3><a name="virDomainResume" id="virDomainResume"></a>Function: virDomainResume</h3><pre class="programlisting">int        virDomainResume                 (<a href="libvir-libvir.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().</p>
+</pre><p>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function requires priviledged 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</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="virDomainSetMaxMemory" id="virDomainSetMaxMemory"></a>Function: virDomainSetMaxMemory</h3><pre class="programlisting">int     virDomainSetMaxMemory           (<a href="libvir-libvir.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.</p>
+</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 priviledged 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="virDomainSuspend" id="virDomainSuspend"></a>Function: virDomainSuspend</h3><pre class="programlisting">int    virDomainSuspend                (<a href="libvir-libvir.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.</p>
+</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 requires priviledged 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</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="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 availble, 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>hypervisor type</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><p><a href="../bugs.html">Daniel Veillard</a></p></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></body></html>
index 06974d0c55c67f404dbdd83959a4aaf594eb7a96..879cbdd18f9a3b534fb6f9652b56d3bfe5d4fa8c 100644 (file)
@@ -33,6 +33,7 @@
      <exports symbol='virDomainLookupByID' type='function'/>
      <exports symbol='virDomainLookupByName' type='function'/>
      <exports symbol='virDomainCreateLinux' type='function'/>
+     <exports symbol='virDomainGetXMLDesc' type='function'/>
      <exports symbol='virConnectClose' type='function'/>
      <exports symbol='virConnectNumOfDomains' type='function'/>
      <exports symbol='virDomainResume' type='function'/>
       <arg name='name' type='const char *' info='optional argument currently unused, pass NULL'/>
     </function>
     <function name='virDomainCreateLinux' file='libvir' module='libvir'>
-      <info>Launch a new Linux guest domain</info>
+      <info>Launch a new Linux guest domain, unimplemented yet, API to be defined. This would function requires priviledged access to the hypervisor.</info>
       <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
       <arg name='kernel_path' type='const char *' info='the file path to the kernel image'/>
       <arg name='flags' type='unsigned int' info='an optional set of virDomainFlags'/>
     </function>
     <function name='virDomainDestroy' file='libvir' module='libvir'>
-      <info>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.</info>
+      <info>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 requires priviledged access to the hypervisor.</info>
       <return type='int' info='0 in case of success and -1 in case of failure.'/>
       <arg name='domain' type='virDomainPtr' info='a domain object'/>
     </function>
     <function name='virDomainGetInfo' file='libvir' module='libvir'>
       <info>Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the informations can be extracted.</info>
       <return type='int' info='0 in case of success and -1 in case of failure.'/>
-      <arg name='domain' type='virDomainPtr' info='a domain object or NULL'/>
+      <arg name='domain' type='virDomainPtr' info='a domain object'/>
       <arg name='info' type='virDomainInfoPtr' info='pointer to a virDomainInfo structure allocated by the user'/>
     </function>
     <function name='virDomainGetMaxMemory' file='libvir' module='libvir'>
       <return type='const char *' info='a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.'/>
       <arg name='domain' type='virDomainPtr' info='a domain object'/>
     </function>
+    <function name='virDomainGetXMLDesc' file='libvir' module='xml'>
+      <info>Provide an XML description of the domain. NOTE: this API is subject to changes.</info>
+      <return type='char *' info='a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.'/>
+      <arg name='domain' type='virDomainPtr' info='a domain object'/>
+      <arg name='flags' type='int' info='and OR&apos;ed set of extraction flags, not used yet'/>
+    </function>
     <function name='virDomainLookupByID' file='libvir' module='libvir'>
       <info>Try to find a domain based on the hypervisor ID number</info>
       <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
       <arg name='id' type='int' info='the domain ID number'/>
     </function>
     <function name='virDomainLookupByName' file='libvir' module='libvir'>
-      <info>Try to lookup a domain on the given hypervisor</info>
+      <info>Try to lookup a domain on the given hypervisor based on its name.</info>
       <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
       <arg name='name' type='const char *' info='name for the domain'/>
     </function>
     <function name='virDomainResume' file='libvir' module='libvir'>
-      <info>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain().</info>
+      <info>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function requires priviledged access to the hypervisor.</info>
       <return type='int' info='0 in case of success and -1 in case of failure.'/>
       <arg name='domain' type='virDomainPtr' info='a domain object'/>
     </function>
     <function name='virDomainSetMaxMemory' file='libvir' module='libvir'>
-      <info>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.</info>
+      <info>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 priviledged access to the hypervisor.</info>
       <return type='int' info='0 in case of success and -1 in case of failure.'/>
       <arg name='domain' type='virDomainPtr' info='a domain object or NULL'/>
       <arg name='memory' type='unsigned long' info='the memory size in kilobytes'/>
     </function>
     <function name='virDomainSuspend' file='libvir' module='libvir'>
-      <info>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.</info>
+      <info>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 requires priviledged access to the hypervisor.</info>
       <return type='int' info='0 in case of success and -1 in case of failure.'/>
       <arg name='domain' type='virDomainPtr' info='a domain object'/>
     </function>
index 9f2cf04e6c3d1d88e05298349a2291f1d376432b..57a0213d97006948cb1b1afd60c23b8403ac72a6 100644 (file)
@@ -28,6 +28,7 @@
     <reference name='virDomainGetInfo' href='html/libvir-libvir.html#virDomainGetInfo'/>
     <reference name='virDomainGetMaxMemory' href='html/libvir-libvir.html#virDomainGetMaxMemory'/>
     <reference name='virDomainGetName' href='html/libvir-libvir.html#virDomainGetName'/>
+    <reference name='virDomainGetXMLDesc' href='html/libvir-libvir.html#virDomainGetXMLDesc'/>
     <reference name='virDomainInfo' href='html/libvir-libvir.html#virDomainInfo'/>
     <reference name='virDomainInfoPtr' href='html/libvir-libvir.html#virDomainInfoPtr'/>
     <reference name='virDomainLookupByID' href='html/libvir-libvir.html#virDomainLookupByID'/>
@@ -74,6 +75,7 @@
       <ref name='virDomainGetInfo'/>
       <ref name='virDomainGetMaxMemory'/>
       <ref name='virDomainGetName'/>
+      <ref name='virDomainGetXMLDesc'/>
       <ref name='virDomainInfo'/>
       <ref name='virDomainInfoPtr'/>
       <ref name='virDomainLookupByID'/>
       <ref name='virDomainGetInfo'/>
       <ref name='virDomainGetMaxMemory'/>
       <ref name='virDomainGetName'/>
+      <ref name='virDomainGetXMLDesc'/>
       <ref name='virDomainResume'/>
       <ref name='virDomainSetMaxMemory'/>
       <ref name='virDomainSuspend'/>
       <ref name='virDomainGetInfo'/>
       <ref name='virDomainGetMaxMemory'/>
       <ref name='virDomainGetName'/>
+      <ref name='virDomainGetXMLDesc'/>
       <ref name='virDomainInfo'/>
       <ref name='virDomainInfoPtr'/>
       <ref name='virDomainLookupByID'/>
         <word name='ABI'>
           <ref name='_virDomainInfo'/>
         </word>
+        <word name='API'>
+          <ref name='virDomainCreateLinux'/>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='APIs'>
           <ref name='virConnectOpenReadOnly'/>
         </word>
         </word>
       </letter>
       <letter name='N'>
+        <word name='NOTE:'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='NULL'>
           <ref name='virConnectGetType'/>
           <ref name='virConnectOpen'/>
           <ref name='virConnectOpenReadOnly'/>
           <ref name='virDomainCreateLinux'/>
-          <ref name='virDomainGetInfo'/>
           <ref name='virDomainGetMaxMemory'/>
           <ref name='virDomainGetName'/>
+          <ref name='virDomainGetXMLDesc'/>
           <ref name='virDomainLookupByID'/>
           <ref name='virDomainLookupByName'/>
           <ref name='virDomainSetMaxMemory'/>
         </word>
       </letter>
       <letter name='P'>
+        <word name='Provide'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='Provides'>
           <ref name='virConnectNumOfDomains'/>
           <ref name='virGetVersion'/>
           <ref name='virConnectGetVersion'/>
           <ref name='virConnectOpen'/>
           <ref name='virConnectOpenReadOnly'/>
+          <ref name='virDomainCreateLinux'/>
+          <ref name='virDomainDestroy'/>
+          <ref name='virDomainResume'/>
+          <ref name='virDomainSetMaxMemory'/>
+          <ref name='virDomainSuspend'/>
         </word>
         <word name='Try'>
           <ref name='virDomainLookupByID'/>
         </word>
       </letter>
       <letter name='U'>
+        <word name='UTF-8'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='Use'>
           <ref name='virDomainSuspend'/>
         </word>
       </letter>
       <letter name='X'>
+        <word name='XML'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='Xen'>
           <ref name='virGetVersion'/>
         </word>
         <word name='access'>
           <ref name='_virDomainInfo'/>
           <ref name='virConnectGetVersion'/>
+          <ref name='virDomainCreateLinux'/>
+          <ref name='virDomainDestroy'/>
+          <ref name='virDomainResume'/>
+          <ref name='virDomainSetMaxMemory'/>
           <ref name='virDomainSuspend'/>
         </word>
         <word name='active'>
         </word>
         <word name='based'>
           <ref name='virDomainLookupByID'/>
+          <ref name='virDomainLookupByName'/>
         </word>
         <word name='below'>
           <ref name='_virDomainInfo'/>
           <ref name='virConnectOpen'/>
           <ref name='virConnectOpenReadOnly'/>
         </word>
+        <word name='caller'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='calling'>
           <ref name='virDomainResume'/>
         </word>
           <ref name='virDomainGetID'/>
           <ref name='virDomainGetInfo'/>
           <ref name='virDomainGetMaxMemory'/>
+          <ref name='virDomainGetXMLDesc'/>
           <ref name='virDomainLookupByID'/>
           <ref name='virDomainLookupByName'/>
           <ref name='virDomainResume'/>
         <word name='change'>
           <ref name='virDomainSetMaxMemory'/>
         </word>
+        <word name='changes'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='check'>
           <ref name='_virDomainInfo'/>
         </word>
         <word name='deallocated'>
           <ref name='virDomainGetName'/>
         </word>
+        <word name='defined'>
+          <ref name='virDomainCreateLinux'/>
+        </word>
+        <word name='description'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='does'>
           <ref name='virDomainDestroy'/>
         </word>
         </word>
       </letter>
       <letter name='e'>
+        <word name='encoded'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='error'>
           <ref name='virConnectClose'/>
           <ref name='virConnectGetType'/>
           <ref name='virDomainDestroy'/>
           <ref name='virDomainGetID'/>
           <ref name='virDomainGetMaxMemory'/>
+          <ref name='virDomainGetXMLDesc'/>
           <ref name='virGetVersion'/>
         </word>
         <word name='especially'>
           <ref name='virConnectGetVersion'/>
           <ref name='virDomainGetInfo'/>
         </word>
+        <word name='extraction'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
       </letter>
       <letter name='f'>
         <word name='failure'>
           <ref name='virConnectOpen'/>
           <ref name='virConnectOpenReadOnly'/>
         </word>
+        <word name='flags'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='for'>
           <ref name='_virDomainInfo'/>
           <ref name='virConnectGetVersion'/>
           <ref name='virConnectListDomains'/>
           <ref name='virConnectNumOfDomains'/>
         </word>
+        <word name='free'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='freed'>
           <ref name='virDomainDestroy'/>
           <ref name='virDomainFree'/>
           <ref name='virConnectClose'/>
           <ref name='virConnectOpen'/>
           <ref name='virConnectOpenReadOnly'/>
+          <ref name='virDomainCreateLinux'/>
+          <ref name='virDomainDestroy'/>
+          <ref name='virDomainResume'/>
+          <ref name='virDomainSetMaxMemory'/>
+          <ref name='virDomainSuspend'/>
         </word>
         <word name='further'>
           <ref name='virConnectClose'/>
           <ref name='virDomainSuspend'/>
         </word>
       </letter>
+    </chunk>
+    <chunk name='chunk1'>
       <letter name='g'>
         <word name='get'>
           <ref name='virConnectOpen'/>
           <ref name='virDomainCreateLinux'/>
         </word>
       </letter>
-    </chunk>
-    <chunk name='chunk1'>
       <letter name='h'>
         <word name='have'>
           <ref name='virGetVersion'/>
           <ref name='virDomainGetID'/>
           <ref name='virDomainLookupByID'/>
           <ref name='virDomainLookupByName'/>
+          <ref name='virDomainResume'/>
+          <ref name='virDomainSetMaxMemory'/>
           <ref name='virDomainSuspend'/>
           <ref name='virGetVersion'/>
         </word>
         <word name='instance'>
           <ref name='virDomainDestroy'/>
           <ref name='virDomainFree'/>
+          <ref name='virDomainGetXMLDesc'/>
         </word>
         <word name='int'>
           <ref name='virDomainGetID'/>
         </word>
         <word name='its'>
           <ref name='virDomainGetName'/>
+          <ref name='virDomainLookupByName'/>
         </word>
       </letter>
       <letter name='k'>
         <word name='monitoring'>
           <ref name='virConnectClose'/>
         </word>
+        <word name='must'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
       </letter>
       <letter name='n'>
         <word name='name'>
           <ref name='virDomainDestroy'/>
           <ref name='virDomainFree'/>
           <ref name='virDomainGetName'/>
+          <ref name='virDomainGetXMLDesc'/>
           <ref name='virGetVersion'/>
         </word>
         <word name='number'>
           <ref name='virDomainGetInfo'/>
           <ref name='virDomainGetMaxMemory'/>
           <ref name='virDomainGetName'/>
+          <ref name='virDomainGetXMLDesc'/>
           <ref name='virDomainLookupByID'/>
           <ref name='virDomainLookupByName'/>
           <ref name='virDomainResume'/>
         </word>
         <word name='priviledged'>
           <ref name='virConnectGetVersion'/>
+          <ref name='virDomainCreateLinux'/>
+          <ref name='virDomainDestroy'/>
+          <ref name='virDomainResume'/>
+          <ref name='virDomainSetMaxMemory'/>
+          <ref name='virDomainSuspend'/>
         </word>
         <word name='process'>
           <ref name='virDomainResume'/>
           <ref name='virConnectGetVersion'/>
           <ref name='virGetVersion'/>
         </word>
+        <word name='requires'>
+          <ref name='virDomainCreateLinux'/>
+          <ref name='virDomainDestroy'/>
+          <ref name='virDomainResume'/>
+          <ref name='virDomainSetMaxMemory'/>
+          <ref name='virDomainSuspend'/>
+        </word>
         <word name='reserved'>
           <ref name='virDomainGetMaxMemory'/>
           <ref name='virDomainSetMaxMemory'/>
           <ref name='virGetVersion'/>
         </word>
         <word name='returned'>
+          <ref name='virDomainGetXMLDesc'/>
           <ref name='virGetVersion'/>
         </word>
         <word name='returns'>
           <ref name='virConnectOpenReadOnly'/>
           <ref name='virDomainCreateLinux'/>
           <ref name='virDomainGetInfo'/>
+          <ref name='virDomainGetXMLDesc'/>
         </word>
         <word name='should'>
           <ref name='virConnectClose'/>
           <ref name='virDomainFree'/>
           <ref name='virDomainGetInfo'/>
         </word>
+        <word name='subject'>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
         <word name='success'>
           <ref name='virConnectClose'/>
           <ref name='virDomainDestroy'/>
           <ref name='virDomainResume'/>
         </word>
       </letter>
+    </chunk>
+    <chunk name='chunk2'>
       <letter name='t'>
         <word name='term'>
           <ref name='_virDomainInfo'/>
         </word>
         <word name='terminated'>
           <ref name='virConnectGetType'/>
+          <ref name='virDomainGetXMLDesc'/>
         </word>
         <word name='that'>
           <ref name='virDomainGetInfo'/>
         <word name='this'>
           <ref name='_virDomainInfo'/>
           <ref name='virDomainGetMaxMemory'/>
+          <ref name='virDomainGetXMLDesc'/>
           <ref name='virDomainSetMaxMemory'/>
         </word>
         <word name='two'>
           <ref name='virGetVersion'/>
         </word>
       </letter>
-    </chunk>
-    <chunk name='chunk2'>
       <letter name='u'>
+        <word name='unimplemented'>
+          <ref name='virDomainCreateLinux'/>
+        </word>
         <word name='unknown'>
           <ref name='virGetVersion'/>
         </word>
           <ref name='virDomainDestroy'/>
           <ref name='virDomainFree'/>
           <ref name='virDomainGetInfo'/>
+          <ref name='virDomainGetXMLDesc'/>
           <ref name='virDomainSuspend'/>
         </word>
         <word name='user'>
       <letter name='v'>
         <word name='value'>
           <ref name='virConnectGetVersion'/>
+          <ref name='virDomainGetXMLDesc'/>
           <ref name='virGetVersion'/>
         </word>
         <word name='values'>
         <word name='work'>
           <ref name='virConnectGetVersion'/>
         </word>
+        <word name='would'>
+          <ref name='virDomainCreateLinux'/>
+        </word>
       </letter>
       <letter name='x'>
         <word name='xen'>
           <ref name='_virDomainInfo'/>
         </word>
       </letter>
+      <letter name='y'>
+        <word name='yet'>
+          <ref name='virDomainCreateLinux'/>
+          <ref name='virDomainGetXMLDesc'/>
+        </word>
+      </letter>
       <letter name='z'>
         <word name='zero'>
           <ref name='virConnectGetType'/>
       </letter>
     </chunk>
     <chunks>
-      <chunk name='chunk0' start='A' end='g'/>
-      <chunk name='chunk1' start='h' end='t'/>
-      <chunk name='chunk2' start='u' end='z'/>
+      <chunk name='chunk0' start='A' end='f'/>
+      <chunk name='chunk1' start='g' end='s'/>
+      <chunk name='chunk2' start='t' end='z'/>
     </chunks>
   </index>
 </apirefs>
index 07ad35495ed09595f93a244dd09b7f69eb80ce5f..4e50e7e4603ebab569e318f64d88fbaff476dec4 100644 (file)
@@ -360,9 +360,8 @@ virConnectNumOfDomains(virConnectPtr conn) {
  * @memory: the memory size in kilobytes
  * @flags: an optional set of virDomainFlags
  *
- * Launch a new Linux guest domain 
- * Not implemented yet. Very likely to be modified in order to express
- * hardware informations in a convenient way.
+ * Launch a new Linux guest domain, unimplemented yet, API to be defined.
+ * This would function requires priviledged access to the hypervisor.
  * 
  * Returns a new domain object or NULL in case of failure
  */
@@ -583,6 +582,7 @@ done:
  * 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 requires priviledged access to the hypervisor.
  *
  * Returns 0 in case of success and -1 in case of failure.
  */
@@ -632,6 +632,7 @@ virDomainFree(virDomainPtr domain) {
  * 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 requires priviledged access to the hypervisor.
  *
  * Returns 0 in case of success and -1 in case of failure.
  */
@@ -650,6 +651,7 @@ virDomainSuspend(virDomainPtr domain) {
  *
  * Resume an suspended domain, the process is restarted from the state where
  * it was frozen by calling virSuspendDomain().
+ * This function requires priviledged access to the hypervisor.
  *
  * Returns 0 in case of success and -1 in case of failure.
  */
@@ -738,6 +740,7 @@ virDomainGetMaxMemory(virDomainPtr domain) {
  * 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 priviledged access to the hypervisor.
  *
  * Returns 0 in case of success and -1 in case of failure.
  */