snmp.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 40906725410aac6fe8cac4913a557a1784bf04b9 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.snmp" role="class">
 <title>SNMP クラス</title>
 <titleabbrev>SNMP</titleabbrev>

 <partintro>

<!-- {{{ SNMP intro -->
  <section xml:id="snmp.intro">
   &reftitle.intro;
   <simpara>
    <acronym>SNMP</acronym> セッションを表します。
   </simpara>
  </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>
      <simpara>GET/SET/GETBULK リクエスト単位の最大の OID</simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="snmp.props.valueretrieval">
     <term><varname>valueretrieval</varname></term>
     <listitem>
      <simpara>SNMP の値を返す方法</simpara>
      <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"
           を持ち、後者のプロパティの値は 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>
      <simpara>NET-<acronym>SNMP</acronym> ライブラリ内の <parameter>quick_print</parameter> の値</simpara>
      <simpara>
       NET-<acronym>SNMP</acronym> ライブラリ内の <parameter>quick_print</parameter> の値を指定します。
       これを (1 に) 設定すると、<acronym>SNMP</acronym> ライブラリは「手早く表示」した値を返します。
       つまり、単なる値だけを表示するということです。<parameter>quick_print</parameter> を有効にしなければ
       (デフォルト)、NET-<acronym>SNMP</acronym> ライブラリは追加情報 (値の型、たとえば IpAddress や OID) も表示します。
       さらに、quick_print が有効でない場合は、三文字以下のすべての文字列に対して追加の十六進値を表示します。
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="snmp.props.enum-print">
     <term><varname>enum_print</varname></term>
     <listitem>
      <simpara>enum 値の表示方法</simpara>
      <simpara>
       walk や get などが、自動的に MIB 内の enum 値の元をたどって
       その値も可読形式の文字列にするかどうかを設定します。
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="snmp.props.oid-output-format">
     <term><varname>oid_output_format</varname></term>
     <listitem>
      <simpara>OID の出力フォーマットの制御</simpara>
      <table>
       <title><varname>oid_output_format</varname> の値による、OID .1.3.6.1.2.1.1.3.0 の表示方法の変化</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>
      <simpara>OID ツリーを走査中の OID 増加チェックの無効化</simpara>
      <simpara>
       <acronym>SNMP</acronym> エージェントの中には、
       OID を返す順番がおかしくても走査はできるというものがあります。
       それ以外のエージェントの場合、OID を返す順番がおかしくなると
       <methodname>SNMP::walk</methodname> が無限ループになり、
       メモリを食いつぶしてしまいます。PHP の SNMP ライブラリは、
       デフォルトで OID の増加チェックを行い、もし OID ツリーの走査中に
       OID が増加しないパターンがあればそこで走査を終了します。
       <varname>oid_increasing_check</varname> を &false; にすると、このチェックが無効になります。
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="snmp.props.exceptions-enabled">
     <term><varname>exceptions_enabled</varname></term>
     <listitem>
      <simpara>
       警告ではなく SNMPException を発生させるのがどの失敗なのかを設定します。
       <constant>SNMP::ERRNO_<replaceable>*</replaceable></constant>
       定数を bitwise OR で指定します。
       デフォルトでは、全ての SNMP 例外が無効になっています。
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="snmp.props.info">
     <term><varname>info</varname></term>
     <listitem>
      <simpara>読み込み専用のプロパティで、リモートエージェントの設定を表します。
      ホスト名やポート、デフォルトのタイムアウト、デフォルトの再試行回数を含みます。</simpara>
     </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>
       <simpara><acronym>SNMP</acronym> に関するエラーは発生していません。</simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="snmp.constants.errno-generic">
      <term><constant>SNMP::ERRNO_GENERIC</constant></term>
      <listitem>
       <simpara><acronym>SNMP</acronym> のエラーが発生しました。</simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="snmp.constants.errno-timeout">
      <term><constant>SNMP::ERRNO_TIMEOUT</constant></term>
      <listitem>
       <simpara><acronym>SNMP</acronym> エージェントへのリクエストがタイムアウトしました。</simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="snmp.constants.errno-error-in-reply">
      <term><constant>SNMP::ERRNO_ERROR_IN_REPLY</constant></term>
      <listitem>
       <simpara><acronym>SNMP</acronym> エージェントがエラーの応答を返しました。</simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="snmp.constants.errno-oid-not-increasing">
      <term><constant>SNMP::ERRNO_OID_NOT_INCREASING</constant></term>
      <listitem>
       <simpara>
        <acronym>SNMP</acronym> エージェントが、(BULK)WALK
        コマンドの実行中に前の OID から増加していない OID に当たりました。
        リモート <acronym>SNMP</acronym> エージェントが偽物である可能性があります。
       </simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="snmp.constants.errno-oid-parsing-error">
      <term><constant>SNMP::ERRNO_OID_PARSING_ERROR</constant></term>
      <listitem>
       <simpara>
        OID (や SET コマンドの型) のパースに失敗しました。
        クエリは作成されませんでした。
       </simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="snmp.constants.errno-multiple-set-queries">
      <term><constant>SNMP::ERRNO_MULTIPLE_SET_QUERIES</constant></term>
      <listitem>
       <simpara>
        要求された SET 操作で複数のクエリを使います。
        この操作はトランザクション内の操作ではないので、
        二番目以降のクエリに型や値の問題があれば失敗するかもしれません。
       </simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="snmp.constants.errno-any">
      <term><constant>SNMP::ERRNO_ANY</constant></term>
      <listitem>
       <simpara>
        すべての SNMP::ERRNO_* コードをビット OR したもの。
       </simpara>
      </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>
       <simpara/>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="snmp.constants.version-2c">
      <term><constant>SNMP::VERSION_2C</constant>, <constant>SNMP::VERSION_2c</constant></term>
      <listitem>
       <simpara/>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="snmp.constants.version-3">
      <term><constant>SNMP::VERSION_3</constant></term>
      <listitem>
       <simpara/>
      </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
-->