CVS update: php3/doc/functions

Date: Saturday April 3, 1999 @ 2:43 Author: eschmid Update of /repository/php3/doc/functions In directory asf:/u/temp/cvs-serv5566 Modified Files: snmp.sgml Log Message: Made it readable. Index: php3/doc/functions/snmp.sgml diff -c php3/doc/functions/snmp.sgml:1.8 php3/doc/functions/snmp.sgml:1.9 *** php3/doc/functions/snmp.sgml:1.8 Fri Apr 2 21:43:34 1999 --- php3/doc/functions/snmp.sgml Sat Apr 3 02:43:02 1999 *************** *** 3,13 **** <titleabbrev>SNMP</titleabbrev> <partintro> ! <simpara> ! In order to use the SNMP functions on Unix you need to install the ucd-snmp package. ! There is a link to the current version in the PHP FAQ. On Windows these functions are ! only available on NT and not on Win95/98. </partintro> <refentry id="function.snmpget"> <refnamediv> <refname>snmpget</refname> --- 3,15 ---- <titleabbrev>SNMP</titleabbrev> <partintro> ! <simpara> ! In order to use the SNMP functions on Unix you need to install the ! ucd-snmp package. There is a link to the current version in the ! PHP FAQ. On Windows these functions are only available on NT and ! not on Win95/98. </partintro> + <refentry id="function.snmpget"> <refnamediv> <refname>snmpget</refname> *************** *** 21,38 **** <paramdef>string <parameter>community</parameter></paramdef> <paramdef>string <parameter>object_id</parameter></paramdef> </funcsynopsis> <para> ! Returns SNMP object value on success and false on error. ! <para> ! The snmpget() function is used to read the value of an SNMP object ! specified by the object_id. SNMP agent is specified by the hostname and ! the read community is specified by the community parameter. ! <para> ! <informalexample> ! <literallayout> ! snmpget("127.0.0.1", "public", "system.SysContact.0") ! </literallayout> </informalexample> </refsect1> </refentry> --- 23,46 ---- <paramdef>string <parameter>community</parameter></paramdef> <paramdef>string <parameter>object_id</parameter></paramdef> </funcsynopsis> + + <para> + Returns SNMP object value on success and false on error. + + <para> + The <function>snmpget</function> function is used to read the + value of an SNMP object specified by the + <parameter>object_id</parameter>. SNMP agent is specified by the + <parameter>hostname</parameter> and the read community is + specified by the <parameter>community</parameter> parameter. + <para> ! <informalexample> ! <literallayout> ! snmpget("127.0.0.1", "public", "system.SysContact.0") ! </literallayout> </informalexample> + </refsect1> </refentry> *************** *** 48,92 **** <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. ! <para> ! snmpwalk() function is used to read all the 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. ! <informalexample><programlisting> $a = snmpwalk("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($i=0; $i&lt;count($a); $i++) { ! echo $a[$i]; } ! </programlisting></informalexample> </refsect1> </refentry> - </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> --- 56,110 ---- <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 ! <function>object_id</function> as root and false on error. ! ! <para> ! <function>snmpwalk</function> function is used to read all the ! values from an SNMP agent specified by the ! <parameter>hostname</parameter>. <parameter>Community</parameter> ! specifies the read community for that agent. A null ! <parameter>object_id</parameter> is taken as the root of the SNMP ! objects tree and all objects under that tree are returned as an ! array. If <parameter>object_id</parameter> is specified, all the ! SNMP objects below that <parameter>object_id</parameter> are ! returned. ! <informalexample> ! <programlisting role="php"> $a = snmpwalk("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 role="php"> ! for ($i=0; $i&lt;count($a); $i++) { ! echo $a[$i]; } ! </programlisting> ! </informalexample> </refsect1> </refentry> <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> *************** *** 95,135 **** <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> --- 113,166 ---- <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 <parameter>object_id</parameter> + as root and false on error. + <para> ! <function>snmprealwalk</function> function is used to read all ! object ids and their respective values from an SNMP agent ! specified by the hostname. Community specifies the read ! <parameter>community</parameter> for that agent. A null ! <parameter>object_id</parameter> is taken as the root of the SNMP ! objects tree and all objects under that tree are returned as an ! array. If <parameter>object_id</parameter> is specified, all the ! SNMP objects below that <parameter>object_id</parameter> are ! returned. ! <para> ! The existence of <function>snmprealwalk</function> and ! <function>snmpwalk</function> has historical reasons. Both ! functions are provided for backward compatibility. ! <informalexample> ! <programlisting role="php"> $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 role="php"> ! for (reset($a); $i = key($a); next($a)) { ! echo "$i: $a[$i]&lt;br>\n"; } ! </programlisting> ! </informalexample> </refsect1> </refentry> </reference> -- 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