<!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>Return all objects including their respective object ID within the specified one</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.snmp3-getnext.html">snmp3_getnext</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.snmp3-set.html">snmp3_set</a></div> <div class="up"><a href="ref.snmp.html">SNMP Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.snmp3-real-walk" class="refentry"> <div class="refnamediv"> <h1 class="refname">snmp3_real_walk</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">snmp3_real_walk</span> — <span class="dc-title">Return all objects including their respective object ID within the specified one</span></p> </div> <div class="refsect1 description" id="refsect1-function.snmp3-real-walk-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><strong>snmp3_real_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">string</span> <code class="parameter">$timeout</code> <span class="initializer"> = 1000000</span> </span> [, <span class="methodparam"> <span class="type">string</span> <code class="parameter">$retries</code> <span class="initializer"> = 5</span> </span> ]] )</div> <p class="para rdfs-comment"> The <span class="function"><strong>snmp3_real_walk()</strong></span> function is used to traverse over a number of <acronym title="Simple Network Management Protocol">SNMP</acronym> objects starting from <em><code class="parameter">object_id</code></em> and return not only their values but also their object ids. </p> </div> <div class="refsect1 parameters" id="refsect1-function.snmp3-real-walk-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <span class="term"> <em><code class="parameter">host</code></em> </span> <dd> <p class="para"> The hostname of the <acronym title="Simple Network Management Protocol">SNMP</acronym> agent (server). </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">sec_name</code></em> </span> <dd> <p class="para"> the security name, usually some kind of username </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">sec_level</code></em> </span> <dd> <p class="para"> the security level (noAuthNoPriv|authNoPriv|authPriv) </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">auth_protocol</code></em> </span> <dd> <p class="para"> the authentication protocol (MD5 or SHA) </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">auth_passphrase</code></em> </span> <dd> <p class="para"> the authentication pass phrase </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">priv_protocol</code></em> </span> <dd> <p class="para"> the privacy protocol (DES or AES) </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">priv_passphrase</code></em> </span> <dd> <p class="para"> the privacy pass phrase </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">object_id</code></em> </span> <dd> <p class="para"> The <acronym title="Simple Network Management Protocol">SNMP</acronym> object id. </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">timeout</code></em> </span> <dd> <p class="para"> The number of microseconds until the first timeout. </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">retries</code></em> </span> <dd> <p class="para"> The number of times to retry if timeouts occur. </p> </dd> </dt> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-function.snmp3-real-walk-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns an associative array of the <acronym title="Simple Network Management Protocol">SNMP</acronym> object ids and their values on success or <strong><code>FALSE</code></strong> on error. In case of an error, an E_WARNING message is shown. </p> </div> <div class="refsect1 examples" id="refsect1-function.snmp3-real-walk-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4562"> <p><strong>Example #1 Using <span class="function"><strong>snmp3_real_walk()</strong></span> </strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">snmp3_real_walk</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'james'</span><span style="color: #007700">, </span><span style="color: #DD0000">'authPriv'</span><span style="color: #007700">, </span><span style="color: #DD0000">'SHA'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'AES'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'IF-MIB::ifName'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p> The above will output something like: <div class="cdata"><pre> array ( 'IF-MIB::ifName.1' => 'STRING: lo', 'IF-MIB::ifName.2' => 'STRING: eth0', 'IF-MIB::ifName.3' => 'STRING: eth2', 'IF-MIB::ifName.4' => 'STRING: sit0', 'IF-MIB::ifName.5' => 'STRING: sixxs', ) </pre></div> </p></div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.snmp3-real-walk-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.snmpwalk.html" class="function" rel="rdfs-seeAlso">snmpwalk()</a> - Fetch all the SNMP objects from an agent</span> </li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.snmp3-getnext.html">snmp3_getnext</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.snmp3-set.html">snmp3_set</a></div> <div class="up"><a href="ref.snmp.html">SNMP Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>