Files
archived-pecl-virtualizatio…/doc/html/function.libvirt-node-get-info.html
2011-02-08 11:01:25 +01:00

124 lines
4.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Extract hardware information about the node</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-list-volumes.html">libvirt_list_volumes</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.libvirt-storagepool-get-info.html">libvirt_storagepool_get_info</a></div>
<div class="up"><a href="ref.libvirt.html">Libvirt Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.libvirt-node-get-info" class="refentry">
<div class="refnamediv">
<h1 class="refname">libvirt_node_get_info</h1>
<p class="verinfo">(php-libvirt 0.1)</p><p class="refpurpose"><span class="refname">libvirt_node_get_info</span> &mdash; <span class="dc-title">Extract hardware information about the node</span></p>
</div>
<a name="function.libvirt-node-get-info.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">Array</span> <span class="methodname"><b>libvirt_node_get_info</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$connection</tt></span>
)</div>
<p class="para rdfs-comment">
Extract hardware information about the node (machine running the hypervisor).
</p>
</div>
<a name="function.libvirt-node-get-info.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">connection</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Connection resource of hypervisor.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.libvirt-node-get-info.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<b><tt class="constant">FALSE</tt></b> is returned on failure. On success associative array containing information is returned.
</p>
<p class="para">
The array contains these values:
</p><ul class="simplelist">
<li class="member">model - string indicating the CPU model</li>
<li class="member">memory - memory size in kilobytes</li>
<li class="member">cpus - the number of active CPUs</li>
<li class="member">mhz - expected CPU frequency</li>
<li class="member">nodes - the number of NUMA cell, 1 for uniform mem access</li>
<li class="member">sockets - number of CPU socket per node</li>
<li class="member">cores - number of core per socket</li>
<li class="member">threads - number of threads per core</li>
</ul><p>
</p>
</div>
<a name="function.libvirt-node-get-info.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>libvirt_node_get_info()</b> example</b></p>
<div class="example-contents para"><p>
Example of getting hardware info for active hypervisor.
</p></div>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;$nodeinfo</span><span style="color: #007700">=</span><span style="color: #0000BB">libvirt_node_get_info</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$nodeinfo</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
(
[model] =&gt; x86_64
[memory] =&gt; 3077804
[cpus] =&gt; 2
[nodes] =&gt; 1
[sockets] =&gt; 1
[cores] =&gt; 2
[threads] =&gt; 1
[mhz] =&gt; 1700
)
</pre></div>
</div>
</div><p>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-list-volumes.html">libvirt_list_volumes</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.libvirt-storagepool-get-info.html">libvirt_storagepool_get_info</a></div>
<div class="up"><a href="ref.libvirt.html">Libvirt Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>