uTools-Manuals/docs/php/snmp3_walk.html
2019-04-08 23:22:26 +08:00

226 lines
7.5 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>Fetch all the SNMP objects from an agent</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.snmp3-walk" class="refentry">
<div class="refnamediv">
<h1 class="refname">snmp3_walk</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">snmp3_walk</span> &mdash; <span class="dc-title">Fetch all the <acronym title="Simple Network Management Protocol">SNMP</acronym> objects from an agent</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.snmp3-walk-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>snmp3_walk</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$sec_name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$sec_level</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$auth_protocol</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$auth_passphrase</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$priv_protocol</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$priv_passphrase</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$object_id</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code><span class="initializer"> = 1000000</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$retries</code><span class="initializer"> = 5</span></span>
]] ) : <span class="type">array</span></div>
<p class="para rdfs-comment">
<span class="function"><strong>snmp3_walk()</strong></span> function is used to read all the values from
an <acronym title="Simple Network Management Protocol">SNMP</acronym> agent specified by the <code class="parameter">hostname</code>.
</p>
<p class="para">
Even if the security level does not use an auth or priv protocol/password valid values have to be specified.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.snmp3-walk-parameters">
<h3 class="title">参数</h3>
<dl>
<dt>
<code class="parameter">host</code></dt>
<dd>
<p class="para">
The hostname of the SNMP agent (server).
</p>
</dd>
<dt>
<code class="parameter">sec_name</code></dt>
<dd>
<p class="para">
the security name, usually some kind of username
</p>
</dd>
<dt>
<code class="parameter">sec_level</code></dt>
<dd>
<p class="para">
the security level (noAuthNoPriv|authNoPriv|authPriv)
</p>
</dd>
<dt>
<code class="parameter">auth_protocol</code></dt>
<dd>
<p class="para">
the authentication protocol (MD5 or SHA)
</p>
</dd>
<dt>
<code class="parameter">auth_passphrase</code></dt>
<dd>
<p class="para">
the authentication pass phrase
</p>
</dd>
<dt>
<code class="parameter">priv_protocol</code></dt>
<dd>
<p class="para">
the privacy protocol (DES or AES)
</p>
</dd>
<dt>
<code class="parameter">priv_passphrase</code></dt>
<dd>
<p class="para">
the privacy pass phrase
</p>
</dd>
<dt>
<code class="parameter">object_id</code></dt>
<dd>
<p class="para">
If <strong><code>NULL</code></strong>, <code class="parameter">object_id</code> is taken as the root of
the <acronym title="Simple Network Management Protocol">SNMP</acronym> objects tree and all objects under that tree are returned as
an array.
</p>
<p class="para">
If <code class="parameter">object_id</code> is specified, all the <acronym title="Simple Network Management Protocol">SNMP</acronym> objects
below that <code class="parameter">object_id</code> are returned.
</p>
</dd>
<dt>
<code class="parameter">timeout</code></dt>
<dd>
<p class="para">
The number of microseconds until the first timeout.
</p>
</dd>
<dt>
<code class="parameter">retries</code></dt>
<dd>
<p class="para">
The number of times to retry if timeouts occur.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.snmp3-walk-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
Returns an array of <acronym title="Simple Network Management Protocol">SNMP</acronym> object values starting from the
<code class="parameter">object_id</code> as root or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.snmp3-walk-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-5575">
<p><strong>Example #1 <span class="function"><strong>snmp3_walk()</strong></span> Example</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$ret&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">snmp3_walk</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'james'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'authPriv'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'SHA'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'AES'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'IF-MIB::ifName'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">$ret</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</p>
<p class="para">
Above function call would return all the <acronym title="Simple Network Management Protocol">SNMP</acronym> objects from the
<acronym title="Simple Network Management Protocol">SNMP</acronym> agent running on localhost:
<div class="cdata"><pre>
array (
0 =&gt; &#039;STRING: lo&#039;,
1 =&gt; &#039;STRING: eth0&#039;,
2 =&gt; &#039;STRING: eth2&#039;,
3 =&gt; &#039;STRING: sit0&#039;,
4 =&gt; &#039;STRING: sixxs&#039;,
)
</pre></div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.snmp3-walk-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="snmp3_real_walk.html" class="function" rel="rdfs-seeAlso">snmp3_real_walk()</a> - Return all objects including their respective object ID within the specified one</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>