<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!--
This file is autogenerated from api-reference.html.in
Do not edit this file. Changes will be lost.
-->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="main.css" />
<link rel="SHORTCUT ICON" href="graphics/32favicon.png" />
<title>libvirt-php: PHP API Reference guide</title>
<meta name="description" content="libvirt, virtualization, virtualization API" />
</head>
<body>
<div id="header">
<div id="headerLogo"></div>
<div id="headerSearch">
<form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
<input id="query" name="query" type="text" size="12" value="" />
<input id="submit" name="submit" type="submit" value="Search" />
</div></form>
</div>
</div>
<div id="body">
<div id="menu">
<ul class="l0"><li>
<div>
<a title="Front page of the libvirt-php website" class="inactive" href="index.html">Home</a>
</div>
</li><li>
<div>
<a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
</div>
</li><li>
<div>
<a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
</div>
</li><li>
<div>
<a title="Information on libvirt-php Windows port" class="inactive" href="windows.html">Windows port</a>
</div>
</li><li>
<div>
<a title="Information on contributing to libvirt-php" class="inactive" href="contributions.html">Contributions</a>
</div>
</li><li>
<div>
<a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
<ul class="l1"><li>
<div>
<span class="active">PHP API Reference</span>
</div>
</li><li>
<div>
<a title="libvirt-php developer's API reference (private functions)" class="inactive" href="dev-api-reference.html">Developer's API Reference</a>
</div>
</li><li>
<div>
<a title="How to compile libvirt-php" class="inactive" href="compiling.html">Compiling</a>
</div>
</li><li>
<div>
<a title="Information about deploying and using libvirt-php" class="inactive" href="deployment.html">Deployment</a>
</div>
</li><li>
<div>
<a title="Example scripts using libvirt-php" class="inactive" href="examples.html">Examples</a>
</div>
</li></ul>
</div>
</li><li>
<div>
<a title="List of companies and people using the project" class="inactive" href="references.html">References</a>
</div>
</li><li>
<div>
<a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
</div>
</li><li>
<div>
<a title="List of links related to libvirt-php project" class="inactive" href="links.html">Related links</a>
</div>
</li><li>
<div>
<a title="List of features to be implemented" class="inactive" href="roadmap.html">Roadmap</a>
</div>
</li><li>
<div>
<a title="Libvirt-php site map" class="inactive" href="sitemap.html">Sitemap</a>
</div>
</li></ul>
</div>
<div id="content">
<h1>PHP API Reference guide</h1>
<h3>Functions</h3>
<pre>Total number of functions: 81. Functions supported are:<br /><br /><a href="#libvirt_get_last_error"><code>libvirt_get_last_error</code></a>()<br /><a href="#libvirt_connect"><code>libvirt_connect</code></a>($url, $readonly, $credentials)<br /><a href="#libvirt_node_get_info"><code>libvirt_node_get_info</code></a>($conn)<br /><a href="#libvirt_get_uri"><code>libvirt_get_uri</code></a>($conn)<br /><a href="#libvirt_get_hostname"><code>libvirt_get_hostname</code></a>($conn)<br /><a href="#libvirt_domain_get_counts"><code>libvirt_domain_get_counts</code></a>($conn)<br /><a href="#libvirt_domain_get_autostart"><code>libvirt_domain_get_autostart</code></a>($res)<br /><a href="#libvirt_domain_set_autostart"><code>libvirt_domain_set_autostart</code></a>($res, $flags)<br /><a href="#libvirt_domain_is_active"><code>libvirt_domain_is_active</code></a>($res)<br /><a href="#libvirt_domain_lookup_by_name"><code>libvirt_domain_lookup_by_name</code></a>($res, $name)<br /><a href="#libvirt_domain_lookup_by_uuid"><code>libvirt_domain_lookup_by_uuid</code></a>($res, $uuid)<br /><a href="#libvirt_domain_lookup_by_uuid_string"><code>libvirt_domain_lookup_by_uuid_string</code></a>($res, $uuid)<br /><a href="#libvirt_domain_lookup_by_id"><code>libvirt_domain_lookup_by_id</code></a>($conn, $id)<br /><a href="#libvirt_domain_get_name"><code>libvirt_domain_get_name</code></a>($res)<br /><a href="#libvirt_domain_get_uuid_string"><code>libvirt_domain_get_uuid_string</code></a>($res)<br /><a href="#libvirt_domain_get_uuid"><code>libvirt_domain_get_uuid</code></a>($res)<br /><a href="#libvirt_domain_get_id"><code>libvirt_domain_get_id</code></a>($res)<br /><a href="#libvirt_domain_get_xml_desc"><code>libvirt_domain_get_xml_desc</code></a>($res)<br /><a href="#libvirt_domain_get_info"><code>libvirt_domain_get_info</code></a>($res)<br /><a href="#libvirt_domain_create"><code>libvirt_domain_create</code></a>($res)<br /><a href="#libvirt_domain_destroy"><code>libvirt_domain_destroy</code></a>($res)<br /><a href="#libvirt_domain_resume"><code>libvirt_domain_resume</code></a>($res)<br /><a href="#libvirt_domain_shutdown"><code>libvirt_domain_shutdown</code></a>($res)<br /><a href="#libvirt_domain_suspend"><code>libvirt_domain_suspend</code></a>($res)<br /><a href="#libvirt_domain_undefine"><code>libvirt_domain_undefine</code></a>($res)<br /><a href="#libvirt_domain_reboot"><code>libvirt_domain_reboot</code></a>($res)<br /><a href="#libvirt_domain_define_xml"><code>libvirt_domain_define_xml</code></a>($conn, $xml)<br /><a href="#libvirt_domain_create_xml"><code>libvirt_domain_create_xml</code></a>($conn, $xml)<br /><a href="#libvirt_domain_memory_peek"><code>libvirt_domain_memory_peek</code></a>($res)<br /><a href="#libvirt_domain_memory_stats"><code>libvirt_domain_memory_stats</code></a>($res)<br /><a href="#libvirt_domain_update_device"><code>libvirt_domain_update_device</code></a>($res, $xml, $flags)<br /><a href="#libvirt_domain_block_stats"><code>libvirt_domain_block_stats</code></a>($res, $path)<br /><a href="#libvirt_domain_get_network_info"><code>libvirt_domain_get_network_info</code></a>($res, $mac)<br /><a href="#libvirt_domain_get_block_info"><code>libvirt_domain_get_block_info</code></a>($res, $dev)<br /><a href="#libvirt_domain_xml_xpath"><code>libvirt_domain_xml_xpath</code></a>($res, $xpath)<br /><a href="#libvirt_domain_interface_stats"><code>libvirt_domain_interface_stats</code></a>($res, $path)<br /><a href="#libvirt_domain_get_connect"><code>libvirt_domain_get_connect</code></a>($res)<br /><a href="#libvirt_domain_migrate_to_uri"><code>libvirt_domain_migrate_to_uri</code></a>($res, $dest_uri, $flags, $dname, $bandwidth)<br /><a href="#libvirt_domain_migrate"><code>libvirt_domain_migrate</code></a>($res, $dest_conn, $flags, $dname, $bandwidth)<br /><a href="#libvirt_domain_get_job_info"><code>libvirt_domain_get_job_info</code></a>($res)<br /><a href="#libvirt_storagepool_lookup_by_name"><code>libvirt_storagepool_lookup_by_name</code></a>($res, $name)<br /><a href="#libvirt_storagepool_list_volumes"><code>libvirt_storagepool_list_volumes</code></a>($res)<br /><a href="#libvirt_storagepool_get_info"><code>libvirt_storagepool_get_info</code></a>($res)<br /><a href="#libvirt_storagevolume_lookup_by_name"><code>libvirt_storagevolume_lookup_by_name</code></a>($res, $name)<br /><a href="#libvirt_storagevolume_get_info"><code>libvirt_storagevolume_get_info</code></a>($res)<br /><a href="#libvirt_storagevolume_get_xml_desc"><code>libvirt_storagevolume_get_xml_desc</code></a>($res)<br /><a href="#libvirt_storagevolume_create_xml"><code>libvirt_storagevolume_create_xml</code></a>($res, $xml)<br /><a href="#libvirt_storagepool_get_uuid_string"><code>libvirt_storagepool_get_uuid_string</code></a>($res)<br /><a href="#libvirt_storagepool_get_name"><code>libvirt_storagepool_get_name</code></a>($res)<br /><a href="#libvirt_storagepool_lookup_by_uuid_string"><code>libvirt_storagepool_lookup_by_uuid_string</code></a>($res, $uuid)<br /><a href="#libvirt_storagepool_get_xml_desc"><code>libvirt_storagepool_get_xml_desc</code></a>($res)<br /><a href="#libvirt_storagepool_define_xml"><code>libvirt_storagepool_define_xml</code></a>($res, $xml, $flags)<br /><a href="#libvirt_storagepool_undefine"><code>libvirt_storagepool_undefine</code></a>($res)<br /><a href="#libvirt_storagepool_create"><code>libvirt_storagepool_create</code></a>($res)<br /><a href="#libvirt_storagepool_destroy"><code>libvirt_storagepool_destroy</code></a>($res)<br /><a href="#libvirt_storagepool_is_active"><code>libvirt_storagepool_is_active</code></a>($res)<br /><a href="#libvirt_storagepool_get_volume_count"><code>libvirt_storagepool_get_volume_count</code></a>($res)<br /><a href="#libvirt_storagepool_refresh"><code>libvirt_storagepool_refresh</code></a>($res, $flags)<br /><a href="#libvirt_storagepool_set_autostart"><code>libvirt_storagepool_set_autostart</code></a>($res, $flags)<br /><a href="#libvirt_storagepool_get_autostart"><code>libvirt_storagepool_get_autostart</code></a>($res)<br /><a href="#libvirt_list_storagepools"><code>libvirt_list_storagepools</code></a>($res)<br /><a href="#libvirt_list_active_storagepools"><code>libvirt_list_active_storagepools</code></a>($res)<br /><a href="#libvirt_list_inactive_storagepools"><code>libvirt_list_inactive_storagepools</code></a>($res)<br /><a href="#libvirt_list_domains"><code>libvirt_list_domains</code></a>($res)<br /><a href="#libvirt_list_domain_resources"><code>libvirt_list_domain_resources</code></a>($res)<br /><a href="#libvirt_list_active_domain_ids"><code>libvirt_list_active_domain_ids</code></a>($res)<br /><a href="#libvirt_list_active_domains"><code>libvirt_list_active_domains</code></a>($res)<br /><a href="#libvirt_list_inactive_domains"><code>libvirt_list_inactive_domains</code></a>($res)<br /><a href="#libvirt_list_networks"><code>libvirt_list_networks</code></a>($res, $flags)<br /><a href="#libvirt_list_nodedevs"><code>libvirt_list_nodedevs</code></a>($res, $cap)<br /><a href="#libvirt_nodedev_get"><code>libvirt_nodedev_get</code></a>($res, $name)<br /><a href="#libvirt_nodedev_capabilities"><code>libvirt_nodedev_capabilities</code></a>($res)<br /><a href="#libvirt_nodedev_get_xml_desc"><code>libvirt_nodedev_get_xml_desc</code></a>($res)<br /><a href="#libvirt_nodedev_get_information"><code>libvirt_nodedev_get_information</code></a>($res)<br /><a href="#libvirt_network_get"><code>libvirt_network_get</code></a>($res, $name)<br /><a href="#libvirt_network_get_bridge"><code>libvirt_network_get_bridge</code></a>($res)<br /><a href="#libvirt_network_get_active"><code>libvirt_network_get_active</code></a>($res)<br /><a href="#libvirt_network_get_information"><code>libvirt_network_get_information</code></a>($res)<br /><a href="#libvirt_network_set_active"><code>libvirt_network_set_active</code></a>($res)<br /><a href="#libvirt_network_get_xml_desc"><code>libvirt_network_get_xml_desc</code></a>($res)<br /><a href="#libvirt_version"><code>libvirt_version</code></a>($type)<br /><a href="#libvirt_check_version"><code>libvirt_check_version</code></a>($major, $minor, $micro, $type)<br /></pre>
<h3>
<a name="libvirt_get_last_error" id="libvirt_get_last_error">
<code>libvirt_get_last_error</code>
</a>
</h3>
<pre class="programlisting">libvirt_get_last_error()</pre>
<p>This function is used to get the last error coming either from libvirt or the PHP extension itself.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
last error string
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_connect" id="libvirt_connect">
<code>libvirt_connect</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect($url, $readonly, $credentials)</pre>
<p>libvirt_connect() is used to connect to the specified libvirt daemon using the specified URL, user can also set the readonly flag and/or set credentials for connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@url [string]</tt></i>:</span>
</td><td>
URI for connection
</td></tr><tr><td>
<span class="term"><i><tt>@readonly [bool]</tt></i>:</span>
</td><td>
flag whether to use read-only connection or not
</td></tr><tr><td>
<span class="term"><i><tt>@credentials [array]</tt></i>:</span>
</td><td>
array of connection credentials
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_node_get_info" id="libvirt_node_get_info">
<code>libvirt_node_get_info</code>
</a>
</h3>
<pre class="programlisting">libvirt_node_get_info($conn)</pre>
<p>Function is used to get the information about host node, mainly total memory installed, total CPUs installed and model information are useful.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@conn [resource]</tt></i>:</span>
</td><td>
resource for connection
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
array of node information
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_get_uri" id="libvirt_get_uri">
<code>libvirt_get_uri</code>
</a>
</h3>
<pre class="programlisting">libvirt_get_uri($conn)</pre>
<p>Function is used to get the connection URI. This is useful to check the hypervisor type of host machine when using "null" uri to libvirt_connect().</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@conn [resource]</tt></i>:</span>
</td><td>
resource for connection
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
connection URI string
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_get_hostname" id="libvirt_get_hostname">
<code>libvirt_get_hostname</code>
</a>
</h3>
<pre class="programlisting">libvirt_get_hostname($conn)</pre>
<p>Function is used to get the hostname of the guest associated with the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@conn [resource]</tt></i>:</span>
</td><td>
resource for connection
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
hostname of the host node
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_counts" id="libvirt_domain_get_counts">
<code>libvirt_domain_get_counts</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_counts($conn)</pre>
<p>Function is getting domain counts for all, active and inactive domains.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@conn [resource]</tt></i>:</span>
</td><td>
libvirt connection resource from libvirt_connect()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
array of total, active and inactive (but defined) domain counts
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_autostart" id="libvirt_domain_get_autostart">
<code>libvirt_domain_get_autostart</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_autostart($res)</pre>
<p>Function is getting the autostart value for the domain.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
autostart value or -1
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_set_autostart" id="libvirt_domain_set_autostart">
<code>libvirt_domain_set_autostart</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_set_autostart($res, $flags)</pre>
<p>Function is setting the autostart value for the domain.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource
</td></tr><tr><td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td><td>
flag to enable/disable autostart
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
TRUE on success, FALSE on error
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_is_active" id="libvirt_domain_is_active">
<code>libvirt_domain_is_active</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_is_active($res)</pre>
<p>Function is getting information whether domain identified by resource is active or not.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
virDomainIsActive() result on the domain
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_lookup_by_name" id="libvirt_domain_lookup_by_name">
<code>libvirt_domain_lookup_by_name</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_lookup_by_name($res, $name)</pre>
<p>Function is used to lookup for domain by it's name.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource from libvirt_connect()
</td></tr><tr><td>
<span class="term"><i><tt>@name [string]</tt></i>:</span>
</td><td>
domain name to look for
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt domain resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_lookup_by_uuid" id="libvirt_domain_lookup_by_uuid">
<code>libvirt_domain_lookup_by_uuid</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_lookup_by_uuid($res, $uuid)</pre>
<p>Function is used to lookup for domain by it's UUID in the binary format.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource from libvirt_connect()
</td></tr><tr><td>
<span class="term"><i><tt>@uuid [string]</tt></i>:</span>
</td><td>
binary defined UUID to look for
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt domain resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_lookup_by_uuid_string" id="libvirt_domain_lookup_by_uuid_string">
<code>libvirt_domain_lookup_by_uuid_string</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_lookup_by_uuid_string($res, $uuid)</pre>
<p>Function is used to get the domain by it's UUID that's accepted in string format.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource from libvirt_connect()
</td></tr><tr><td>
<span class="term"><i><tt>@uuid [string]</tt></i>:</span>
</td><td>
domain UUID [in string format] to look for
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt domain resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_lookup_by_id" id="libvirt_domain_lookup_by_id">
<code>libvirt_domain_lookup_by_id</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_lookup_by_id($conn, $id)</pre>
<p>Function is used to get domain by it's ID, applicable only to running guests.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@conn [resource]</tt></i>:</span>
</td><td>
libvirt connection resource from libvirt_connect()
</td></tr><tr><td>
<span class="term"><i><tt>@id [string]</tt></i>:</span>
</td><td>
domain id to look for
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt domain resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_name" id="libvirt_domain_get_name">
<code>libvirt_domain_get_name</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_name($res)</pre>
<p>Function is used to get domain name from it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
domain name string
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_uuid_string" id="libvirt_domain_get_uuid_string">
<code>libvirt_domain_get_uuid_string</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_uuid_string($res)</pre>
<p>Function is used to get the domain's UUID in string format.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
domain UUID string
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_uuid" id="libvirt_domain_get_uuid">
<code>libvirt_domain_get_uuid</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_uuid($res)</pre>
<p>Function is used to get the domain's UUID in binary format.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
domain UUID in binary format
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_id" id="libvirt_domain_get_id">
<code>libvirt_domain_get_id</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_id($res)</pre>
<p>Function is used to get the domain's ID, applicable to running guests.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
running domain ID or -1 if not running
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_xml_desc" id="libvirt_domain_get_xml_desc">
<code>libvirt_domain_get_xml_desc</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_xml_desc($res)</pre>
<p>Function is used to get the domain's XML description.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
domain XML description string
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_info" id="libvirt_domain_get_info">
<code>libvirt_domain_get_info</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_info($res)</pre>
<p>Function is used to get the domain's information.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
domain information array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_create" id="libvirt_domain_create">
<code>libvirt_domain_create</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_create($res)</pre>
<p>Function is used to create the domain identified by it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
result of domain creation (startup)
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_destroy" id="libvirt_domain_destroy">
<code>libvirt_domain_destroy</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_destroy($res)</pre>
<p>Function is used to destroy the domain identified by it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
result of domain destroy
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_resume" id="libvirt_domain_resume">
<code>libvirt_domain_resume</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_resume($res)</pre>
<p>Function is used to resume the domain identified by it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
result of domain resume
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_shutdown" id="libvirt_domain_shutdown">
<code>libvirt_domain_shutdown</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_shutdown($res)</pre>
<p>Function is used to shutdown the domain identified by it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
result of domain shutdown
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_suspend" id="libvirt_domain_suspend">
<code>libvirt_domain_suspend</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_suspend($res)</pre>
<p>Function is used to suspend the domain identified by it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
result of domain suspend
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_undefine" id="libvirt_domain_undefine">
<code>libvirt_domain_undefine</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_undefine($res)</pre>
<p>Function is used to undefine the domain identified by it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
result of domain undefine
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_reboot" id="libvirt_domain_reboot">
<code>libvirt_domain_reboot</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_reboot($res)</pre>
<p>Function is used to reboot the domain identified by it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
result of domain reboot
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_define_xml" id="libvirt_domain_define_xml">
<code>libvirt_domain_define_xml</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_define_xml($conn, $xml)</pre>
<p>Function is used to define the domain from XML string.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@conn [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>@xml [string]</tt></i>:</span>
</td><td>
XML string to define guest from
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
newly defined domain resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_create_xml" id="libvirt_domain_create_xml">
<code>libvirt_domain_create_xml</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_create_xml($conn, $xml)</pre>
<p>Function is used to create the domain identified by it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@conn [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>@xml [string]</tt></i>:</span>
</td><td>
XML string to create guest from
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
newly started/created domain resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_memory_peek" id="libvirt_domain_memory_peek">
<code>libvirt_domain_memory_peek</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_memory_peek($res)</pre>
<p>Function is used to get the domain's memory peek value.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
domain memory peek
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_memory_stats" id="libvirt_domain_memory_stats">
<code>libvirt_domain_memory_stats</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_memory_stats($res)</pre>
<p>Function is used to get the domain's memory stats.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
domain memory stats array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_update_device" id="libvirt_domain_update_device">
<code>libvirt_domain_update_device</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_update_device($res, $xml, $flags)</pre>
<p>Function is used to update the domain's devices from the XML string.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>@xml [string]</tt></i>:</span>
</td><td>
XML string for the update
</td></tr><tr><td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td><td>
Flags to update the device (VIR_DOMAIN_DEVICE_MODIFY_CURRENT, VIR_DOMAIN_DEVICE_MODIFY_LIVE, VIR_DOMAIN_DEVICE_MODIFY_CONFIG, VIR_DOMAIN_DEVICE_MODIFY_FORCE)
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
0 on success, -1 on failure
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_block_stats" id="libvirt_domain_block_stats">
<code>libvirt_domain_block_stats</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_block_stats($res, $path)</pre>
<p>Function is used to get the domain's block stats.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>@path [string]</tt></i>:</span>
</td><td>
device path to get statistics about
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
domain block stats array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_network_info" id="libvirt_domain_get_network_info">
<code>libvirt_domain_get_network_info</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_network_info($res, $mac)</pre>
<p>Function is used to get the domain's network information.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>@mac [string]</tt></i>:</span>
</td><td>
mac address of the network device
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
domain network info array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_block_info" id="libvirt_domain_get_block_info">
<code>libvirt_domain_get_block_info</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_block_info($res, $dev)</pre>
<p>Function is used to get the domain's block device information.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>@dev [string]</tt></i>:</span>
</td><td>
device to get block information about
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
domain block device information array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_xml_xpath" id="libvirt_domain_xml_xpath">
<code>libvirt_domain_xml_xpath</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_xml_xpath($res, $xpath)</pre>
<p>Function is used to get the result of xPath expression that's run against the domain.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>@xpath [string]</tt></i>:</span>
</td><td>
xPath expression to parse against the domain
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
result of the expression
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_interface_stats" id="libvirt_domain_interface_stats">
<code>libvirt_domain_interface_stats</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_interface_stats($res, $path)</pre>
<p>Function is used to get the domain's interface stats.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>@path [string]</tt></i>:</span>
</td><td>
path to interface device
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
interface stats array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_connect" id="libvirt_domain_get_connect">
<code>libvirt_domain_get_connect</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_connect($res)</pre>
<p>Function is used to get the domain's connection resource. This function should *not* be used!.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_migrate_to_uri" id="libvirt_domain_migrate_to_uri">
<code>libvirt_domain_migrate_to_uri</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_migrate_to_uri($res, $dest_uri, $flags, $dname, $bandwidth)</pre>
<p>Function is used migrate domain to another libvirt daemon specified by it's URI.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>@dest_uri [string]</tt></i>:</span>
</td><td>
destination URI to migrate to
</td></tr><tr><td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td><td>
migration flags
</td></tr><tr><td>
<span class="term"><i><tt>@dname [string]</tt></i>:</span>
</td><td>
domain name to rename domain to on destination side
</td></tr><tr><td>
<span class="term"><i><tt>@bandwidth [int]</tt></i>:</span>
</td><td>
migration bandwidth in Mbps
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
migration result as boolean
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_migrate" id="libvirt_domain_migrate">
<code>libvirt_domain_migrate</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_migrate($res, $dest_conn, $flags, $dname, $bandwidth)</pre>
<p>Function is used migrate domain to another domain.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>@dest_conn [string]</tt></i>:</span>
</td><td>
destination host connection object
</td></tr><tr><td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td><td>
migration flags
</td></tr><tr><td>
<span class="term"><i><tt>@dname [string]</tt></i>:</span>
</td><td>
domain name to rename domain to on destination side
</td></tr><tr><td>
<span class="term"><i><tt>@bandwidth [int]</tt></i>:</span>
</td><td>
migration bandwidth in Mbps
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
migration result as boolean
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_domain_get_job_info" id="libvirt_domain_get_job_info">
<code>libvirt_domain_get_job_info</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_job_info($res)</pre>
<p>Function is used get job information for the domain.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt domain resource, e.g. from libvirt_domain_get_by_*()
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
job information array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_lookup_by_name" id="libvirt_storagepool_lookup_by_name">
<code>libvirt_storagepool_lookup_by_name</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_lookup_by_name($res, $name)</pre>
<p>Function is used to lookup for storage pool by it's name.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>@name [string]</tt></i>:</span>
</td><td>
storage pool name
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_list_volumes" id="libvirt_storagepool_list_volumes">
<code>libvirt_storagepool_list_volumes</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_list_volumes($res)</pre>
<p>Function is used to list volumes in the specified storage pool.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
list of storage volume names in the storage pool
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_get_info" id="libvirt_storagepool_get_info">
<code>libvirt_storagepool_get_info</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_get_info($res)</pre>
<p>Function is used to get information about the storage pool.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
storage pool information array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagevolume_lookup_by_name" id="libvirt_storagevolume_lookup_by_name">
<code>libvirt_storagevolume_lookup_by_name</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagevolume_lookup_by_name($res, $name)</pre>
<p>Function is used to lookup for storage volume by it's name.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>@name [string]</tt></i>:</span>
</td><td>
name of the storage volume to look for
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt storagevolume resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagevolume_get_info" id="libvirt_storagevolume_get_info">
<code>libvirt_storagevolume_get_info</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagevolume_get_info($res)</pre>
<p>Function is used to get the storage volume information.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagevolume resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
storage volume information
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagevolume_get_xml_desc" id="libvirt_storagevolume_get_xml_desc">
<code>libvirt_storagevolume_get_xml_desc</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagevolume_get_xml_desc($res)</pre>
<p>Function is used to get the storage volume XML description.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagevolume resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
storagevolume XML description
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagevolume_create_xml" id="libvirt_storagevolume_create_xml">
<code>libvirt_storagevolume_create_xml</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagevolume_create_xml($res, $xml)</pre>
<p>Function is used to create the new storage pool and return the handle to new storage pool.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>@xml [string]</tt></i>:</span>
</td><td>
XML string to create the storage volume in the storage pool
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt storagevolume resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_get_uuid_string" id="libvirt_storagepool_get_uuid_string">
<code>libvirt_storagepool_get_uuid_string</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_get_uuid_string($res)</pre>
<p>Function is used to get storage pool by UUID string.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
storagepool UUID string
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_get_name" id="libvirt_storagepool_get_name">
<code>libvirt_storagepool_get_name</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_get_name($res)</pre>
<p>Function is used to get storage pool name from the storage pool resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
storagepool name string
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_lookup_by_uuid_string" id="libvirt_storagepool_lookup_by_uuid_string">
<code>libvirt_storagepool_lookup_by_uuid_string</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_lookup_by_uuid_string($res, $uuid)</pre>
<p>Function is used to lookup for storage pool identified by UUID string.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>@uuid [string]</tt></i>:</span>
</td><td>
UUID string to look for storagepool
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_get_xml_desc" id="libvirt_storagepool_get_xml_desc">
<code>libvirt_storagepool_get_xml_desc</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_get_xml_desc($res)</pre>
<p>Function is used to get the XML description for the storage pool identified by res.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
XML description
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_define_xml" id="libvirt_storagepool_define_xml">
<code>libvirt_storagepool_define_xml</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_define_xml($res, $xml, $flags)</pre>
<p>Function is used to define the storage pool from XML string and return it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>@xml [string]</tt></i>:</span>
</td><td>
XML string definition of storagepool
</td></tr><tr><td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td><td>
flags to define XML
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_undefine" id="libvirt_storagepool_undefine">
<code>libvirt_storagepool_undefine</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_undefine($res)</pre>
<p>Function is used to undefine the storage pool identified by it's resource.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
TRUE if success, FALSE on error
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_create" id="libvirt_storagepool_create">
<code>libvirt_storagepool_create</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_create($res)</pre>
<p>Function is used to create/start the storage pool.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
TRUE if success, FALSE on error
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_destroy" id="libvirt_storagepool_destroy">
<code>libvirt_storagepool_destroy</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_destroy($res)</pre>
<p>Function is used to destory the storage pool.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
TRUE if success, FALSE on error
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_is_active" id="libvirt_storagepool_is_active">
<code>libvirt_storagepool_is_active</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_is_active($res)</pre>
<p>Function is used to get information whether storage pool is active or not.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
result of virStoragePoolIsActive
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_get_volume_count" id="libvirt_storagepool_get_volume_count">
<code>libvirt_storagepool_get_volume_count</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_get_volume_count($res)</pre>
<p>Function is used to get storage volume count in the storage pool.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
number of volumes in the pool
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_refresh" id="libvirt_storagepool_refresh">
<code>libvirt_storagepool_refresh</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_refresh($res, $flags)</pre>
<p>Function is used to refresh the storage pool information.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td><td>
refresh flags
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
TRUE if success, FALSE on error
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_set_autostart" id="libvirt_storagepool_set_autostart">
<code>libvirt_storagepool_set_autostart</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_set_autostart($res, $flags)</pre>
<p>Function is used to set autostart of the storage pool.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td><td>
flags to set autostart
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
result on setting storagepool autostart value
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_storagepool_get_autostart" id="libvirt_storagepool_get_autostart">
<code>libvirt_storagepool_get_autostart</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_get_autostart($res)</pre>
<p>Function is used to get autostart of the storage pool.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt storagepool resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
autostart value for storagepool
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_list_storagepools" id="libvirt_list_storagepools">
<code>libvirt_list_storagepools</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_storagepools($res)</pre>
<p>Function is used to list storage pools on the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt storagepool names array for the connection
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_list_active_storagepools" id="libvirt_list_active_storagepools">
<code>libvirt_list_active_storagepools</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_active_storagepools($res)</pre>
<p>Function is used to list active storage pools on the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt storagepool names array for the connection
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_list_inactive_storagepools" id="libvirt_list_inactive_storagepools">
<code>libvirt_list_inactive_storagepools</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_inactive_storagepools($res)</pre>
<p>Function is used to list inactive storage pools on the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt storagepool names array for the connection
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_list_domains" id="libvirt_list_domains">
<code>libvirt_list_domains</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_domains($res)</pre>
<p>Function is used to list domains on the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt domain names array for the connection
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_list_domain_resources" id="libvirt_list_domain_resources">
<code>libvirt_list_domain_resources</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_domain_resources($res)</pre>
<p>Function is used to list domain resources on the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt domain resources array for the connection
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_list_active_domain_ids" id="libvirt_list_active_domain_ids">
<code>libvirt_list_active_domain_ids</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_active_domain_ids($res)</pre>
<p>Function is used to list active domain IDs on the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt active domain ids array for the connection
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_list_active_domains" id="libvirt_list_active_domains">
<code>libvirt_list_active_domains</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_active_domains($res)</pre>
<p>Function is used to list active domain names on the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt active domain names array for the connection
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_list_inactive_domains" id="libvirt_list_inactive_domains">
<code>libvirt_list_inactive_domains</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_inactive_domains($res)</pre>
<p>Function is used to list inactive domain names on the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt inactive domain names array for the connection
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_list_networks" id="libvirt_list_networks">
<code>libvirt_list_networks</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_networks($res, $flags)</pre>
<p>Function is used to list networks on the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td><td>
flags whether to list active, inactive or all networks (VIR_NETWORKS_{ACTIVE|INACTIVE|ALL} constants)
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt network names array for the connection
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_list_nodedevs" id="libvirt_list_nodedevs">
<code>libvirt_list_nodedevs</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_nodedevs($res, $cap)</pre>
<p>Function is used to list node devices on the connection.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>@cap [string]</tt></i>:</span>
</td><td>
optional capability string
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt nodedev names array for the connection
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_nodedev_get" id="libvirt_nodedev_get">
<code>libvirt_nodedev_get</code>
</a>
</h3>
<pre class="programlisting">libvirt_nodedev_get($res, $name)</pre>
<p>Function is used to get the node device by it's name.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>@name [string]</tt></i>:</span>
</td><td>
name of the nodedev to get resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt nodedev resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_nodedev_capabilities" id="libvirt_nodedev_capabilities">
<code>libvirt_nodedev_capabilities</code>
</a>
</h3>
<pre class="programlisting">libvirt_nodedev_capabilities($res)</pre>
<p>Function is used to list node devices by capabilities.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt nodedev resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
nodedev capabilities array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_nodedev_get_xml_desc" id="libvirt_nodedev_get_xml_desc">
<code>libvirt_nodedev_get_xml_desc</code>
</a>
</h3>
<pre class="programlisting">libvirt_nodedev_get_xml_desc($res)</pre>
<p>Function is used to get the node device's XML description.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt nodedev resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
nodedev XML description
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_nodedev_get_information" id="libvirt_nodedev_get_information">
<code>libvirt_nodedev_get_information</code>
</a>
</h3>
<pre class="programlisting">libvirt_nodedev_get_information($res)</pre>
<p>Function is used to get the node device's information.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt nodedev resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
nodedev information array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_network_get" id="libvirt_network_get">
<code>libvirt_network_get</code>
</a>
</h3>
<pre class="programlisting">libvirt_network_get($res, $name)</pre>
<p>Function is used to get the network resource from name.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt connection resource
</td></tr><tr><td>
<span class="term"><i><tt>@name [string]</tt></i>:</span>
</td><td>
network name string
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt network resource
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_network_get_bridge" id="libvirt_network_get_bridge">
<code>libvirt_network_get_bridge</code>
</a>
</h3>
<pre class="programlisting">libvirt_network_get_bridge($res)</pre>
<p>Function is used to get the bridge associated with the network.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt network resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
bridge name string
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_network_get_active" id="libvirt_network_get_active">
<code>libvirt_network_get_active</code>
</a>
</h3>
<pre class="programlisting">libvirt_network_get_active($res)</pre>
<p>Function is used to get the activity state of the network.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt network resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
1 when active, 0 when inactive, FALSE on error
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_network_get_information" id="libvirt_network_get_information">
<code>libvirt_network_get_information</code>
</a>
</h3>
<pre class="programlisting">libvirt_network_get_information($res)</pre>
<p>Function is used to get the network information.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt network resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
network information array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_network_set_active" id="libvirt_network_set_active">
<code>libvirt_network_set_active</code>
</a>
</h3>
<pre class="programlisting">libvirt_network_set_active($res)</pre>
<p>Function is used to set the activity state of the network.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt network resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
TRUE if success, FALSE on error
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_network_get_xml_desc" id="libvirt_network_get_xml_desc">
<code>libvirt_network_get_xml_desc</code>
</a>
</h3>
<pre class="programlisting">libvirt_network_get_xml_desc($res)</pre>
<p>Function is used to get the XML description for the network.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@res [resource]</tt></i>:</span>
</td><td>
libvirt network resource
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
network XML string
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_version" id="libvirt_version">
<code>libvirt_version</code>
</a>
</h3>
<pre class="programlisting">libvirt_version($type)</pre>
<p>Function is used to get libvirt, driver and libvirt-php version numbers. Can be used for information purposes, for version checking please use libvirt_check_version() defined below.</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@type [string]</tt></i>:</span>
</td><td>
optional type string to identify driver to look at
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
libvirt, type (driver) and connector (libvirt-php) version numbers array
</td></tr></tbody></table></div>
<h3>
<a name="libvirt_check_version" id="libvirt_check_version">
<code>libvirt_check_version</code>
</a>
</h3>
<pre class="programlisting">libvirt_check_version($major, $minor, $micro, $type)</pre>
<p>Function is used to check major, minor and micro (also sometimes called release) versions of libvirt-php or libvirt itself. This could useful when you want your application to support only versions of libvirt or libvirt-php higher than some version specified..</p>
<div class="variablelist">
<table border="0"><col align="left" /><tbody><tr><td>
<span class="term"><i><tt>@major [int]</tt></i>:</span>
</td><td>
major version number to check for
</td></tr><tr><td>
<span class="term"><i><tt>@minor [int]</tt></i>:</span>
</td><td>
minor version number to check for
</td></tr><tr><td>
<span class="term"><i><tt>@micro [int]</tt></i>:</span>
</td><td>
micro (also release) version number to check for
</td></tr><tr><td>
<span class="term"><i><tt>@type [int]</tt></i>:</span>
</td><td>
type of checking, VIR_VERSION_BINDING to check against libvirt-php binding or VIR_VERSION_LIBVIRT to check against libvirt version
</td></tr><tr><td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td><td>
TRUE if version is equal or higher than required, FALSE if not, FALSE with error [for libvirt_get_last_error()] on unsupported version type check
</td></tr></tbody></table></div>
</div>
</div>
<div id="footer"></div>
</body>
</html>
