Files
php-doc-ru/reference/snmp/snmp.xml
2024-11-09 23:44:03 +03:00

412 lines
17 KiB
XML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 976425d4f6eec32448be3cc22ec063015921b753 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<reference xml:id="class.snmp" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Класс SNMP</title>
<titleabbrev>SNMP</titleabbrev>
<partintro>
<!-- {{{ SNMP intro -->
<section xml:id="snmp.intro">
&reftitle.intro;
<para>
Представляет сессию протокола <acronym>SNMP</acronym>.
</para>
</section>
<!-- }}} -->
<section xml:id="snmp.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis class="class">
<ooclass>
<classname>SNMP</classname>
</ooclass>
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.version-1">SNMP::VERSION_1</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.version-2c">SNMP::VERSION_2c</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.version-2c">SNMP::VERSION_2C</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.version-3">SNMP::VERSION_3</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.errno-noerror">SNMP::ERRNO_NOERROR</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.errno-any">SNMP::ERRNO_ANY</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.errno-generic">SNMP::ERRNO_GENERIC</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.errno-timeout">SNMP::ERRNO_TIMEOUT</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.errno-error-in-reply">SNMP::ERRNO_ERROR_IN_REPLY</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.errno-oid-not-increasing">SNMP::ERRNO_OID_NOT_INCREASING</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.errno-oid-parsing-error">SNMP::ERRNO_OID_PARSING_ERROR</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="snmp.constants.errno-multiple-set-queries">SNMP::ERRNO_MULTIPLE_SET_QUERIES</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>array</type>
<varname linkend="snmp.props.info">info</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type class="union"><type>int</type><type>null</type></type>
<varname linkend="snmp.props.max-oids">max_oids</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>int</type>
<varname linkend="snmp.props.valueretrieval">valueretrieval</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="snmp.props.quick-print">quick_print</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="snmp.props.enum-print">enum_print</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>int</type>
<varname linkend="snmp.props.oid-output-format">oid_output_format</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="snmp.props.oid-increasing-check">oid_increasing_check</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>int</type>
<varname linkend="snmp.props.exceptions-enabled">exceptions_enabled</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.snmp')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='SNMP'])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.snmp')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SNMP'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
<!-- {{{ SNMP properties -->
<section xml:id="snmp.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="snmp.props.max-oids">
<term><varname>max_oids</varname></term>
<listitem>
<para>Максимальный идентификатор OID для запросов GET, SET или GETBULK</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.valueretrieval">
<term><varname>valueretrieval</varname></term>
<listitem>
<para>Управляет методом возврата SNMP-значений</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row><entry><constant>SNMP_VALUE_LIBRARY</constant></entry><entry>Возвращаемые значения будут такими, как будто их вернула библиотека Net-SNMP.</entry></row>
<row><entry><constant>SNMP_VALUE_PLAIN</constant></entry><entry>Возвращаемые значения будут простыми, без информации о типах SNMP.</entry></row>
<row>
<entry><constant>SNMP_VALUE_OBJECT</constant></entry><entry>
Возвращаемые значения будут объектами со свойствами value и type,
где type будет содержать одну из констант: SNMP_OCTET_STR, SNMP_COUNTER и т. д.,
а value будет зависеть от того, установили
<constant>SNMP_VALUE_LIBRARY</constant> или
<constant>SNMP_VALUE_PLAIN</constant>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.quick-print">
<term><varname>quick_print</varname></term>
<listitem>
<para>Значение параметра <parameter>quick_print</parameter>
в библиотеке NET-<acronym>SNMP</acronym></para>
<para>
Устанавливает значение <parameter>quick_print</parameter> в библиотеке
NET-<acronym>SNMP</acronym>. если задали как (1), библиотека
<acronym>SNMP</acronym> будет возвращать значения «quick printed».
То есть будут напечатаны только значения. Если
параметр <parameter>quick_print</parameter> не разрешён (по умолчанию), библиотека
NET-<acronym>SNMP</acronym> будет печатать дополнительную информацию,
включая тип значения (то есть IpAddress или OID). Дополнительно, если
параметр quick_print не разрешён, библиотека будет печатать шестнадцатеричные значения
для каждой строки короче четырёх символов.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.enum-print">
<term><varname>enum_print</varname></term>
<listitem>
<para>Контролирует способ, которым будут печататься значения перечислений</para>
<para>
Параметр переключает поведение walk или get и т. д., чтобы они автоматически смотрели
значения перечислений в MIB и возвращали их вместе с понятным человеку текстом.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.oid-output-format">
<term><varname>oid_output_format</varname></term>
<listitem>
<para>Контролирует формат вывода OID</para>
<table>
<title>OID-представление .1.3.6.1.2.1.1.3.0 для различных значений
<varname>oid_output_format</varname></title>
<tgroup cols="2">
<tbody>
<row><entry><constant>SNMP_OID_OUTPUT_FULL</constant></entry><entry>.iso.org.dod.internet.mgmt.mib-2.system.sysUpTime.sysUpTimeInstance</entry></row>
<row><entry><constant>SNMP_OID_OUTPUT_NUMERIC</constant></entry><entry>.1.3.6.1.2.1.1.3.0</entry> </row>
<row><entry><constant>SNMP_OID_OUTPUT_MODULE</constant></entry><entry>DISMAN-EVENT-MIB::sysUpTimeInstance</entry></row>
<row><entry><constant>SNMP_OID_OUTPUT_SUFFIX</constant></entry><entry>sysUpTimeInstance</entry></row>
<row><entry><constant>SNMP_OID_OUTPUT_UCD</constant></entry><entry>system.sysUpTime.sysUpTimeInstance</entry></row>
<row><entry><constant>SNMP_OID_OUTPUT_NONE</constant></entry><entry>Undefined</entry></row>
</tbody>
</tgroup>
</table>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.oid-increasing-check">
<term><varname>oid_increasing_check</varname></term>
<listitem>
<para>Контролирует запрет на проверку увеличения идентификатора OID при обходе дерева OID</para>
<para>
Некоторые агенты <acronym>SNMP</acronym> известны тем, что возвращают
OID-идентификатор объекта не по порядку, но всё равно завершают проход.
Другие агенты, возвращают OID не по порядку и иногда вызывают бесконечное зацикливание
метода <methodname>SNMP::walk</methodname>, пока не закончится память.
PHP-модуль SNMP по умолчанию предпринимает проверку увеличения OID
и прекращает обход дерева, если определяет возможную закольцовку, выдавая
соответствующее предупреждение.
Для переменной <varname>oid_increasing_check</varname> устанавливают значение &false;,
чтобы запретить эту проверку.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.exceptions-enabled">
<term><varname>exceptions_enabled</varname></term>
<listitem>
<para>
Определяет, какие сбои будут выбрасывать исключение SNMPException
вместо предупреждения. Принимает константы семейства
<constant>SNMP::ERRNO_<replaceable>*</replaceable></constant> через побитовое ИЛИ.
По умолчанию SNMP не выбрасывает исключения.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.props.info">
<term><varname>info</varname></term>
<listitem>
<para>Свойство только для чтения, которое содержит конфигурацию
удалённого агента: имя хоста, порт, время ожидания по умолчанию, количество повторов
по умолчанию.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ SNMP constants -->
<section xml:id="class.snmp.constants">
&reftitle.constants;
<section xml:id="snmp.constants.error-types">
<title>Типы ошибок <acronym>SNMP</acronym></title>
<variablelist>
<varlistentry xml:id="snmp.constants.errno-noerror">
<term><constant>SNMP::ERRNO_NOERROR</constant></term>
<listitem>
<para>Ошибки <acronym>SNMP</acronym> отсутствуют.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.constants.errno-generic">
<term><constant>SNMP::ERRNO_GENERIC</constant></term>
<listitem>
<para>Общая ошибка <acronym>SNMP</acronym>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.constants.errno-timeout">
<term><constant>SNMP::ERRNO_TIMEOUT</constant></term>
<listitem>
<para>Превышено время ожидания запроса к <acronym>SNMP</acronym>-агенту.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.constants.errno-error-in-reply">
<term><constant>SNMP::ERRNO_ERROR_IN_REPLY</constant></term>
<listitem>
<para><acronym>SNMP</acronym>-агент вернул ошибку в ответ.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.constants.errno-oid-not-increasing">
<term><constant>SNMP::ERRNO_OID_NOT_INCREASING</constant></term>
<listitem>
<para>
<acronym>SNMP</acronym>-агент обнаружил возможную закольцовку
из-за неувеличения OID-идентификатора объекта при выполнении команд (BULK)WALK.
Это говорит о том, что удалённый <acronym>SNMP</acronym>-агент фиктивный.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.constants.errno-oid-parsing-error">
<term><constant>SNMP::ERRNO_OID_PARSING_ERROR</constant></term>
<listitem>
<para>
Библиотека не разобрала OID-идентификатор объекта (и (или) тип для команды SET).
Запросов не было.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.constants.errno-multiple-set-queries">
<term><constant>SNMP::ERRNO_MULTIPLE_SET_QUERIES</constant></term>
<listitem>
<para>
Библиотека использует множественные запросы для операции SET.
Это означает, что операция будет выполняться без транзакции,
и, если возникнет ошибка типа или значения, второй или последующие фрагменты
иногда завершаются ошибкой.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.constants.errno-any">
<term><constant>SNMP::ERRNO_ANY</constant></term>
<listitem>
<para>
Все коды SNMP::ERRNO_* объединённые побитовым ИЛИ.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="snmp.constants.protocols">
<title>Версии протокола <acronym>SNMP</acronym></title>
<variablelist>
<varlistentry xml:id="snmp.constants.version-1">
<term><constant>SNMP::VERSION_1</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.constants.version-2c">
<term><constant>SNMP::VERSION_2C</constant>, <constant>SNMP::VERSION_2c</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="snmp.constants.version-3">
<term><constant>SNMP::VERSION_3</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<!-- }}} -->
</partintro>
&reference.snmp.entities.snmp;
</reference>
<!-- 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
-->