Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions reference/snmp/functions/snmpgetnext.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 330a38c4d45556b49e06ebe6d39e0e311534cd8c Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmpgetnext">
<refnamediv>
<refname>snmpgetnext</refname>
<refpurpose>
Liest das <acronym>SNMP</acronym>-Objekt, das auf die angegebene Object ID (OID) folgt
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>snmpgetnext</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>

<simpara>
Die Funktion <function>snmpgetnext</function> wird verwendet, um den
Wert des <acronym>SNMP</acronym>-Objekts zu lesen, das auf die angegebene
<parameter>object_id</parameter> folgt.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem><simpara>Der Hostname des <acronym>SNMP</acronym>-Agenten (Servers).</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>community</parameter></term>
<listitem><simpara>Die Lese-Community.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>object_id</parameter></term>
<listitem><simpara>Die Object ID (OID) des <acronym>SNMP</acronym>-Objekts, das dem gewünschten vorangeht.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem><simpara>Die Anzahl der Mikrosekunden bis zur ersten Zeitüberschreitung.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>retries</parameter></term>
<listitem><simpara>Die Anzahl der Wiederholungsversuche, falls Zeitüberschreitungen auftreten.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Gibt bei Erfolg den Wert des <acronym>SNMP</acronym>-Objekts zurück oder &false; im Fehlerfall.
Im Fehlerfall wird eine E_WARNING-Meldung ausgegeben.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Verwendung von <function>snmpgetnext</function></title>
<programlisting role="php">
<![CDATA[
<?php
$nameOfSecondInterface = snmpgetnext('localhost', 'public', 'IF-MIB::ifName.1');
?>
]]>
</programlisting>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>snmpget</function></member>
<member><function>snmpwalk</function></member>
</simplelist>
</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
-->
139 changes: 139 additions & 0 deletions reference/snmp/snmp/getnext.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 330a38c4d45556b49e06ebe6d39e0e311534cd8c Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="snmp.getnext">
<refnamediv>
<refname>SNMP::getnext</refname>
<refpurpose>Liest ein <acronym>SNMP</acronym>-Objekt, das
auf die angegebene Object ID (OID) folgt
</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;

<methodsynopsis role="SNMP">
<modifier>public</modifier> <type>mixed</type><methodname>SNMP::getnext</methodname>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>objectId</parameter></methodparam>
</methodsynopsis>
<simpara>
Liest ein <acronym>SNMP</acronym>-Objekt, das auf die angegebene <parameter>objectId</parameter> folgt.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<simpara>
Ist <parameter>objectId</parameter> eine Zeichenkette, so gibt <methodname>SNMP::getnext</methodname>
das <acronym>SNMP</acronym>-Objekt als Zeichenkette zurück. Ist
<parameter>objectId</parameter> ein Array, so werden alle angeforderten <acronym>SNMP</acronym>-Objekte
als assoziatives Array der Object IDs (OIDs) der <acronym>SNMP</acronym>-Objekte und ihrer
Werte zurückgegeben.
</simpara>
<variablelist>
<varlistentry>
<term><parameter>objectId</parameter></term>
<listitem>
<simpara>
Das <acronym>SNMP</acronym>-Objekt (OID) oder die Objekte
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Gibt die angeforderten <acronym>SNMP</acronym>-Objekte als Zeichenkette oder Array
zurück, abhängig vom Typ der <parameter>objectId</parameter>, oder &false; im Fehlerfall.
</simpara>
</refsect1>

&snmp.methods.exceptions_enable.refsect;

<refsect1 role="examples">
&reftitle.examples;
<example xml:id="snmp.getnext.example.singleoid">
<title>Einzelnes <acronym>SNMP</acronym>-Objekt</title>
<simpara>
Ein einzelnes <acronym>SNMP</acronym>-Objekt kann auf zwei Arten angefordert werden: als
Zeichenkette, was einen Rückgabewert vom Typ Zeichenkette ergibt, oder als einelementiges Array
mit einem assoziativen Array als Ausgabe.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
$session = new SNMP(SNMP::VERSION_1, "127.0.0.1", "public");
$nsysdescr = $session->getnext("sysDescr.0");
echo "$nsysdescr\n";
$nsysdescr = $session->getnext(array("sysDescr.0"));
print_r($nsysdescr);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
OID: NET-SNMP-MIB::netSnmpAgentOIDs.8
Array
(
[SNMPv2-MIB::sysObjectID.0] => OID: NET-SNMP-MIB::netSnmpAgentOIDs.8
)
]]>
</screen>
</example>
<example xml:id="snmp.getnext.example.oidarray">
<title>Mehrere <acronym>SNMP</acronym>-Objekte</title>
<programlisting role="php">
<![CDATA[
<?php
$session = new SNMP(SNMP::VERSION_1, "127.0.0.1", "public");
$results = $session->getnext(array("sysDescr.0", "sysName.0"));
print_r($results);
$session->close();
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[SNMPv2-MIB::sysObjectID.0] => OID: NET-SNMP-MIB::netSnmpAgentOIDs.8
[SNMPv2-MIB::sysLocation.0] => STRING: Nowhere
)
]]>
</screen>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>SNMP::getErrno</methodname></member>
<member><methodname>SNMP::getError</methodname></member>
</simplelist>
</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
-->
Loading
Loading