<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.snmp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'snmp.construct.php',
    1 => 'SNMP::__construct',
    2 => 'Creates SNMP instance representing session to remote SNMP agent',
  ),
  'up' => 
  array (
    0 => 'class.snmp.php',
    1 => 'SNMP',
  ),
  'prev' => 
  array (
    0 => 'snmp.close.php',
    1 => 'SNMP::close',
  ),
  'next' => 
  array (
    0 => 'snmp.get.php',
    1 => 'SNMP::get',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/snmp/snmp/construct.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="snmp.construct" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SNMP::__construct</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.4.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">SNMP::__construct</span> &mdash; <span class="dc-title">Creates SNMP instance representing session to remote <abbr title="Simple Network Management Protocol">SNMP</abbr> agent</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-snmp.construct-description">
  <h3 class="title">Description</h3>

  <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>SNMP::__construct</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$version</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$hostname</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$community</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$timeout</code><span class="initializer"> = -1</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$retries</code><span class="initializer"> = -1</span></span><br>)</div>

  <p class="simpara">
   Creates SNMP instance representing session to remote <abbr title="Simple Network Management Protocol">SNMP</abbr> agent.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-snmp.construct-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">version</code></dt>
    <dd>
     <span class="simpara">
      <abbr title="Simple Network Management Protocol">SNMP</abbr> protocol version:
      <strong><code><a href="class.snmp.php#snmp.constants.version-1">SNMP::VERSION_1</a></code></strong>,
      <strong><code><a href="class.snmp.php#snmp.constants.version-2c">SNMP::VERSION_2C</a></code></strong>,
      <strong><code><a href="class.snmp.php#snmp.constants.version-3">SNMP::VERSION_3</a></code></strong>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">hostname</code></dt>
    <dd>
     <p class="para">
      The <abbr title="Simple Network Management Protocol">SNMP</abbr> agent. <code class="parameter">hostname</code> may be suffixed with
      optional <abbr title="Simple Network Management Protocol">SNMP</abbr> agent port after colon. IPv6 addresses must be enclosed in square
      brackets if used with port. If FQDN is used for <code class="parameter">hostname</code>
      it will be resolved by PHP SNMP extension, not by
      <span class="productname">Net-SNMP</span> engine. Usage
      of IPv6 addresses when specifying FQDN may be forced by enclosing FQDN
      into square brackets. Here are some examples:
     <table class="doctable informaltable">
      
       <tbody class="tbody">
        <tr><td>IPv4 with default port</td><td>127.0.0.1</td></tr>

        <tr><td>IPv6 with default port</td><td>::1 or [::1]</td></tr>

        <tr><td>IPv4 with specific port</td><td>127.0.0.1:1161</td></tr>

        <tr><td>IPv6 with specific port</td><td>[::1]:1161</td></tr>

        <tr><td>FQDN with default port</td><td>host.domain</td></tr>

        <tr><td>FQDN with specific port</td><td>host.domain:1161</td></tr>

        <tr><td>FQDN with default port, force usage of IPv6 address</td><td>[host.domain]</td></tr>

        <tr><td>FQDN with specific port, force usage of IPv6 address</td><td>[host.domain]:1161</td></tr>

       </tbody>
      
     </table>

     </p>
    </dd>
   
   
    <dt><code class="parameter">community</code></dt>
    <dd>
     <span class="simpara">
      Specifies the security level for given <code class="parameter">version</code>.
      The purpose of <code class="parameter">community</code> access string is
      <abbr title="Simple Network Management Protocol">SNMP</abbr> version specific:
     </span>
     <table class="doctable informaltable">
      
       <tbody class="tbody">
        <tr>
         <td>
          <strong><code><a href="class.snmp.php#snmp.constants.version-1">SNMP::VERSION_1</a></code></strong>
         </td>
         <td>
          <code class="literal">public</code> for read-only permission or
          <code class="literal">private</code> for read-write
         </td>
        </tr>

        <tr>
         <td>
          <strong><code><a href="class.snmp.php#snmp.constants.version-2c">SNMP::VERSION_2C</a></code></strong>
         </td>
         <td>
          <code class="literal">public</code> for read-only permission or
          <code class="literal">private</code> for read-write
         </td>
        </tr>

        <tr>
         <td>
          <strong><code><a href="class.snmp.php#snmp.constants.version-3">SNMP::VERSION_3</a></code></strong>
         </td>
         <td>
          <abbr title="Simple Network Management Protocol">SNMP</abbr>v3 security name, may be one of:
          <code class="literal">noAuthNoPriv</code>,
          <code class="literal">authNoPriv</code> (an auth passphrase and auth protocol are required), or
          <code class="literal">authPriv</code> (both an auth passphrase and a protocol, as well as
          a privacy passphrase and protocol are required)
         </td>
        </tr>

       </tbody>
      
     </table>

     <span class="simpara">
      SNMPv3 requires to configure security-related session parameters with
      the <span class="methodname"><a href="snmp.setsecurity.php" class="methodname">SNMP::setSecurity()</a></span> method.
     </span>
    </dd>
   
    
     <dt><code class="parameter">timeout</code></dt>
     <dd>
      <span class="simpara">
       The number of microseconds until the first timeout.
      </span>
     </dd>
    
    
     <dt><code class="parameter">retries</code></dt>
     <dd>
      <span class="simpara">
       The number of retries in case timeout occurs.
      </span>
     </dd>
    
  </dl>
 </div>


 <div class="refsect1 errors" id="refsect1-snmp.construct-errors">
  <h3 class="title">Errors/Exceptions</h3>
  <p class="simpara">
   <span class="methodname"><strong>SNMP::__construct()</strong></span> throws an exception when
   parameters count or types are wrong or unknown <abbr title="Simple Network Management Protocol">SNMP</abbr>
   protocol version specified.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-snmp.construct-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="snmp.construct.example.basic">
   <p><strong>Example #1 Fetching the physical location of the host</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$session </span><span style="color: #007700">= new </span><span style="color: #0000BB">SNMP</span><span style="color: #007700">(</span><span style="color: #0000BB">SNMP</span><span style="color: #007700">::</span><span style="color: #0000BB">VERSION_1</span><span style="color: #007700">, </span><span style="color: #DD0000">"127.0.0.1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"public"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$sysdescr </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">get</span><span style="color: #007700">(</span><span style="color: #DD0000">"sysDescr.0"</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$sysdescr</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>The above example will output
something similar to:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">STRING: Test server</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-snmp.construct-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="snmp.close.php" class="methodname" rel="rdfs-seeAlso">SNMP::close()</a> - Close SNMP session</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>