snmpwalk.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: evvc Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.snmpwalk" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>snmpwalk</refname>
  <refpurpose>Получает все объекты <acronym>SNMP</acronym> из агента</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>snmpwalk</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>

  <para>
   Функция <function>snmpwalk</function> используется для чтения всех значений из агента <acronym>SNMP</acronym>,
   указанного в <parameter>hostname</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       Агент SNMP (сервер).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>community</parameter></term>
     <listitem>
      <para>
       Read-сообщество.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>object_id</parameter></term>
     <listitem>
      <para>
       Если &null;, <parameter>object_id</parameter> берётся в качестве корня дерева объектов <acronym>SNMP</acronym>
       и все объекты этого дерева возвращаются в виде массива.
      </para>
      <para>
       Если указан <parameter>object_id</parameter>, возвращаются все объекты <acronym>SNMP</acronym>
       ниже этого <parameter>object_id</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>timeout</parameter></term>
     <listitem>
      <para>
       Время ожидания в микросекундах.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>retries</parameter></term>
     <listitem>
      <para>
       Количество повторных попыток при истечении времени ожидания.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает массив значений объекта <acronym>SNMP</acronym>,
   начиная с <parameter>object_id</parameter> в качестве корня или &false; в случае возникновения ошибки.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>snmpwalk</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$a = snmpwalk("127.0.0.1", "public", "");

foreach ($a as $val) {
    echo "$val\n";
}

?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   Вызов функции вернёт все объекты <acronym>SNMP</acronym> из агента <acronym>SNMP</acronym>, работающего на localhost.
   Можно перемещаться по значениям с помощью цикла.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>snmprealwalk</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
-->