<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.snmp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'uk',
  ),
  'this' => 
  array (
    0 => 'snmp.walk.php',
    1 => 'SNMP::walk',
    2 => 'Fetch SNMP object subtree',
  ),
  'up' => 
  array (
    0 => 'class.snmp.php',
    1 => 'SNMP',
  ),
  'prev' => 
  array (
    0 => 'snmp.setsecurity.php',
    1 => 'SNMP::setSecurity',
  ),
  'next' => 
  array (
    0 => 'class.snmpexception.php',
    1 => 'SNMPException',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/snmp/snmp/walk.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="snmp.walk" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SNMP::walk</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.4.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">SNMP::walk</span> &mdash; <span class="dc-title">Fetch <abbr title="Simple Network Management Protocol">SNMP</abbr> object subtree</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-snmp.walk-description">
  <h3 class="title">Опис</h3>

  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>SNMP::walk</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$objectId</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$suffixAsKey</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$maxRepetitions</code><span class="initializer"> = -1</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$nonRepeaters</code><span class="initializer"> = -1</span></span><br>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="methodname"><strong>SNMP::walk()</strong></span> is used to read <abbr title="Simple Network Management Protocol">SNMP</abbr> subtree rooted at specified <code class="parameter">objectId</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-snmp.walk-parameters">
  <h3 class="title">Параметри</h3>
  <dl>
   
    <dt><code class="parameter">objectId</code></dt>
    <dd>
     <p class="para">
      Root of subtree to be fetched
     </p>
    </dd>
   
   
    <dt><code class="parameter">suffixAsKey</code></dt>
    <dd>
     <p class="para">
      By default full OID notation is used for keys in output array.
      If set to <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> subtree prefix will be removed from keys leaving only suffix of object_id.
     </p>
    </dd>
   
   
    <dt><code class="parameter">nonRepeaters</code></dt>
    <dd>
     <p class="para">
      This specifies the number of supplied variables that should not be iterated over.
      The default is to use this value from <abbr title="Simple Network Management Protocol">SNMP</abbr> object.
     </p>
    </dd>
   
   
    <dt><code class="parameter">maxRepetitions</code></dt>
    <dd>
     <p class="para">
       This specifies the maximum number of iterations over the repeating variables.
       The default is to use this value from <abbr title="Simple Network Management Protocol">SNMP</abbr> object.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-snmp.walk-returnvalues">
  <h3 class="title">Значення, що повертаються</h3>
  <p class="para">
   Returns an associative array of the <abbr title="Simple Network Management Protocol">SNMP</abbr> object ids and their values on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on error.
   When a <abbr title="Simple Network Management Protocol">SNMP</abbr> error occures <span class="methodname"><a href="snmp.geterrno.php" class="methodname">SNMP::getErrno()</a></span> and
   <span class="methodname"><a href="snmp.geterror.php" class="methodname">SNMP::getError()</a></span> can be used for retrieving error
   number (specific to SNMP extension, see class constants) and error message
   respectively.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-snmp.walk-errors">
<h3 class="title">Помилки/виключення</h3>
<p class="para">
 Стандартно цей метод не кидає виключення. Щоб увімкнути виключення
 SNMPException у відповідь на помилки бібліотеки, полю
 <code class="parameter">exceptions_enabled</code> класу SNMP необхідно задати потрібне
 значення. Докладніше: <a href="class.snmp.php#snmp.props.exceptions-enabled" class="link">пояснення
 <code class="parameter">SNMP::$exceptions_enabled</code></a>.
</p>
</div>



 <div class="refsect1 examples" id="refsect1-snmp.walk-examples">
  <h3 class="title">Приклади</h3>
  <div class="example" id="snmp.walk.example.basic">
   <p><strong>Приклад #1 <span class="methodname"><strong>SNMP::walk()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />  $session </span><span style="color: #007700">= new </span><span style="color: #0000BB">SNMP</span><span style="color: #007700">(</span><span style="color: #0000BB">SNMP</span><span style="color: #007700">::</span><span style="color: #0000BB">VERSION_1</span><span style="color: #007700">, </span><span style="color: #DD0000">"127.0.0.1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"public"</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">$fulltree </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">walk</span><span style="color: #007700">(</span><span style="color: #DD0000">"."</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$fulltree</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>Поданий вище приклад виведе щось
схоже на:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [SNMPv2-MIB::sysDescr.0] =&gt; STRING: Test server
    [SNMPv2-MIB::sysObjectID.0] =&gt; OID: NET-SNMP-MIB::netSnmpAgentOIDs.8
    [DISMAN-EVENT-MIB::sysUpTimeInstance] =&gt; Timeticks: (1150681750) 133 days, 4:20:17.50
    [SNMPv2-MIB::sysContact.0] =&gt; STRING: Nobody
    [SNMPv2-MIB::sysName.0] =&gt; STRING: server.localdomain
    ...
)</pre>
</div>
   </div>
  </div>
  <div class="example" id="snmp.walk.example.suffix-as-key">
   <p><strong>Приклад #2 <code class="parameter">suffixAsKey</code> example</strong></p>
   <div class="example-contents"><p>
     <code class="parameter">suffixAsKey</code> may be used when merging multiple <abbr title="Simple Network Management Protocol">SNMP</abbr> subtrees into one.
     This example maps interface names to their type.
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />  $session </span><span style="color: #007700">= new </span><span style="color: #0000BB">SNMP</span><span style="color: #007700">(</span><span style="color: #0000BB">SNMP</span><span style="color: #007700">::</span><span style="color: #0000BB">VERSION_1</span><span style="color: #007700">, </span><span style="color: #DD0000">"127.0.0.1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"public"</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">valueretrieval </span><span style="color: #007700">= </span><span style="color: #0000BB">SNMP_VALUE_PLAIN</span><span style="color: #007700">;<br />  </span><span style="color: #0000BB">$ifDescr </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">walk</span><span style="color: #007700">(</span><span style="color: #DD0000">".1.3.6.1.2.1.2.2.1.2"</span><span style="color: #007700">, </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">valueretrieval </span><span style="color: #007700">= </span><span style="color: #0000BB">SNMP_VALUE_LIBRARY</span><span style="color: #007700">;<br />  </span><span style="color: #0000BB">$ifType </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">walk</span><span style="color: #007700">(</span><span style="color: #DD0000">".1.3.6.1.2.1.2.2.1.3"</span><span style="color: #007700">, </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$ifDescr</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$ifType</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">$result </span><span style="color: #007700">= array();<br />  foreach(</span><span style="color: #0000BB">$ifDescr </span><span style="color: #007700">as </span><span style="color: #0000BB">$i </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">$n</span><span style="color: #007700">) {<br />    </span><span style="color: #0000BB">$result</span><span style="color: #007700">[</span><span style="color: #0000BB">$n</span><span style="color: #007700">] = </span><span style="color: #0000BB">$ifType</span><span style="color: #007700">[</span><span style="color: #0000BB">$i</span><span style="color: #007700">];<br />  }<br />  </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>Поданий вище приклад виведе щось
схоже на:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [1] =&gt; igb0
    [2] =&gt; igb1
    [3] =&gt; ipfw0
    [4] =&gt; lo0
    [5] =&gt; lagg0
)
Array
(
    [1] =&gt; INTEGER: ieee8023adLag(161)
    [2] =&gt; INTEGER: ieee8023adLag(161)
    [3] =&gt; INTEGER: ethernetCsmacd(6)
    [4] =&gt; INTEGER: softwareLoopback(24)
    [5] =&gt; INTEGER: ethernetCsmacd(6)
)
Array
(
    [igb0] =&gt; INTEGER: ieee8023adLag(161)
    [igb1] =&gt; INTEGER: ieee8023adLag(161)
    [ipfw0] =&gt; INTEGER: ethernetCsmacd(6)
    [lo0] =&gt; INTEGER: softwareLoopback(24)
    [lagg0] =&gt; INTEGER: ethernetCsmacd(6)
)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-snmp.walk-seealso">
  <h3 class="title">Прогляньте також</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="snmp.geterrno.php" class="methodname" rel="rdfs-seeAlso">SNMP::getErrno()</a> - Get last error code</span></li>
   <li><span class="methodname"><a href="snmp.geterror.php" class="methodname" rel="rdfs-seeAlso">SNMP::getError()</a> - Get last error message</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>