From dbb265ccc67e04b207c4dcdba2efc16778ef5473 Mon Sep 17 00:00:00 2001 From: Christian Hammers Date: Sat, 19 Feb 2011 18:49:13 +0000 Subject: [PATCH] Added documentation for the snmprealkwalk() function. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308493 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/snmp/functions/snmprealwalk.xml | 84 ++++++++++++++++++++++- 1 file changed, 81 insertions(+), 3 deletions(-) diff --git a/reference/snmp/functions/snmprealwalk.xml b/reference/snmp/functions/snmprealwalk.xml index 300c859de5..b46ee5af37 100644 --- a/reference/snmp/functions/snmprealwalk.xml +++ b/reference/snmp/functions/snmprealwalk.xml @@ -17,9 +17,86 @@ inttimeout intretries - - &warn.undocumented.func; - + + The snmprealwalk function is used to traverse over a number + of SNMP objects starting from object_id + and return not only their values but also their object ids. + + + + + &reftitle.parameters; + + + + host + The hostname of the SNMP agent (server). + + + community + The read community. + + + object_id + The SNMP object id which precedes the wanted one. + + + timeout + The number of microseconds until the first timeout. + + + retries + The number of retries in case timeouts occur. + + + + + + + &reftitle.returnvalues; + + Returns an associative array of the SNMP object ids and their values on success or &false; on error. + In case of an error, an E_WARNING message is shown. + + + + + &reftitle.examples; + + + Using <function>snmprealwalk</function> + + +]]> + + + + The above will output something like: + 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 + ) +]]> + + + + + + + &reftitle.seealso; + + + snmpwalk + + @@ -43,3 +120,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> +