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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
<!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>provide interface statistics for the virtual network interface on domain.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-domain-get-xml-desc.html">libvirt_domain_get_xml_desc</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.libvirt-domain-lookup-by-id.html">libvirt_domain_lookup_by_id</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-domain-interface-stats" class="refentry">
<div class="refnamediv">
<h1 class="refname">libvirt_domain_interface_stats</h1>
<p class="verinfo">(php-libvirt 0.3)</p><p class="refpurpose"><span class="refname">libvirt_domain_interface_stats</span> — <span class="dc-title">provide interface statistics for the virtual network interface on domain.</span></p>
</div>
<a name="function.libvirt-domain-interface-stats.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_domain_interface_stats</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$domain</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$path</tt></span>
)</div>
<p class="para rdfs-comment">
This function returns network interface stats for interfaces attached to the domain. The path parameter is the name of the network interface. Domains may have more than one network interface. To get stats for each you should make multiple calls to this function. Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.
</p>
<p class="para">
The returned array contains members in accoridng to the libvirt structure virDomainInterfaceStatsStruct.
</p><table class="doctable table"><caption><b>Members of the array returned by libvirt_domain_interface_stats</b></caption>
<tbody valign="middle" class="tbody">
<tr valign="middle"><td align="left">rx_bytes</td><td align="left">Bytes received</td></tr>
<tr valign="middle"><td align="left">rx_packets</td><td align="left">Packets received</td></tr>
<tr valign="middle"><td align="left">rx_errs</td><td align="left">Errors on receive</td></tr>
<tr valign="middle"><td align="left">rx_drop</td><td align="left">Drops on receive</td></tr>
<tr valign="middle"><td align="left">rx_bytes</td><td align="left">Bytes transmitted</td></tr>
<tr valign="middle"><td align="left">rx_packets</td><td align="left">Packets transmitted</td></tr>
<tr valign="middle"><td align="left">rx_errs</td><td align="left">Errors on transmit</td></tr>
<tr valign="middle"><td align="left">rx_drop</td><td align="left">Drops on transmit</td></tr>
</tbody>
</table>
<p>
</p>
<blockquote><p><b class="note">Note</b>: <b>Warning</b><br />
.
This function returns values that may be bigger than 32bit integer limit. Please read this <a href="libvirt.longlong.html" class="link">note</a> for more details.
<br />
</p></blockquote>
</div>
<a name="function.libvirt-domain-interface-stats.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">domain</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Domain resource of domain the interface is attached to
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">path</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Path to the interface, i.e. "vnet1"
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.libvirt-domain-interface-stats.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Array with statistics.
</p>
</div>
<a name="function.libvirt-domain-interface-stats.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>libvirt_domain_interface_stats()</b> example</b></p>
<div class="example-contents para"><p>
Get interface statistics on interface vnet1 on domain test
</p></div>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $dom</span><span style="color: #007700">=</span><span style="color: #0000BB">libvirt_domain_lookup_by_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">,</span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">libvirt_domain_interface_stats</span><span style="color: #007700">(</span><span style="color: #0000BB">$dom</span><span style="color: #007700">,</span><span style="color: #DD0000">"vnet1"</span><span style="color: #007700">));<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>
Array
(
[rx_bytes] => 94699317
[rx_packets] => 794389
[rx_errs] => 0
[rx_drop] => 0
[tx_bytes] => 0
[tx_packets] => 0
[tx_errs] => 0
[tx_drop] => 0
)
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.libvirt-domain-interface-stats.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-domain-memory-stats.html" class="function" rel="rdfs-seeAlso">libvirt_domain_memory_stats()</a> - provide memory statistics for the domain.</li>
<li class="member"><a href="function.libvirt-domain-block-stats.html" class="function" rel="rdfs-seeAlso">libvirt_domain_block_stats()</a> - provide block device statistics for the block device on domain.</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-domain-get-xml-desc.html">libvirt_domain_get_xml_desc</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.libvirt-domain-lookup-by-id.html">libvirt_domain_lookup_by_id</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>
|
