mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
fa6e196973
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@313913 c90b9560-bf6c-de11-be94-00142212c4b1
143 lines
3.8 KiB
XML
143 lines
3.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.snmp2-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>snmp2_walk</refname>
|
|
<refpurpose>Fetch all the <acronym>SNMP</acronym> objects from an agent</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>snmp2_walk</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>
|
|
<function>snmp2_walk</function> function is used to read all the values from
|
|
an <acronym>SNMP</acronym> agent specified by the <parameter>hostname</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>host</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The SNMP 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>
|
|
If &null;, <parameter>object_id</parameter> is taken as the root of
|
|
the <acronym>SNMP</acronym> objects tree and all objects under that tree are returned as
|
|
an array.
|
|
</para>
|
|
<para>
|
|
If <parameter>object_id</parameter> is specified, all the <acronym>SNMP</acronym> objects
|
|
below that <parameter>object_id</parameter> are returned.
|
|
</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 an array of <acronym>SNMP</acronym> object values starting from the
|
|
<parameter>object_id</parameter> as root or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>snm2_pwalk</function> Example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$a = snmp2_walk("127.0.0.1", "public", "");
|
|
|
|
foreach ($a as $val) {
|
|
echo "$val\n";
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
Above function call would return all the <acronym>SNMP</acronym> objects from the
|
|
<acronym>SNMP</acronym> agent running on localhost. One can step through the values
|
|
with a loop
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>snmp2_real_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
|
|
-->
|
|
|