snmp3_set

(PHP 4, PHP 5, PHP 7, PHP 8)

snmp3_set — Set the value of an SNMP object

說明

snmp3_set(
    string $hostname,
    string $security_name,
    string $security_level,
    string $auth_protocol,
    string $auth_passphrase,
    string $privacy_protocol,
    string $privacy_passphrase,
    array|string $object_id,
    array|string $type,
    array|string $value,
    int $timeout = -1,
    int $retries = -1
): bool

snmp3_set() is used to set the value of an SNMP object specified by the object_id.

Even if the security level does not use an auth or priv protocol/password valid values have to be specified.

參數(shù)

hostname

The hostname of the SNMP agent (server).

security_name

the security name, usually some kind of username

security_level

the security level (noAuthNoPriv|authNoPriv|authPriv)

auth_protocol

the authentication protocol (MD5 or SHA)

auth_passphrase

the authentication pass phrase

privacy_protocol

the privacy protocol (DES or AES)

privacy_passphrase

the privacy pass phrase

object_id

The SNMP object id.

type

MIB 定義了各個(gè)對(duì)象 id 的類型。必須是下面列出的單個(gè)字符之一。

類型
=MIB類型
iINTEGER
uINTEGER
sSTRING
xHEX STRING
dDECIMAL STRING
nNULLOBJ
oOBJID
tTIMETICKS
aIPADDRESS
bBITS

如果在編譯 SNMP 庫時(shí)定義了 OPAQUE_SPECIAL_TYPES，那么下列值是合法的：

types
Uunsigned int64
Isigned int64
Ffloat
Ddouble

這些值大都會(huì)使用與 ASN.1 相符的類型。's'，'x'，'d' 以及 'b' 都是指定一個(gè)八字節(jié)字符串值的方式。并且 'u' 無符號(hào)類型也可用于處理 Gauge32 值。

如果 MIB 文件是用 "snmp_read_mib" 或者通過在 libsnmp config 中指定而加載入 MIB 樹時(shí)， '=' 可以被用作為所有對(duì)象的 type 參數(shù)，因?yàn)?type 可以被自動(dòng)從 MIB 中讀取。

注意有兩種方式可以設(shè)定 BITS 類型的變量，例如 "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":

  • 使用 "b" 類型以及一個(gè)位數(shù)的列表。不推薦使用此方法，因?yàn)?GET 查詢對(duì)同一個(gè) OID 將會(huì)返回例如 0xF8。
  • 使用 "x" 類型以及一個(gè)十六進(jìn)制數(shù)但是不需要通常的 "0x" 前綴。

更多細(xì)節(jié)見范例部分。

value

The new value

timeout

The number of microseconds until the first timeout.

retries

The number of times to retry if timeouts occur.

返回值

成功時(shí)返回 true， 或者在失敗時(shí)返回 false。

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".

范例

示例 #1 Using snmp3_set()

<?php
  snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifAlias.3', 's', "foo");
?>

示例 #2 Using snmp3_set() for setting BITS SNMP object id

<?php
  snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// or
  snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'FOO-MIB::bar.42', 'x', 'F0');
?>