<?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="See the list of distributions where you can find libvirt-php in their repositories" class="inactive" href="distros.html">Distributions</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: 134. 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_node_get_cpu_stats"><code>libvirt_node_get_cpu_stats</code></a>($conn, $cpunr)<br />
<a href="#libvirt_node_get_cpu_stats_for_each_cpu"><code>libvirt_node_get_cpu_stats_for_each_cpu</code></a>($conn, $time)<br />
<a href="#libvirt_node_get_mem_stats"><code>libvirt_node_get_mem_stats</code></a>($conn)<br />
<a href="#libvirt_connect_get_information"><code>libvirt_connect_get_information</code></a>($conn)<br />
<a href="#libvirt_connect_get_uri"><code>libvirt_connect_get_uri</code></a>($conn)<br />
<a href="#libvirt_connect_get_hostname"><code>libvirt_connect_get_hostname</code></a>($conn)<br />
<a href="#libvirt_image_create"><code>libvirt_image_create</code></a>($conn, $name, $size, $format)<br />
<a href="#libvirt_image_remove"><code>libvirt_image_remove</code></a>($conn, $image)<br />
<a href="#libvirt_connect_get_hypervisor"><code>libvirt_connect_get_hypervisor</code></a>($conn)<br />
<a href="#libvirt_connect_is_encrypted"><code>libvirt_connect_is_encrypted</code></a>($conn)<br />
<a href="#libvirt_connect_is_secure"><code>libvirt_connect_is_secure</code></a>($conn)<br />
<a href="#libvirt_connect_get_maxvcpus"><code>libvirt_connect_get_maxvcpus</code></a>($conn)<br />
<a href="#libvirt_connect_get_sysinfo"><code>libvirt_connect_get_sysinfo</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_screenshot_api"><code>libvirt_domain_get_screenshot_api</code></a>($res, $screenID)<br />
<a href="#libvirt_domain_get_screenshot"><code>libvirt_domain_get_screenshot</code></a>($res, $server, $scancode)<br />
<a href="#libvirt_domain_get_screen_dimensions"><code>libvirt_domain_get_screen_dimensions</code></a>($res, $server)<br />
<a href="#libvirt_domain_send_keys"><code>libvirt_domain_send_keys</code></a>($res, $server, $scancode)<br />
<a href="#libvirt_domain_send_pointer_event"><code>libvirt_domain_send_pointer_event</code></a>($res, $server, $pos_x, $pos_y, $clicked, $release)<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_next_dev_ids"><code>libvirt_domain_get_next_dev_ids</code></a>($res)<br />
<a href="#libvirt_connect_get_capabilities"><code>libvirt_connect_get_capabilities</code></a>($conn, $xpath)<br />
<a href="#libvirt_connect_get_emulator"><code>libvirt_connect_get_emulator</code></a>($conn, $arch)<br />
<a href="#libvirt_domain_new"><code>libvirt_domain_new</code></a>($conn, $name, $arch, $memMB, $maxmemMB, $vcpus, $iso_image, $disks, $networks, $flags)<br />
<a href="#libvirt_domain_new_get_vnc"><code>libvirt_domain_new_get_vnc</code></a>($one)<br />
<a href="#libvirt_domain_get_xml_desc"><code>libvirt_domain_get_xml_desc</code></a>($res, $xpath)<br />
<a href="#libvirt_domain_get_disk_devices"><code>libvirt_domain_get_disk_devices</code></a>($res)<br />
<a href="#libvirt_domain_get_interface_devices"><code>libvirt_domain_get_interface_devices</code></a>($res)<br />
<a href="#libvirt_domain_change_vcpus"><code>libvirt_domain_change_vcpus</code></a>($res, $numCpus)<br />
<a href="#libvirt_domain_change_memory"><code>libvirt_domain_change_memory</code></a>($res, $allocMem, $allocMax)<br />
<a href="#libvirt_domain_change_boot_devices"><code>libvirt_domain_change_boot_devices</code></a>($res, $first, $second)<br />
<a href="#libvirt_domain_disk_add"><code>libvirt_domain_disk_add</code></a>($res, $img, $dev, $typ, $driver, $flags)<br />
<a href="#libvirt_domain_disk_remove"><code>libvirt_domain_disk_remove</code></a>($res, $dev, $flags)<br />
<a href="#libvirt_domain_nic_add"><code>libvirt_domain_nic_add</code></a>($res, $mac, $network, $model, $flags)<br />
<a href="#libvirt_domain_nic_remove"><code>libvirt_domain_nic_remove</code></a>($res, $dev, $flags)<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_core_dump"><code>libvirt_domain_core_dump</code></a>($res)<br />
<a href="#libvirt_domain_shutdown"><code>libvirt_domain_shutdown</code></a>($res)<br />
<a href="#libvirt_domain_managedsave"><code>libvirt_domain_managedsave</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_domain_has_current_snapshot"><code>libvirt_domain_has_current_snapshot</code></a>($res)<br />
<a href="#libvirt_domain_snapshot_lookup_by_name"><code>libvirt_domain_snapshot_lookup_by_name</code></a>($res, $name)<br />
<a href="#libvirt_domain_snapshot_create"><code>libvirt_domain_snapshot_create</code></a>($res)<br />
<a href="#libvirt_domain_snapshot_get_xml"><code>libvirt_domain_snapshot_get_xml</code></a>($res)<br />
<a href="#libvirt_domain_snapshot_revert"><code>libvirt_domain_snapshot_revert</code></a>($res)<br />
<a href="#libvirt_domain_snapshot_delete"><code>libvirt_domain_snapshot_delete</code></a>($res, $flags)<br />
<a href="#libvirt_list_domain_snapshots"><code>libvirt_list_domain_snapshots</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_lookup_by_volume"><code>libvirt_storagepool_lookup_by_volume</code></a>($res)<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_lookup_by_path"><code>libvirt_storagevolume_lookup_by_path</code></a>($res, $path)<br />
<a href="#libvirt_storagevolume_get_name"><code>libvirt_storagevolume_get_name</code></a>($res)<br />
<a href="#libvirt_storagevolume_get_path"><code>libvirt_storagevolume_get_path</code></a>($res)<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, $xpath)<br />
<a href="#libvirt_storagevolume_create_xml"><code>libvirt_storagevolume_create_xml</code></a>($res, $xml)<br />
<a href="#libvirt_storagevolume_create_xml_from"><code>libvirt_storagevolume_create_xml_from</code></a>($pool, $xml, $original_volume)<br />
<a href="#libvirt_storagevolume_delete"><code>libvirt_storagevolume_delete</code></a>($res, $flags)<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, $xpath)<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_storagepool_build"><code>libvirt_storagepool_build</code></a>($res)<br />
<a href="#libvirt_storagepool_delete"><code>libvirt_storagepool_delete</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, $xpath)<br />
<a href="#libvirt_nodedev_get_information"><code>libvirt_nodedev_get_information</code></a>($res)<br />
<a href="#libvirt_network_define_xml"><code>libvirt_network_define_xml</code></a>($res, $xml)<br />
<a href="#libvirt_network_undefine"><code>libvirt_network_undefine</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, $xpath)<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 />
<a href="#libvirt_has_feature"><code>libvirt_has_feature</code></a>($name)<br />
<a href="#libvirt_get_iso_images"><code>libvirt_get_iso_images</code></a>($path)<br />
<a href="#libvirt_print_binding_resources"><code>libvirt_print_binding_resources</code></a>()<br />
<a href="#libvirt_logfile_set"><code>libvirt_logfile_set</code></a>($filename, $maxsize)<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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 or FALSE for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_node_get_cpu_stats" id="libvirt_node_get_cpu_stats">
<code>libvirt_node_get_cpu_stats</code>
</a>
</h3>
<pre class="programlisting">libvirt_node_get_cpu_stats($conn, $cpunr)</pre>
<p>[Since version 0.4.6]</p>
<p>Function is used to get the CPU stats per nodes.</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>@cpunr [int]</tt></i>:</span>
</td>
<td>
CPU number to get information about, defaults to VIR_NODE_CPU_STATS_ALL_CPUS to get information about all CPUs
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
array of node CPU statistics including time (in seconds since UNIX epoch), cpu number and total number of CPUs on node or FALSE for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_node_get_cpu_stats_for_each_cpu" id="libvirt_node_get_cpu_stats_for_each_cpu">
<code>libvirt_node_get_cpu_stats_for_each_cpu</code>
</a>
</h3>
<pre class="programlisting">libvirt_node_get_cpu_stats_for_each_cpu($conn, $time)</pre>
<p>[Since version 0.4.6]</p>
<p>Function is used to get the CPU stats for each CPU on the host node.</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>@time [int]</tt></i>:</span>
</td>
<td>
time in seconds to get the information about, without aggregation for further processing
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
array of node CPU statistics for each CPU including time (in seconds since UNIX epoch), cpu number and total number of CPUs on node or FALSE for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_node_get_mem_stats" id="libvirt_node_get_mem_stats">
<code>libvirt_node_get_mem_stats</code>
</a>
</h3>
<pre class="programlisting">libvirt_node_get_mem_stats($conn)</pre>
<p>[Since version 0.4.6]</p>
<p>Function is used to get the memory stats per node.</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 memory statistics including time (in seconds since UNIX epoch) or FALSE for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_connect_get_information" id="libvirt_connect_get_information">
<code>libvirt_connect_get_information</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect_get_information($conn)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get the information about 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>
array of information about the connection
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_connect_get_uri" id="libvirt_connect_get_uri">
<code>libvirt_connect_get_uri</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect_get_uri($conn)</pre>
<p>[Since version 0.4.1(-1)]</p>
<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 or FALSE for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_connect_get_hostname" id="libvirt_connect_get_hostname">
<code>libvirt_connect_get_hostname</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect_get_hostname($conn)</pre>
<p>[Since version 0.4.1(-1)]</p>
<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 or FALSE for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_image_create" id="libvirt_image_create">
<code>libvirt_image_create</code>
</a>
</h3>
<pre class="programlisting">libvirt_image_create($conn, $name, $size, $format)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to create the image of desired name, size and format. The image will be created in the image path (libvirt.image_path INI variable). Works only o.</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>@name [string]</tt></i>:</span>
</td>
<td>
name of the image file that will be created in the libvirt.image_path directory
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@size [int]</tt></i>:</span>
</td>
<td>
size of the image in MiBs
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@format [string]</tt></i>:</span>
</td>
<td>
format of the image, may be raw, qcow or qcow2
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
hostname of the host node or FALSE for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_image_remove" id="libvirt_image_remove">
<code>libvirt_image_remove</code>
</a>
</h3>
<pre class="programlisting">libvirt_image_remove($conn, $image)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to create the image of desired name, size and format. The image will be created in the image path (libvirt.image_path INI variable). Works only on local systems!.</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>@image [string]</tt></i>:</span>
</td>
<td>
name of the image file that should be deleted
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
hostname of the host node or FALSE for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_connect_get_hypervisor" id="libvirt_connect_get_hypervisor">
<code>libvirt_connect_get_hypervisor</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect_get_hypervisor($conn)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get the information about the hypervisor on the connection identified by the connection pointer.</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 hypervisor information if available
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_connect_is_encrypted" id="libvirt_connect_is_encrypted">
<code>libvirt_connect_is_encrypted</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect_is_encrypted($conn)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get the information whether the connection is encrypted or not.</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>
1 if encrypted, 0 if not encrypted, -1 on error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_connect_is_secure" id="libvirt_connect_is_secure">
<code>libvirt_connect_is_secure</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect_is_secure($conn)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get the information whether the connection is secure or not.</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>
1 if secure, 0 if not secure, -1 on error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_connect_get_maxvcpus" id="libvirt_connect_get_maxvcpus">
<code>libvirt_connect_get_maxvcpus</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect_get_maxvcpus($conn)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get maximum number of VCPUs per VM on the hypervisor 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>
number of VCPUs available per VM on the connection or FALSE for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_connect_get_sysinfo" id="libvirt_connect_get_sysinfo">
<code>libvirt_connect_get_sysinfo</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect_get_sysinfo($conn)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get the system information from connection if available.</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>
XML description of system information from the connection or FALSE for error
</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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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_lookup_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>[Since version 0.4.1(-1)]</p>
<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_lookup_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_screenshot_api" id="libvirt_domain_get_screenshot_api">
<code>libvirt_domain_get_screenshot_api</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_screenshot_api($res, $screenID)</pre>
<p>[Since version 0.4.5]</p>
<p>Function is trying to get domain screenshot using libvirt virGetDomainScreenshot() API if available..</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>@screenID [int]</tt></i>:</span>
</td>
<td>
monitor ID from where to take screenshot
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
array of filename and mime type as type is hypervisor specific, caller is responsible for temporary file deletion
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_get_screenshot" id="libvirt_domain_get_screenshot">
<code>libvirt_domain_get_screenshot</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_screenshot($res, $server, $scancode)</pre>
<p>[Since version 0.4.2]</p>
<p>Function uses gvnccapture (if available) to get the screenshot of the running 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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@server [string]</tt></i>:</span>
</td>
<td>
server string for the host machine
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@scancode [int]</tt></i>:</span>
</td>
<td>
integer value of the scancode to be send to refresh screen
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
PNG image binary data
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_get_screen_dimensions" id="libvirt_domain_get_screen_dimensions">
<code>libvirt_domain_get_screen_dimensions</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_screen_dimensions($res, $server)</pre>
<p>[Since version 0.4.3]</p>
<p>Function get screen dimensions of the VNC window.</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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@server [string]</tt></i>:</span>
</td>
<td>
server string of the host machine
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
array of height and width on success, FALSE otherwise
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_send_keys" id="libvirt_domain_send_keys">
<code>libvirt_domain_send_keys</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_send_keys($res, $server, $scancode)</pre>
<p>[Since version 0.4.2]</p>
<p>Function sends keys to the domain's VNC window.</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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@server [string]</tt></i>:</span>
</td>
<td>
server string of the host machine
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@scancode [int]</tt></i>:</span>
</td>
<td>
integer scancode to be sent to VNC window
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE on success, FALSE otherwise
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_send_pointer_event" id="libvirt_domain_send_pointer_event">
<code>libvirt_domain_send_pointer_event</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_send_pointer_event($res, $server, $pos_x, $pos_y, $clicked, $release)</pre>
<p>[Since version 0.4.2]</p>
<p>Function sends keys to the domain's VNC window.</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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@server [string]</tt></i>:</span>
</td>
<td>
server string of the host machine
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@pos_x [int]</tt></i>:</span>
</td>
<td>
position on x-axis
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@pos_y [int]</tt></i>:</span>
</td>
<td>
position on y-axis
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@clicked [int]</tt></i>:</span>
</td>
<td>
mask of clicked buttons (0 for none, bit 1 for button #1, bit 8 for button #8)
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@release [int]</tt></i>:</span>
</td>
<td>
boolean value (0 or 1) whether to release the buttons automatically once pressed
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE on success, FALSE otherwise
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_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>[Since version 0.4.1(-1)]</p>
<p>Function is used to get the domain's ID, applicable to running guests only.</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_lookup_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_next_dev_ids" id="libvirt_domain_get_next_dev_ids">
<code>libvirt_domain_get_next_dev_ids</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_next_dev_ids($res)</pre>
<p>[Since version 0.4.2]</p>
<p>This functions can be used to get the next free slot if you intend to add a new device identified by slot to the domain, e.g. NIC device.</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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
next free slot number for the domain
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_connect_get_capabilities" id="libvirt_connect_get_capabilities">
<code>libvirt_connect_get_capabilities</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect_get_capabilities($conn, $xpath)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get the capabilities information from 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>@xpath [string]</tt></i>:</span>
</td>
<td>
optional xPath query to be applied on the result
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
capabilities XML from the connection or FALSE for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_connect_get_emulator" id="libvirt_connect_get_emulator">
<code>libvirt_connect_get_emulator</code>
</a>
</h3>
<pre class="programlisting">libvirt_connect_get_emulator($conn, $arch)</pre>
<p>[Since version 0.4.5]</p>
<p>Function is used to get the emulator for requested connection/architecture.</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>@arch [string]</tt></i>:</span>
</td>
<td>
optional architecture string, can be NULL to get default
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
path to the emulator
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_new" id="libvirt_domain_new">
<code>libvirt_domain_new</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_new($conn, $name, $arch, $memMB, $maxmemMB, $vcpus, $iso_image, $disks, $networks, $flags)</pre>
<p>[Since version 0.4.5]</p>
<p>Function is used to install a new virtual machine to the machine.</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>@name [string]</tt></i>:</span>
</td>
<td>
name of the new domain
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@arch [string]</tt></i>:</span>
</td>
<td>
optional architecture string, can be NULL to get default (or false)
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@memMB [int]</tt></i>:</span>
</td>
<td>
number of megabytes of RAM to be allocated for domain
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@maxmemMB [int]</tt></i>:</span>
</td>
<td>
maximum number of megabytes of RAM to be allocated for domain
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@vcpus [int]</tt></i>:</span>
</td>
<td>
number of VCPUs to be allocated to domain
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@iso_image [string]</tt></i>:</span>
</td>
<td>
installation ISO image for domain
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@disks [array]</tt></i>:</span>
</td>
<td>
array of disk devices for domain, consist of keys as 'path' (storage location), 'driver' (image type, e.g. 'raw' or 'qcow2'), 'bus' (e.g. 'ide', 'scsi'), 'dev' (device to be presented to the guest - e.g. 'hda'), 'size' (with 'M' or 'G' suffixes, like '10G' for 10 gigabytes image etc.) and 'flags' (VIR_DOMAIN_DISK_FILE or VIR_DOMAIN_DISK_BLOCK, optionally VIR_DOMAIN_DISK_ACCESS_ALL to allow access to the disk for all users on the host system)
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@networks [array]</tt></i>:</span>
</td>
<td>
array of network devices for domain, consists of keys as 'mac' (for MAC address), 'network' (for network name) and optional 'model' for model of NIC device
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td>
<td>
bit array of flags
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
a new domain resource
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_new_get_vnc" id="libvirt_domain_new_get_vnc">
<code>libvirt_domain_new_get_vnc</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_new_get_vnc($one)</pre>
<p>[Since version 0.4.5]</p>
<p>Function is used to get the VNC server location for the newly created domain (newly started installation).</p>
<div class="variablelist">
<table border="0">
<col align="left" />
<tbody>
<tr>
<td>
<span class="term"><i><tt>one</tt></i>:</span>
</td>
<td>
one
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
a VNC server for a newly created domain resource (if any)
</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, $xpath)</pre>
<p>[Since version 0.4.1(-1), changed 0.4.2]</p>
<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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@xpath [string]</tt></i>:</span>
</td>
<td>
optional xPath expression string to get just this entry, can be NULL
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
domain XML description string or result of xPath expression
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_get_disk_devices" id="libvirt_domain_get_disk_devices">
<code>libvirt_domain_get_disk_devices</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_disk_devices($res)</pre>
<p>[Since version 0.4.4]</p>
<p>Function is used to get disk devices 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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
list of domain disk devices
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_get_interface_devices" id="libvirt_domain_get_interface_devices">
<code>libvirt_domain_get_interface_devices</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_get_interface_devices($res)</pre>
<p>[Since version 0.4.4]</p>
<p>Function is used to get network interface devices 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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
list of domain interface devices
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_change_vcpus" id="libvirt_domain_change_vcpus">
<code>libvirt_domain_change_vcpus</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_change_vcpus($res, $numCpus)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to change the VCPU count 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>@numCpus [int]</tt></i>:</span>
</td>
<td>
number of VCPUs to be set for the guest
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
new domain resource
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_change_memory" id="libvirt_domain_change_memory">
<code>libvirt_domain_change_memory</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_change_memory($res, $allocMem, $allocMax)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to change the domain memory allocation.</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>@allocMem [int]</tt></i>:</span>
</td>
<td>
number of MiBs to be set as immediate memory value
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@allocMax [int]</tt></i>:</span>
</td>
<td>
number of MiBs to be set as the maximum allocation
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
new domain resource
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_change_boot_devices" id="libvirt_domain_change_boot_devices">
<code>libvirt_domain_change_boot_devices</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_change_boot_devices($res, $first, $second)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to change the domain boot devices.</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>@first [string]</tt></i>:</span>
</td>
<td>
first boot device to be set
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@second [string]</tt></i>:</span>
</td>
<td>
second boot device to be set
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
new domain resource
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_disk_add" id="libvirt_domain_disk_add">
<code>libvirt_domain_disk_add</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_disk_add($res, $img, $dev, $typ, $driver, $flags)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to add the disk to the virtual machine using set of API functions to make it as simple as possible for the user.</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>@img [string]</tt></i>:</span>
</td>
<td>
string for the image file on the host system
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@dev [string]</tt></i>:</span>
</td>
<td>
string for the device to be presented to the guest (e.g. hda)
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@typ [string]</tt></i>:</span>
</td>
<td>
bus type for the device in the guest, usually 'ide' or 'scsi'
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>driver [string]</tt></i>:</span>
</td>
<td>
driver type to be specified, like 'raw' or 'qcow2'
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td>
<td>
flags for getting the XML description
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
new domain resource
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_disk_remove" id="libvirt_domain_disk_remove">
<code>libvirt_domain_disk_remove</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_disk_remove($res, $dev, $flags)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to remove the disk from the virtual machine using set of API functions to make it as simple as possible.</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>@dev [string]</tt></i>:</span>
</td>
<td>
string for the device to be removed from the guest (e.g. 'hdb')
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td>
<td>
flags for getting the XML description
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
new domain resource
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_nic_add" id="libvirt_domain_nic_add">
<code>libvirt_domain_nic_add</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_nic_add($res, $mac, $network, $model, $flags)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to add the NIC card to the virtual machine using set of API functions to make it as simple as possible for the user.</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>@mac [string]</tt></i>:</span>
</td>
<td>
MAC string interpretation to be used for the NIC device
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@network [string]</tt></i>:</span>
</td>
<td>
network name where to connect this NIC
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@model [string]</tt></i>:</span>
</td>
<td>
string of the NIC model
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td>
<td>
flags for getting the XML description
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
new domain resource
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_nic_remove" id="libvirt_domain_nic_remove">
<code>libvirt_domain_nic_remove</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_nic_remove($res, $dev, $flags)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to remove the NIC from the virtual machine using set of API functions to make it as simple as possible.</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>@dev [string]</tt></i>:</span>
</td>
<td>
string representation of the IP address to be removed (e.g. 54:52:00:xx:yy:zz)
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td>
<td>
optional flags for getting the XML description
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
new domain resource
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_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>[Since version 0.4.1(-1)]</p>
<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_lookup_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>[Since version 0.4.1(-1)]</p>
<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_lookup_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>[Since version 0.4.1(-1)]</p>
<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_lookup_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_core_dump" id="libvirt_domain_core_dump">
<code>libvirt_domain_core_dump</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_core_dump($res)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to dump core of 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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE for success, FALSE on error
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE for success, FALSE on error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_managedsave" id="libvirt_domain_managedsave">
<code>libvirt_domain_managedsave</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_managedsave($res)</pre>
<p>[Since version 0.4.1(-1)]</p>
<p>Function is used to managed save the domain (domain was unloaded from memory and it state saved to disk) 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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE for success, FALSE on error
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE for success, FALSE on error
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE for success, FALSE on error
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE for success, FALSE on error
</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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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_lookup_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>[Since version 0.4.1(-1)]</p>
<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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
domain memory stats array (same fields as virDomainMemoryStats, please see libvirt documentation)
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_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>
TRUE for success, FALSE on error
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_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, fields are rd_req, rd_bytes, wr_req, wr_bytes and errs
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_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 of MAC address, network name and type of NIC card
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_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 of device, file or partition, capacity, allocation and physical size
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_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 in an array
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_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 of {tx|rx}_{bytes|packets|errs|drop} fields
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_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>[Since version 0.4.1(-1)]</p>
<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_lookup_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>
TRUE for success, FALSE on error
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_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>
libvirt domain resource for migrated domain
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_by_*()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
job information array of type, time, data, mem and file fields
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_has_current_snapshot" id="libvirt_domain_has_current_snapshot">
<code>libvirt_domain_has_current_snapshot</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_has_current_snapshot($res)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get the information whether domain has the current snapshot.</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>
TRUE is domain has the current snapshot, otherwise FALSE (you may need to check for error using libvirt_get_last_error())
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_snapshot_lookup_by_name" id="libvirt_domain_snapshot_lookup_by_name">
<code>libvirt_domain_snapshot_lookup_by_name</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_snapshot_lookup_by_name($res, $name)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>This functions is used to lookup for the snapshot 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 domain resource
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@name [string]</tt></i>:</span>
</td>
<td>
name of the snapshot to get the resource
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
domain snapshot resource
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_snapshot_create" id="libvirt_domain_snapshot_create">
<code>libvirt_domain_snapshot_create</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_snapshot_create($res)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>This function creates the domain snapshot for 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
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
domain snapshot resource
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_snapshot_get_xml" id="libvirt_domain_snapshot_get_xml">
<code>libvirt_domain_snapshot_get_xml</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_snapshot_get_xml($res)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get the XML description of the snapshot 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 snapshot resource
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
XML description string for the snapshot
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_domain_snapshot_revert" id="libvirt_domain_snapshot_revert">
<code>libvirt_domain_snapshot_revert</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_snapshot_revert($res)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to revert the domain state to the state identified by the snapshot.</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 snapshot resource
</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_snapshot_delete" id="libvirt_domain_snapshot_delete">
<code>libvirt_domain_snapshot_delete</code>
</a>
</h3>
<pre class="programlisting">libvirt_domain_snapshot_delete($res, $flags)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to revert the domain state to the state identified by the snapshot.</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 snapshot resource
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td>
<td>
0 to delete just snapshot, VIR_SNAPSHOT_DELETE_CHILDREN to delete snapshot children as well
</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_list_domain_snapshots" id="libvirt_list_domain_snapshots">
<code>libvirt_list_domain_snapshots</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_domain_snapshots($res)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to list domain snapshots for the domain specified 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
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
libvirt domain snapshot names 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>[Since version 0.4.1(-1)]</p>
<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_lookup_by_volume" id="libvirt_storagepool_lookup_by_volume">
<code>libvirt_storagepool_lookup_by_volume</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_lookup_by_volume($res)</pre>
<p>[Since version 0.4.1(-1)]</p>
<p>Function is used to lookup for storage pool by a volume.</p>
<div class="variablelist">
<table border="0">
<col align="left" />
<tbody>
<tr>
<td>
<span class="term"><i><tt>res [volume]</tt></i>:</span>
</td>
<td>
volume resource of storage pool
</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>[Since version 0.4.1(-1)]</p>
<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 in an array using default keys (indexes)
</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>[Since version 0.4.1(-1)]</p>
<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 of state, capacity, allocation and available space
</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>[Since version 0.4.1(-1)]</p>
<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_lookup_by_path" id="libvirt_storagevolume_lookup_by_path">
<code>libvirt_storagevolume_lookup_by_path</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagevolume_lookup_by_path($res, $path)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to lookup for storage volume by it's path.</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>@path [string]</tt></i>:</span>
</td>
<td>
path 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_name" id="libvirt_storagevolume_get_name">
<code>libvirt_storagevolume_get_name</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagevolume_get_name($res)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get the storage volume 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 storagevolume resource
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
storagevolume name
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_storagevolume_get_path" id="libvirt_storagevolume_get_path">
<code>libvirt_storagevolume_get_path</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagevolume_get_path($res)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to get the storage volume path.</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 path
</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>[Since version 0.4.1(-1)]</p>
<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 array of type, allocation and capacity
</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, $xpath)</pre>
<p>[Since version 0.4.1(-1), changed 0.4.2]</p>
<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>@xpath [string]</tt></i>:</span>
</td>
<td>
optional xPath expression string to get just this entry, can be NULL
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
storagevolume XML description or result of xPath expression
</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>[Since version 0.4.1(-1)]</p>
<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_storagevolume_create_xml_from" id="libvirt_storagevolume_create_xml_from">
<code>libvirt_storagevolume_create_xml_from</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagevolume_create_xml_from($pool, $xml, $original_volume)</pre>
<p>[Since version 0.4.1(-2)]</p>
<p>Function is used to clone the new storage volume into pool from the orignial volume.</p>
<div class="variablelist">
<table border="0">
<col align="left" />
<tbody>
<tr>
<td>
<span class="term"><i><tt>pool [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>@original_volume [resource]</tt></i>:</span>
</td>
<td>
libvirt storagevolume resource
</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_delete" id="libvirt_storagevolume_delete">
<code>libvirt_storagevolume_delete</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagevolume_delete($res, $flags)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to delete to volume 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 storagevolume resource
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@flags [int]</tt></i>:</span>
</td>
<td>
optional flags for the storage volume deletion for virStorageVolDelete()
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE for success, FALSE on error
</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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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, $xpath)</pre>
<p>[Since version 0.4.1(-1), changed 0.4.2]</p>
<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>@xpath [string]</tt></i>:</span>
</td>
<td>
optional xPath expression string to get just this entry, can be NULL
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
storagepool XML description string or result of xPath expression
</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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>
TRUE for autostart enabled, FALSE for autostart disabled, FALSE with last_error set for error
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_storagepool_build" id="libvirt_storagepool_build">
<code>libvirt_storagepool_build</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_build($res)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to Build the underlying storage pool, e.g. create the destination directory for NFS.</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_delete" id="libvirt_storagepool_delete">
<code>libvirt_storagepool_delete</code>
</a>
</h3>
<pre class="programlisting">libvirt_storagepool_delete($res)</pre>
<p>[Since version 0.4.6]</p>
<p>Function is used to Delete the underlying storage pool, e.g. remove the destination directory for NFS.</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_list_storagepools" id="libvirt_list_storagepools">
<code>libvirt_list_storagepools</code>
</a>
</h3>
<pre class="programlisting">libvirt_list_storagepools($res)</pre>
<p>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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, $xpath)</pre>
<p>[Since version 0.4.1(-1), changed 0.4.2]</p>
<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>@xpath [string]</tt></i>:</span>
</td>
<td>
optional xPath expression string to get just this entry, can be NULL
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
nodedev XML description string or result of xPath expression
</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>[Since version 0.4.1(-1)]</p>
<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_define_xml" id="libvirt_network_define_xml">
<code>libvirt_network_define_xml</code>
</a>
</h3>
<pre class="programlisting">libvirt_network_define_xml($res, $xml)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to define a new virtual network based on the 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 connection resource
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@xml [string]</tt></i>:</span>
</td>
<td>
XML string definition of network to be defined
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
libvirt network resource of newly defined network
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_network_undefine" id="libvirt_network_undefine">
<code>libvirt_network_undefine</code>
</a>
</h3>
<pre class="programlisting">libvirt_network_undefine($res)</pre>
<p>[Since version 0.4.2]</p>
<p>Function is used to undefine already defined 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 for success, FALSE on error
</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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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, $xpath)</pre>
<p>[Since version 0.4.1(-1)]</p>
<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>@xpath [string]</tt></i>:</span>
</td>
<td>
optional xPath expression string to get just this entry, can be NULL
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
network XML string or result of xPath expression
</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>[Since version 0.4.1(-1)]</p>
<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>[Since version 0.4.1(-1)]</p>
<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 [long]</tt></i>:</span>
</td>
<td>
major version number to check for
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@minor [long]</tt></i>:</span>
</td>
<td>
minor version number to check for
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@micro [long]</tt></i>:</span>
</td>
<td>
micro (also release) version number to check for
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@type [long]</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>
<h3>
<a name="libvirt_has_feature" id="libvirt_has_feature">
<code>libvirt_has_feature</code>
</a>
</h3>
<pre class="programlisting">libvirt_has_feature($name)</pre>
<p>[Since version 0.4.1(-3)]</p>
<p>Function to check for feature existence for working libvirt instance.</p>
<div class="variablelist">
<table border="0">
<col align="left" />
<tbody>
<tr>
<td>
<span class="term"><i><tt>@name [string]</tt></i>:</span>
</td>
<td>
feature name
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE if feature is supported, FALSE otherwise
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_get_iso_images" id="libvirt_get_iso_images">
<code>libvirt_get_iso_images</code>
</a>
</h3>
<pre class="programlisting">libvirt_get_iso_images($path)</pre>
<p>[Since version 0.4.1(-3)]</p>
<p>Function to get the ISO images on path and return them in the array.</p>
<div class="variablelist">
<table border="0">
<col align="left" />
<tbody>
<tr>
<td>
<span class="term"><i><tt>@path [string]</tt></i>:</span>
</td>
<td>
string of path where to look for the ISO images
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
ISO image array on success, FALSE otherwise
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_print_binding_resources" id="libvirt_print_binding_resources">
<code>libvirt_print_binding_resources</code>
</a>
</h3>
<pre class="programlisting">libvirt_print_binding_resources()</pre>
<p>[Since version 0.4.2]</p>
<p>Function to print the binding resources, although the resource information are printed, they are returned in the return_value.</p>
<div class="variablelist">
<table border="0">
<col align="left" />
<tbody>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
bindings resource information
</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a name="libvirt_logfile_set" id="libvirt_logfile_set">
<code>libvirt_logfile_set</code>
</a>
</h3>
<pre class="programlisting">libvirt_logfile_set($filename, $maxsize)</pre>
<p>[Since version 0.4.2]</p>
<p>Function to set the log file for the libvirt module instance.</p>
<div class="variablelist">
<table border="0">
<col align="left" />
<tbody>
<tr>
<td>
<span class="term"><i><tt>@filename [string]</tt></i>:</span>
</td>
<td>
log filename or NULL to disable logging
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>@maxsize [long]</tt></i>:</span>
</td>
<td>
optional maximum log file size argument in KiB, default value can be found in PHPInfo() output
</td>
</tr>
<tr>
<td>
<span class="term"><i><tt>Returns</tt></i>:</span>
</td>
<td>
TRUE if log file has been successfully set, FALSE otherwise
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div id="footer"></div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
9f12c4204c04c9e18ab5488afc351c44
>
files
>
36
