<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.snmp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.snmp3-set.php',
    1 => 'snmp3_set',
    2 => 'Set the value of an SNMP object',
  ),
  'up' => 
  array (
    0 => 'ref.snmp.php',
    1 => 'SNMP 函数',
  ),
  'prev' => 
  array (
    0 => 'function.snmp3-real-walk.php',
    1 => 'snmp3_real_walk',
  ),
  'next' => 
  array (
    0 => 'function.snmp3-walk.php',
    1 => 'snmp3_walk',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/snmp/functions/snmp3-set.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.snmp3-set" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">snmp3_set</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">snmp3_set</span> &mdash; <span class="dc-title">Set the value of an SNMP object</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.snmp3-set-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>snmp3_set</strong></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">$security_name</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">$security_level</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">$auth_protocol</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">$auth_passphrase</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">$privacy_protocol</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">$privacy_passphrase</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$object_id</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$type</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$value</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>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   <span class="function"><strong>snmp3_set()</strong></span> is used to set the value of an <abbr title="Simple Network Management Protocol">SNMP</abbr> object
   specified by the <code class="parameter">object_id</code>.
  </p>
  <p class="simpara">
   Even if the security level does not use an auth or priv protocol/password valid values have to be specified.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.snmp3-set-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">hostname</code></dt>
    <dd>
     <span class="simpara">
      The hostname of the SNMP agent (server).
     </span>
    </dd>
   
   
    <dt><code class="parameter">security_name</code></dt>
    <dd>
     <span class="simpara">
      the security name, usually some kind of username
     </span>
    </dd>
   
   
    <dt><code class="parameter">security_level</code></dt>
    <dd>
     <span class="simpara">
      the security level (noAuthNoPriv|authNoPriv|authPriv)
     </span>
    </dd>
   
   
    <dt><code class="parameter">auth_protocol</code></dt>
    <dd>
     <span class="simpara">
      the authentication protocol (MD5 or SHA)
     </span>
    </dd>
   
   
    <dt><code class="parameter">auth_passphrase</code></dt>
    <dd>
     <span class="simpara">
      the authentication pass phrase
     </span>
    </dd>
   
   
    <dt><code class="parameter">privacy_protocol</code></dt>
    <dd>
     <span class="simpara">
      the privacy protocol (DES or AES)
     </span>
    </dd>
   
   
    <dt><code class="parameter">privacy_passphrase</code></dt>
    <dd>
     <span class="simpara">
      the privacy pass phrase
     </span>
    </dd>
   
   
    <dt><code class="parameter">object_id</code></dt>
    <dd>
     <span class="simpara">
      The <abbr title="Simple Network Management Protocol">SNMP</abbr> object id.
     </span>
    </dd>
   
   
    <dt><code class="parameter">type</code></dt>
    <dd>
     <p class="para">
<abbr>MIB</abbr> 定义了各个对象 id 的类型。必须是下面列出的单个字符之一。
</p>
<table class="doctable table">
 <caption><strong>类型</strong></caption>
 
  <tbody class="tbody">
   <tr><td>=</td><td>MIB类型</td></tr>

   <tr><td>i</td><td>INTEGER</td> </tr>

   <tr><td>u</td><td>INTEGER</td></tr>

   <tr><td>s</td><td>STRING</td></tr>

   <tr><td>x</td><td>HEX STRING</td></tr>

   <tr><td>d</td><td>DECIMAL STRING</td></tr>

   <tr><td>n</td><td>NULLOBJ</td></tr>

   <tr><td>o</td><td>OBJID</td></tr>

   <tr><td>t</td><td>TIMETICKS</td></tr>

   <tr><td>a</td><td>IPADDRESS</td></tr>

   <tr><td>b</td><td>BITS</td></tr>

  </tbody>
 
</table>

<p class="para">
 如果在编译 <abbr title="Simple Network Management Protocol">SNMP</abbr> 库时定义了 <strong><code>OPAQUE_SPECIAL_TYPES</code></strong>，那么下列值是合法的：
</p>
<table class="doctable table">
 <caption><strong>types</strong></caption>
 
  <tbody class="tbody">
   <tr><td>U</td><td>unsigned int64</td></tr>

   <tr><td>I</td><td>signed int64</td></tr>

   <tr><td>F</td><td>float</td></tr>

   <tr><td>D</td><td>double</td></tr>

  </tbody>
 
</table>


     <p class="para">
这些值大都会使用与 ASN.1 相符的类型。&#039;s&#039;，&#039;x&#039;，&#039;d&#039;
以及 &#039;b&#039; 都是指定一个八字节字符串值的方式。并且 &#039;u&#039; 无符号类型也可用于处理 Gauge32 值。
</p>

     <p class="para">
如果 MIB 文件是用 &quot;snmp_read_mib&quot; 或者通过在 libsnmp config 中指定而加载入 MIB 树时，
&#039;=&#039; 可以被用作为所有对象的 <code class="parameter">type</code> 参数，因为 type 可以被自动从 MIB 中读取。
</p>

     <p class="para">
注意有两种方式可以设定 BITS 类型的变量，例如
&quot;SYNTAX    BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}&quot;:
</p>
<ul class="itemizedlist">
 <li class="listitem">
  <span class="simpara">
   使用 &quot;b&quot; 类型以及一个位数的列表。不推荐使用此方法，因为 GET 查询对同一个 OID 将会返回例如 0xF8。
  </span>
 </li>
 <li class="listitem">
  <span class="simpara">
   使用 &quot;x&quot; 类型以及一个十六进制数但是不需要通常的 &quot;0x&quot; 前缀。
  </span>
 </li>
</ul>
<p class="para">
 更多细节见示例部分。
</p>

    </dd>
   
   
    <dt><code class="parameter">value</code></dt>
    <dd>
     <span class="simpara">
      The new value
     </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 times to retry if timeouts occur.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.snmp3-set-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="simpara">
   成功时返回 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>， 或者在失败时返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
  </p>
  <p class="simpara">
   If the SNMP host rejects the data type, an E_WARNING message like &quot;Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length.&quot; is shown.
   If an unknown or invalid OID is specified the warning probably reads &quot;Could not add variable&quot;.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.snmp3-set-examples">
  <h3 class="title">示例</h3>
   <div class="example" id="example-1">
    <p><strong>示例 #1 Using <span class="function"><strong>snmp3_set()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />  snmp3_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'james'</span><span style="color: #007700">, </span><span style="color: #DD0000">'authPriv'</span><span style="color: #007700">, </span><span style="color: #DD0000">'SHA'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'AES'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'IF-MIB::ifAlias.3'</span><span style="color: #007700">, </span><span style="color: #DD0000">'s'</span><span style="color: #007700">, </span><span style="color: #DD0000">"foo"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
   <div class="example" id="example-2">
    <p><strong>示例 #2 Using <span class="function"><strong>snmp3_set()</strong></span> for setting BITS <abbr title="Simple Network Management Protocol">SNMP</abbr> object id</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />  snmp3_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'james'</span><span style="color: #007700">, </span><span style="color: #DD0000">'authPriv'</span><span style="color: #007700">, </span><span style="color: #DD0000">'SHA'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'AES'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'FOO-MIB::bar.42'</span><span style="color: #007700">, </span><span style="color: #DD0000">'b'</span><span style="color: #007700">, </span><span style="color: #DD0000">'0 1 2 3 4'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// or<br />  </span><span style="color: #0000BB">snmp3_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'james'</span><span style="color: #007700">, </span><span style="color: #DD0000">'authPriv'</span><span style="color: #007700">, </span><span style="color: #DD0000">'SHA'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'AES'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret007'</span><span style="color: #007700">, </span><span style="color: #DD0000">'FOO-MIB::bar.42'</span><span style="color: #007700">, </span><span style="color: #DD0000">'x'</span><span style="color: #007700">, </span><span style="color: #DD0000">'F0'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
 </div>



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