1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
<!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>List all domains</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-list-defined-domains.html">libvirt_list_defined_domains</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.libvirt-list-storagepools.html">libvirt_list_storagepools</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-list-domains" class="refentry">
<div class="refnamediv">
<h1 class="refname">libvirt_list_domains</h1>
<p class="verinfo">(php-libvirt 0.1)</p><p class="refpurpose"><span class="refname">libvirt_list_domains</span> — <span class="dc-title">List all domains</span></p>
</div>
<a name="function.libvirt-list-domains.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_list_domains</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$connection</tt></span>
)</div>
<p class="para rdfs-comment">
This function returns array of domain resources for all domains defined and/or running on the hypervisor.
</p>
</div>
<a name="function.libvirt-list-domains.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-list-domains.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Array of domain resources for all domains. <b><tt class="constant">FALSE</tt></b> on failure
</p>
</div>
<a name="function.libvirt-list-domains.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>libvirt_list_domains()</b> example</b></p>
<div class="example-contents para"><p>
List all domains and get their names
</p></div>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /> $conn</span><span style="color: #007700">=</span><span style="color: #0000BB">libvirt_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$uri</span><span style="color: #007700">,</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$domains</span><span style="color: #007700">=</span><span style="color: #0000BB">libvirt_list_domains</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /> foreach (</span><span style="color: #0000BB">$domains </span><span style="color: #007700">as </span><span style="color: #0000BB">$dom</span><span style="color: #007700">)<br /> {<br /> echo (</span><span style="color: #DD0000">"Name:\t"</span><span style="color: #007700">.</span><span style="color: #0000BB">libvirt_domain_get_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$dom</span><span style="color: #007700">).</span><span style="color: #DD0000">"<br/>"</span><span style="color: #007700">);<br /> }<br /><br /></span><span style="color: #0000BB">?></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>
Name: test1
Name: node5
Name: ovirt-appliance
Name: node3
Name: node4
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.libvirt-list-domains.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.libvirt-list-active-domains.html" class="function" rel="rdfs-seeAlso">libvirt_list_active_domains()</a> - Get active domains</li>
<li class="member"><a href="function.libvirt-list-defined-domains.html" class="function" rel="rdfs-seeAlso">libvirt_list_defined_domains()</a> - Get inactive domains</li>
</ul><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-defined-domains.html">libvirt_list_defined_domains</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.libvirt-list-storagepools.html">libvirt_list_storagepools</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>
|
