mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
fa6e196973
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@313913 c90b9560-bf6c-de11-be94-00142212c4b1
123 lines
3.7 KiB
XML
123 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id='function.snmprealwalk' xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>snmprealwalk</refname>
|
|
<refpurpose>
|
|
Return all objects including their respective object ID within the specified one
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>snmprealwalk</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>int</type><parameter>timeout</parameter><initializer>1000000</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>5</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<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 times to retry if 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>
|
|
|
|
<!-- 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
|
|
-->
|
|
|