sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added documentation for the snmprealkwalk() function.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308493 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christian Hammers 2011-02-19 18:49:13 +00:00
parent e61f791a33
commit dbb265ccc6
1 changed files with 81 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
reference/snmp/functions/snmprealwalk.xml
View file

@ -17,9 +17,86 @@
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
The <function>snmprealwalk</function> function is used to traverse over a number
of <acronym>SNMP</acronym> objects starting from <parameter>object_id</parameter>
and return not only their values but also their object ids.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<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 retries in case timeouts occur.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array of the <acronym>SNMP</acronym> object ids and their values 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>snmprealwalk</function></title>
<programlisting role="php">
<![CDATA[
<?php
print_r(snmprealwalk("localhost", "public", "IF-MIB::ifName"));
?>
]]>
</programlisting>
<para>
The above will output something like:
<![CDATA[
Array
(
[IF-MIB::ifName.1] => 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
)
]]>
</para>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>snmpwalk</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
@ -43,3 +120,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->