construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="snmp.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SNMP::__construct</refname>
  <refpurpose>Creates SNMP instance representing session to remote <acronym>SNMP</acronym> agent</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;

  <constructorsynopsis role="SNMP">
   <modifier>public</modifier> <methodname>SNMP::__construct</methodname>
   <methodparam><type>int</type><parameter>version</parameter></methodparam>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
   <methodparam><type>string</type><parameter>community</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>
  </constructorsynopsis>
  <para>
   Creates SNMP instance representing session to remote <acronym>SNMP</acronym> agent.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>version</parameter></term>
    <listitem>
     <para>
      <acronym>SNMP</acronym> protocol version:
      <constant>SNMP::VERSION_1</constant>, 
      <constant>SNMP::VERSION_2C</constant>, 
      <constant>SNMP::VERSION_3</constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>hostname</parameter></term>
    <listitem>
     <para>
      The <acronym>SNMP</acronym> agent. <parameter>hostname</parameter> may be suffixed with
      optional <acronym>SNMP</acronym> agent port after colon. IPv6 addresses must be enclosed in square
      brackets if used with port. If FQDN is used for <parameter>hostname</parameter>
      it will be resolved by PHP SNMP extension, not by
      <productname>Net-SNMP</productname> engine. Usage
      of IPv6 addresses when specifying FQDN may be forced by enclosing FQDN
      into square brackets. Here are some examples:
     <informaltable>
      <tgroup cols="2">
       <tbody>
        <row><entry>IPv4 with default port</entry><entry>127.0.0.1</entry></row>
        <row><entry>IPv6 with default port</entry><entry>::1 or [::1]</entry></row>
        <row><entry>IPv4 with specific port</entry><entry>127.0.0.1:1161</entry></row>
        <row><entry>IPv6 with specific port</entry><entry>[::1]:1161</entry></row>
        <row><entry>FQDN with default port</entry><entry>host.domain</entry></row>
        <row><entry>FQDN with specific port</entry><entry>host.domain:1161</entry></row>
        <row><entry>FQDN with default port, force usage of IPv6 address</entry><entry>[host.domain]</entry></row>
        <row><entry>FQDN with specific port, force usage of IPv6 address</entry><entry>[host.domain]:1161</entry></row>
       </tbody>
      </tgroup>
     </informaltable>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>community</parameter></term>
    <listitem>
     <para>
      Specifies the security level for given <parameter>version</parameter>.
      The purpose of <parameter>community</parameter> access string is
      <acronym>SNMP</acronym> version specific:
     </para>
     <informaltable>
      <tgroup cols="2">
       <tbody>
        <row>
         <entry>
          <constant>SNMP::VERSION_1</constant>
         </entry>
         <entry>
          <literal>public</literal> for read-only permission or
          <literal>private</literal> for read-write
         </entry>
        </row>
        <row>
         <entry>
          <constant>SNMP::VERSION_2C</constant>
         </entry>
         <entry>
          <literal>public</literal> for read-only permission or
          <literal>private</literal> for read-write
         </entry>
        </row>
        <row>
         <entry>
          <constant>SNMP::VERSION_3</constant>
         </entry>
         <entry>
          <acronym>SNMP</acronym>v3 security name, may be one of:
          <literal>noAuthNoPriv</literal>,
          <literal>authNoPriv</literal> (an auth passphrase and auth protocol are required), or
          <literal>authPriv</literal> (both an auth passphrase and a protocol, as well as
          a privacy passphrase and protocol are required)
         </entry>
        </row>
       </tbody>
      </tgroup>
     </informaltable>
     <simpara>
      SNMPv3 requires to configure security-related session parameters with
      the <methodname>SNMP::setSecurity</methodname> method.
     </simpara>
    </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 retries in case timeout occurs.
      </para>
     </listitem>
    </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <methodname>SNMP::__construct</methodname> throws an exception when
   parameters count or types are wrong or unknown <acronym>SNMP</acronym>
   protocol version specified.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="snmp.construct.example.basic">
   <title>Fetching the physical location of the host</title>
   <programlisting role="php">
<![CDATA[
<?php

$session = new SNMP(SNMP::VERSION_1, "127.0.0.1", "public");
$sysdescr = $session->get("sysDescr.0");
echo "$sysdescr\n";

?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
STRING: Test server
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>SNMP::close</methodname></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
-->