File: snmp2-getnext.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (130 lines) | stat: -rw-r--r-- 3,559 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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 327201 $ -->

<refentry xml:id="function.snmp2-getnext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>snmp2_getnext</refname>
  <refpurpose>Fetch the <acronym>SNMP</acronym> object which follows the given object id</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>snmp2_getnext</methodname>
   <methodparam><type>string</type><parameter>host</parameter></methodparam>
   <methodparam><type>string</type><parameter>community</parameter></methodparam>
   <methodparam><type>string</type><parameter>object_id</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>timeout</parameter><initializer>1000000</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>retries</parameter><initializer>5</initializer></methodparam>
  </methodsynopsis>
  <para>
   The <function>snmp2_get_next</function> function is used to read the
   value of the <acronym>SNMP</acronym> object that follows the specified
   <parameter>object_id</parameter>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>host</parameter></term>
    <listitem>
     <para>
      The hostname of the <acronym>SNMP</acronym> agent (server).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>community</parameter></term>
    <listitem>
     <para>
      The read community.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>object_id</parameter></term>
    <listitem>
     <para>
      The <acronym>SNMP</acronym> object id which precedes the wanted one.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timeout</parameter></term>
    <listitem>
     <para>
      The number of microseconds until the first timeout.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>retries</parameter></term>
    <listitem>
     <para>
      The number of times to retry if timeouts occur.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns <acronym>SNMP</acronym> object value on success or &false; on error.
   In case of an error, an E_WARNING message is shown.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>snmp2_get_next</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$nameOfSecondInterface = snmp2_get_next('localhost', 'public', 'IF-MIB::ifName.1';
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>snmp2_get</function></member>
    <member><function>snmp2_walk</function></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->