mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-18 05:26:57 +08:00
315 lines
12 KiB
HTML
315 lines
12 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
||
<title>Set the value of an SNMP object</title>
|
||
</head>
|
||
<body class="docs"><div id="layout">
|
||
<div id="layout-content"><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)</p><p class="refpurpose"><span class="refname">snmp3_set</span> — <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>
|
||
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$sec_name</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$sec_level</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$auth_protocol</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$auth_passphrase</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$priv_protocol</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$priv_passphrase</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$object_id</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$type</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
|
||
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code><span class="initializer"> = 1000000</span></span>
|
||
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$retries</code><span class="initializer"> = 5</span></span>
|
||
]] ) : <span class="type">bool</span></div>
|
||
|
||
<p class="para rdfs-comment">
|
||
<span class="function"><strong>snmp3_set()</strong></span> is used to set the value of an <acronym title="Simple Network Management Protocol">SNMP</acronym> object
|
||
specified by the <code class="parameter">object_id</code>.
|
||
</p>
|
||
<p class="para">
|
||
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">host</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The hostname of the SNMP agent (server).
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">sec_name</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
the security name, usually some kind of username
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">sec_level</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
the security level (noAuthNoPriv|authNoPriv|authPriv)
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">auth_protocol</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
the authentication protocol (MD5 or SHA)
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">auth_passphrase</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
the authentication pass phrase
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">priv_protocol</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
the privacy protocol (DES or AES)
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">priv_passphrase</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
the privacy pass phrase
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">object_id</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The <acronym title="Simple Network Management Protocol">SNMP</acronym> object id.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">type</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
<acronym>MIB</acronym> 定义了各个对象 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">
|
||
如果在编译 <acronym title="Simple Network Management Protocol">SNMP</acronym> 库时定义了 <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 相符的类型。's'，'x'，'d'
|
||
以及 'b' 都是指定一个八字节字符串值的方式。并且 'u' 无符号类型也可用于处理 Gauge32 值。
|
||
</p>
|
||
|
||
<p class="para">
|
||
如果 MIB 文件是用 "snmp_read_mib" 或者通过在 libsnmp config 中指定而加载入 MIB 树时，
|
||
'=' 可以被用作为所有对象的 <code class="parameter">type</code> 参数，因为 type 可以被自动从 MIB 中读取。
|
||
</p>
|
||
|
||
<p class="para">
|
||
注意有两种方式可以设定 BITS 类型的变量，例如
|
||
"SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
|
||
</p>
|
||
<ul class="itemizedlist">
|
||
<li class="listitem">
|
||
<span class="simpara">
|
||
使用 "b" 类型以及一个位数的列表。不推荐使用此方法，因为 GET 查询对同一个 OID 将会返回例如 0xF8。
|
||
</span>
|
||
</li>
|
||
<li class="listitem">
|
||
<span class="simpara">
|
||
使用 "x" 类型以及一个十六进制数但是不需要通常的 "0x" 前缀。
|
||
</span>
|
||
</li>
|
||
</ul>
|
||
<p class="para">
|
||
更多细节见范例部分。
|
||
</p>
|
||
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">value</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The new value
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">timeout</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The number of microseconds until the first timeout.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">retries</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The number of times to retry if timeouts occur.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 returnvalues" id="refsect1-function.snmp3-set-returnvalues">
|
||
<h3 class="title">返回值</h3>
|
||
<p class="para">
|
||
成功时返回 <strong><code>TRUE</code></strong>， 或者在失败时返回 <strong><code>FALSE</code></strong>。
|
||
</p>
|
||
<p class="para">
|
||
If the SNMP host rejects the data type, an E_WARNING message like "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." is shown.
|
||
If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 examples" id="refsect1-function.snmp3-set-examples">
|
||
<h3 class="title">范例</h3>
|
||
<div class="example" id="example-5573">
|
||
<p><strong>Example #1 Using <span class="function"><strong>snmp3_set()</strong></span></strong></p>
|
||
<div class="example-contents">
|
||
<div class="phpcode"><pre><span style="color: #000000">
|
||
<span style="color: #0000BB"><?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">?></span>
|
||
</span>
|
||
</pre></div>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="example" id="example-5574">
|
||
<p><strong>Example #2 Using <span class="function"><strong>snmp3_set()</strong></span> for setting BITS <acronym title="Simple Network Management Protocol">SNMP</acronym> object id</strong></p>
|
||
<div class="example-contents">
|
||
<div class="phpcode"><pre><span style="color: #000000">
|
||
<span style="color: #0000BB"><?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">?></span>
|
||
</span>
|
||
</pre></div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
</div></div></div></body></html> |