File: snmp.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (343 lines) | stat: -rw-r--r-- 12,259 bytes parent folder | download
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
<?xml version="1.0" encoding="iso-8859-1"?>
 <reference id="ref.snmp">
  <title>SNMP Funktionen</title>
  <titleabbrev>SNMP</titleabbrev>

  <partintro>
   <simpara>
    Um die SNMP Funktionen unter Unix nutzen zu knnen muss das <ulink url="&url.ucd-snmp;">UCD SNMP</ulink> 
	Paket installiert sein. Unter Windows sind diese Funktionen nur unter NT verfgbar, nicht aber 
	unter Win95/98.
   </simpara>

   <simpara>
    WICHTIG: Um das UCD SNMP Paket zu nutzen muss NO_ZEROLENGTH_COMMUNITY als 1 definiert werden bevor man es kompiliert.
    Nache dem Konfigureieren UCD SNMP muss in der Datei config.h die Zeile mit NO_ZEROLENGTH_COMMUNITY auskommentiert werden.
    Die Zeile sollte danach so aussehen:</simpara>

  <para>
    <programlisting role="c">
<![CDATA[
#define NO_ZEROLENGTH_COMMUNITY 1
]]>
    </programlisting>
   </para>
   <simpara>
    Wenn seltsame "segmentation faults" in Verbindung mit SNMP Kommandos auftauchen,
    wurden die obigen Anweisungen nicht korrekt befolgt.
    Als eine Alternative zum Neukompilieren des Packets, kann mann auch PHP mit der option
    --enable-ucd-snmp-hack kompilieren.</simpara>
    
  </partintro>

  <refentry id="function.snmpget">
   <refnamediv>
    <refname>snmpget</refname>
    <refpurpose>Ein SNMP Objekt holen</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>snmpget</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>
     Gibt den Wert eines SNMP Objektes zurck, bei Erfolg und &false; bei einem Fehler.</para>

    <para>
     Die <function>snmpget</function> Funktion wird verwendet um den Wert eines SNMP Objekts zu ermitteln,
     das mit <parameter>object_id</parameter> nher bestimmt ist. Der  SNMP "agent" wird mit <parameter>hostname</parameter>
     deklariert und die "read community" wird in <parameter>community</parameter> angegeben.</para>

    <para>
     <informalexample>
      <programlisting role="php">
<![CDATA[
$syscontact = snmpget("127.0.0.1", "public", "system.SysContact.0");
]]>
      </programlisting>
     </informalexample>
    </para>

   </refsect1>
  </refentry>

  <refentry id="function.snmpset">
   <refnamediv>
    <refname>snmpset</refname>
    <refpurpose>Setzt ein SNMP Objekt</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>snmpset</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><type>string</type><parameter>type</parameter></methodparam>
      <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam>
     </methodsynopsis>

    <para>
	 Setzt den angegebenen SNMP Objekt Wert, gibt &true; bei Erfolg
	 und &false; bei einem Fehler zurck.
     Sets the specified SNMP object value, returning &true; on success
   </para>

    <para>
	 Die Funktion <function>snmpset</function> wird benutzt, um den Wert
	 eines SNMP Objekts zu setzen, der mit <parameter>object_id</parameter>
	 angegeben wird. Der SNMP Agent wird bei <parameter>hostname</parameter>
	 angegeben und die Lese-"Community" mit dem <parameter>community</parameter>
	 Parameter.
	</para>

   </refsect1>
  </refentry>

  <refentry id="function.snmpwalk">
   <refnamediv>
    <refname>snmpwalk</refname>
    <refpurpose>Holt alle SNMP Objekte eines Agenten</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>snmpwalk</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>
	 Gibt einen Array von SNMP Objekten zurck, der mit der 
     <function>object_id</function> als Wurzel beginn, oder  &false; 
	 bei einem Fehler.
	</para>

    <para> 
     Die <function>snmpwalk</function> Funktion wird verwendet um alle Werte von 
     dem SNMP Agenten zu lesen, der bei <parameter>hostname</parameter> angegebn 
	 wurde. Der <parameter>Community</parameter> Parameter bestimm die Lese-"Community" 
	 fr diesen Agenten. Ein &null; <parameter>object_id</parameter> wird als Wurzel des
	 SNMP Objektbaums verwendet und alle Objekts unter diesem Baum als ein Array 
	 zurckgegeben. Wenn <parameter>object_id</parameter> angegeben wird, werden alle 
	 SNMP Objekte unterhalb der <parameter>object_id</parameter> zurckgegeben.

     <informalexample>
      <programlisting role="php"> 
<![CDATA[
$a = snmpwalk("127.0.0.1", "public", ""); 
]]>
      </programlisting>
     </informalexample></para> 

    <para>
     Der obige Funktionsaufruf gibt alle SNMP Objekte des Agenten, der auf
	 localhost luft, zurck. Man kann mit einer Schleife alle Werte 
	 durchlaufen.

     <informalexample>
      <programlisting role="php">
<![CDATA[
for ($i=0; $i < count($a); $i++) {
    echo $a[$i];
}
]]>
      </programlisting>
     </informalexample></para>
	
   </refsect1>
  </refentry>


  <refentry id="function.snmpwalkoid">
   <refnamediv>
    <refname>snmpwalkoid</refname>
    <refpurpose>Abfrage ber einen Baum einer Netzwerkeinheit.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</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>
	 Gibt ein assoziatives Array mit den Objekt Ids und den dazugehrigen
	 Objektwerten zurck, der mit der <parameter>object_id</parameter> als
	 Wurzel beginnt, oder &false; bei einem Fehler.</para>

    <para>
     Die <function>snmpwalkoid</function> Funktion wird verwendet um alle Werte von 
     dem SNMP Agenten zu lesen, der bei <parameter>hostname</parameter> angegebn 
	 wurde. Der <parameter>Community</parameter> Parameter bestimm die Lese-"Community" 
	 fr diesen Agenten. Ein &null; <parameter>object_id</parameter> wird als Wurzel des
	 SNMP Objektbaums verwendet und alle Objekts unter diesem Baum als ein Array 
	 zurckgegeben. Wenn <parameter>object_id</parameter> angegeben wird, werden alle 
	 SNMP Objekte unterhalb der <parameter>object_id</parameter> zurckgegeben.</para>

    <para>
	 Die Existenz von <function>snmpwalkoid</function> und
     <function>snmpwalk</function> hat historische Grnde. Beide Funktionen gibt es
	 aus Kompatiblittsgrnden.

         <informalexample>
      <programlisting role="php"> 
<![CDATA[
$a = snmpwalkoid("127.0.0.1", "public", ""); 
]]>
      </programlisting>
     </informalexample></para> 

    <para>
     Der obige Funktionsaufruf gibt alle SNMP Objekte des Agenten, der auf
	 localhost luft, zurck. Man kann mit einer Schleife alle Werte 
	 durchlaufen.

     <informalexample>
      <programlisting role="php">
<![CDATA[
for ($i=0; $i < count($a); $i++) {
    echo $a[$i];
}
]]>
      </programlisting>
     </informalexample></para>
   </refsect1>
  </refentry>


  <refentry id="function.snmp-get-quick-print">
   <refnamediv>
    <refname>snmp_get_quick_print</refname>
    <refpurpose>Holt den aktuellen Wert der quick_print Einstellung der UCD Bibliothek
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>boolean</type><methodname>snmp_get_quick_print</methodname>
      <methodparam><type>void</type><parameter/></methodparam>
     </methodsynopsis>

    <para>
	 Gibt den aktuellen Wert von quick_print der UCD Bibliothek zurck.
     quick_print ist standartmig abgeschaltet.

     <informalexample>
      <programlisting role="php"> 
<![CDATA[
$quickprint = snmp_get_quick_print();
]]>
      </programlisting>
     </informalexample></para> 

    <para>
	 Der obige Funktionsaufruf gibt &false; zurck, wenn
	 quick_print ausgeschaltet ist und &true;, wenn quick_print
     eingeschaltet ist.</para>

    <para>
     Die <function>snmp_get_quick_print</function> Funktion ist nur bei Verwendung der 
	 SNMP Bibliothek verfgbar, jedoch nicht bei Verwendung der Windows SNMP Bibliothek.</para>

    <para>
     Siehe: <function>snmp_set_quick_print</function> fr eine Vollstndie Beschreibung was
	 quick_print bewirkt..</para>
	
   </refsect1>
  </refentry>

  <refentry id="function.snmp-set-quick-print">
   <refnamediv>
    <refname>snmp_set_quick_print</refname>
    <refpurpose>Setzt den Wert von quick_print innerhalb der UCD SNMP Bibliothek.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>void</type><methodname>snmp_set_quick_print</methodname>
      <methodparam><type>boolean</type><parameter>quick_print</parameter></methodparam>
     </methodsynopsis>

    <para>
	 Setzt den Wert von quick_print innerhalb der UCD SNMP Bibliothek.
	 Falls esgesetzt ist (1), wird die SNMP Bibliothek 'quick printed' Werte zurckgeben. 
	 Das Bedeutet, dass nur der Wert ausgegeben wird. Wenn quick_print nicht aktiviert ist,
	 (Standarteinstellung) gibt die UCD SNMP Bibliothek extra Informationen aus, die den Typ
	 des Wertes (z.B. IpAddress oder OID) enhalten. Zustzlich gibt die Bibliothek Hex-Werte 
	 fr alle Werte, die weniger als vier Zeichen haben, aus, wenn quick_print nicht aktiviert ist. 
	</para>

    <para>
	 quick_print wird oft verwendet um die Informationen, die zurckgegeben werden, weiterzuverwenden
	 anstatt sie auszugeben.

     <informalexample>
      <programlisting role="php"> 
<![CDATA[
snmp_set_quick_print(0);
$a = snmpget("127.0.0.1", "public", ".1.3.6.1.2.1.2.2.1.9.1");
echo "$a<BR>\n";
snmp_set_quick_print(1);
$a = snmpget("127.0.0.1", "public", ".1.3.6.1.2.1.2.2.1.9.1");
echo "$a<BR>\n";
]]>
      </programlisting>
     </informalexample></para> 

    <para>
     Der erste Wert, der ausgegeben wird, ist:: 'Timeticks: (0) 0:00:00.00', waehrend mit 
     aktiviertem quick_print, nur '0:00:00.00' ausgegeben wird.</para>

    <para>
     Standartmig gibt die UCD SNMP umfangreiche Werte zurck, quick_print wird
	 verwendet um nur die Werte zurckzugeben.</para>

    <para>
	 Momentan werden Strings noch mit extra Quotierungen zurckgegeben, dies wird in Zukunft 
	 behoben werden.</para>

    <para>
     Die <function>snmp_set_quick_print</function> Funktion ist nur bei Verwendung der 
	 SNMP Bibliothek verfgbar, jedoch nicht bei Verwendung der Windows SNMP Bibliothek.</para>

   </refsect1>
  </refentry>

 </reference>

<!-- 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:
-->