1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/snmp.xml, last change in rev 1.2 -->
<refentry id="function.snmpwalkoid">
<refnamediv>
<refname>snmpwalkoid</refname>
<refpurpose>Query for a tree of information about a network entity
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>snmpwalkoid</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type>string</type><parameter>object_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam>
</methodsynopsis>
<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>
<para>
<function>snmpwalkoid</function> function is used to read all
object ids and their respective values from an SNMP agent
specified by the <parameter>hostname</parameter>. 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>
<para>
The existence of <function>snmpwalkoid</function> and
<function>snmpwalk</function> has historical reasons. Both
functions are provided for backward compatibility.
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$a = snmpwalkoid("127.0.0.1", "public", "");
?>
]]>
</programlisting>
</informalexample>
</para>
<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">
<![CDATA[
<?php
for (reset($a); $i = key($a); next($a)) {
echo "$i: $a[$i]<br />\n";
}
?>
]]>
</programlisting>
</informalexample>
</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:"../../../../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
-->
|
