snmpget.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: dd22c782164c9f8d79f5de8991876d1588a21015 Maintainer: hirokawa Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.snmpget">
 <refnamediv>
  <refname>snmpget</refname>
  <refpurpose><acronym>SNMP</acronym> オブジェクトを取得する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>snmpget</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>

  <simpara>
   <function>snmpget</function> は <parameter>object_id</parameter>
   で指定した <acronym>SNMP</acronym> オブジェクトの値を読みとるために使用されます。
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>hostname</parameter></term>
    <listitem>
     <simpara>
      <acronym>SNMP</acronym> エージェント。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>community</parameter></term>
    <listitem>
     <simpara>
      リードコミュニティ。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>object_id</parameter></term>
    <listitem>
     <simpara>
      <acronym>SNMP</acronym> オブジェクト。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timeout</parameter></term>
    <listitem>
     <simpara>
      最初のタイムアウトまでのマイクロ秒数。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>retries</parameter></term>
    <listitem>
     <simpara>
      タイムアウトが発生したときの再試行の回数。
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   成功した場合に <acronym>SNMP</acronym> オブジェクトの値、失敗した場合に &false; を返します。
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.5.0</entry>
      <entry>
       hostname の長さが 128 バイト以上の場合、port が負の数または 65535 より大きい場合、
       または timeout や retries の値が -1 より小さいか大きすぎる場合に、
       <exceptionname>ValueError</exceptionname> をスローするようになりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>snmpget</function> の使用例</title>
   <programlisting role="php">
<![CDATA[
<?php
$syscontact = snmpget("127.0.0.1", "public", "system.SysContact.0");
?>
]]>
   </programlisting>
  </example>
 </refsect1>

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