CVS update: php3/doc/functions

Date: Friday April 2, 1999 @ 21:43 Author: sas Update of /repository/php3/doc/functions In directory asf:/u/temp/cvs-serv3236 Modified Files: snmp.sgml Log Message: add doc for snmprealwalk Index: php3/doc/functions/snmp.sgml diff -c php3/doc/functions/snmp.sgml:1.7 php3/doc/functions/snmp.sgml:1.8 *** php3/doc/functions/snmp.sgml:1.7 Fri Nov 13 05:45:05 1998 --- php3/doc/functions/snmp.sgml Fri Apr 2 21:43:34 1999 *************** *** 36,42 **** </refsect1> </refentry> - <refentry id="function.snmpwalk"> <refnamediv> <refname>snmpwalk</refname> --- 36,41 ---- *************** *** 49,55 **** <paramdef>string <parameter>hostname</parameter></paramdef> <paramdef>string <parameter>community</parameter></paramdef> <paramdef>string <parameter>object_id</parameter></paramdef> ! </funcsynopsis> <para> Returns an array of SNMP object values starting from the object_id as root and false on error. --- 48,56 ---- <paramdef>string <parameter>hostname</parameter></paramdef> <paramdef>string <parameter>community</parameter></paramdef> <paramdef>string <parameter>object_id</parameter></paramdef> ! <paramdef>int <parameter><optional>timeout</optional></parameter></paramdef> ! <paramdef>int <parameter><optional>retries</optional></parameter></paramdef> ! </funcsynopsis> <para> Returns an array of SNMP object values starting from the object_id as root and false on error. *************** *** 81,86 **** --- 82,138 ---- </reference> + + <refentry id="function.snmprealwalk"> + <refnamediv> + <refname>snmprealwalk</refname> + <refpurpose>Query for a tree of information about a network entity</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>array <function>snmprealwalk</function></funcdef> + <paramdef>string <parameter>hostname</parameter></paramdef> + <paramdef>string <parameter>community</parameter></paramdef> + <paramdef>string <parameter>object_id</parameter></paramdef> + <paramdef>int <parameter><optional>timeout</optional></parameter></paramdef> + <paramdef>int <parameter><optional>retries</optional></parameter></paramdef> + </funcsynopsis> + <para> + Returns an associative array with object ids and their respective object + value starting from the object_id as root and false on error. + <para> + snmprealwalk() function is used to read all object ids and their + respective values from an SNMP agent specified by the hostname. Community + specifies the read community for that agent. A null object_id is taken as + the root of the SNMP objects tree and all objects under that tree are + returned as an array. If object_id is specified, all the SNMP objects below + that object_id are returned. + <para> + The existence of snmprealwalk() and snmpwalk() has historical reasons. + Both functions are provided for backward compatibility. + + <informalexample><programlisting> + $a = snmprealwalk("127.0.0.1", "public", ""); + </programlisting></informalexample> + + <para> + Above function call would return all the SNMP objects from the + SNMP agent running on localhost. One can step through the + values with a loop + + <informalexample><programlisting> + for(reset($a); $i = key($a); next($a)) { + echo "$i: $a[$i]<br>\n"; + } + </programlisting></informalexample> + + </refsect1> + </refentry> + + + </reference> + <!-- Keep this comment at the end of the file Local variables: -- PHP Development Mailing List http://www.php.net/ To unsubscribe send an empty message to php-dev-unsubscribe@lists.php.net For help: php-dev-help@lists.php.net