<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.snmp3-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>snmp3_walk</refname>
  <refpurpose>Fetch all the <acronym>SNMP</acronym> objects from an agent</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>snmp3_walk</methodname>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
   <methodparam><type>string</type><parameter>security_name</parameter></methodparam>
   <methodparam><type>string</type><parameter>security_level</parameter></methodparam>
   <methodparam><type>string</type><parameter>auth_protocol</parameter></methodparam>
   <methodparam><type>string</type><parameter>auth_passphrase</parameter></methodparam>
   <methodparam><type>string</type><parameter>privacy_protocol</parameter></methodparam>
   <methodparam><type>string</type><parameter>privacy_passphrase</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>-1</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>snmp3_walk</function> function is used to read all the values from
   an <acronym>SNMP</acronym> agent specified by the <parameter>hostname</parameter>. 
  </para>
  <para>
   Even if the security level does not use an auth or priv protocol/password valid values have to be specified.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>hostname</parameter></term>
    <listitem>
     <para>
      The hostname of the SNMP agent (server).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>security_name</parameter></term>
    <listitem>
     <para>
      the security name, usually some kind of username
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>security_level</parameter></term>
    <listitem>
     <para>
      the security level (noAuthNoPriv|authNoPriv|authPriv)
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>auth_protocol</parameter></term>
    <listitem>
     <para>
      the authentication protocol (<literal>"MD5"</literal>, <literal>"SHA"</literal>,
      <literal>"SHA256"</literal>, or <literal>"SHA512"</literal>)
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>auth_passphrase</parameter></term>
    <listitem>
     <para>
      the authentication pass phrase
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>privacy_protocol</parameter></term>
    <listitem>
     <para>
      the privacy protocol (DES or AES)
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>privacy_passphrase</parameter></term>
    <listitem>
     <para>
      the privacy pass phrase
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>object_id</parameter></term>
    <listitem>
     <para>
      If &null;, <parameter>object_id</parameter> is taken as the root of
      the <acronym>SNMP</acronym> objects tree and all objects under that tree are returned as
      an array. 
     </para>
     <para>
      If <parameter>object_id</parameter> is specified, all the <acronym>SNMP</acronym> objects
      below that <parameter>object_id</parameter> are returned.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timeout</parameter></term>
    <listitem>
     <para>
      The number of microseconds until the first timeout.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>retries</parameter></term>
    <listitem>
     <para>
      The number of times to retry if timeouts occur.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array of <acronym>SNMP</acronym> object values starting from the
   <parameter>object_id</parameter> as root or &false; on error.
  </para>
 </refsect1>
 
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.1.0</entry>
       <entry>
        The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
        and <literal>"SHA512"</literal> when supported by libnetsnmp.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para> 
   <example>
    <title><function>snmp3_walk</function> Example</title>
    <programlisting role="php"> 
<![CDATA[
<?php
$ret = snmp3_walk('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifName');
var_export($ret);
?>
]]>
    </programlisting>
   </example>
  </para> 
  <para>
   Above function call would return all the <acronym>SNMP</acronym> objects from the
   <acronym>SNMP</acronym> agent running on localhost:
<![CDATA[      
array (
  0 => 'STRING: lo',
  1 => 'STRING: eth0',
  2 => 'STRING: eth2',
  3 => 'STRING: sit0',
  4 => 'STRING: sixxs',
)
]]>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>snmp3_real_walk</function></member>
   </simplelist>
  </para>
 </refsect1>
 
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
