snmpset

(PHP 4, PHP 5)

snmpsetSet the value of an SNMP object

說明

bool snmpset ( string $host , string $community , string $object_id , string $type , mixed $value [, int $timeout = 1000000 [, int $retries = 5 ]] )

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

參數

host

The hostname of the SNMP agent (server).

community

The write community.

object_id

The SNMP object id.

type

MIB 定義了各個對象 id 的類型。必須是下面列出的單個字元之一。

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

如果在編譯 SNMP 函式庫時定義了 OPAQUE_SPECIAL_TYPES,則下列值是合法的:

types
Uunsigned int64
Isigned int64
Ffloat
Ddouble

這些值大都會使用與 ASN.1 相符的類型。's','x','d' 以及 'b' 都是指定一個八進位字串值的方式。並且 'u' 無號類型也可用於處理 Gauge32 值。

如果 MIB 檔案是用 "snmp_read_mib" 或者通過在 libsnmp config 中指定而載入 MIB 數時, '=' 可以被用作為所有物件的 type 參數,因為 type 可以被自動從 MIB 中讀取。

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

  • 使用 "b" 類型以及一個位數的列表。不建議使用此方法,因為 GET 查詢時間一個 OID 將會回傳例如 0xF8。
  • 使用 "x" 類型以及一個十六進位數但是不需要通常的 "0x" 前綴字。

更多細節見範例部分。

value

The new value.

timeout

The number of microseconds until the first timeout.

retries

The number of times to retry if timeouts occur.

回傳值

如果成功則回傳 TRUE,失敗則回傳 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".

範例

Example #1 Using snmpset()

<?php
  snmpset
("localhost""public""IF-MIB::ifAlias.3""s""foo");
?>

Example #2 Using snmpset() for setting BITS SNMP object id

<?php
  snmpset
("localhost""public"'FOO-MIB::bar.42''b''0 1 2 3 4');
// or
  
snmpset("localhost""public"'FOO-MIB::bar.42''x''F0');
?>

參見

add a note add a note

User Contributed Notes 4 notes

up
0
ch at lathspell dot de
14 years ago
Note that there are two ways to set a variable of the type BITS like e.g.:
  SYNTAX        BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}

1. Using type "b" and a list of bit numbers like:
  snmpset('FOO-MIB::bar.42', 'b', '0 1 2 3 4');
with the disadvantage that the success is not easily verifyable as an snmpget() for the same OID would return e.g. 0xF8.

2. Using type "x" and a hex number but without(!) the usual "0x" prefix:
  snmpset('FOO-MIB::bar.42', 'x', 'F0');
up
0
deivis dot jakstas at gmail dot com
17 years ago
If you setting hex values correct format is:
snmpset($source_ip,$community,"$oid","x","10 10 10 10");
up
0
slawrance at technologist dot com
24 years ago
The "type" parameter must be one of the following, depending on the type of variable to set on the SNMP host:

i    INTEGER
u    unsigned INTEGER
t    TIMETICKS
a    IPADDRESS
o    OBJID
s    STRING
x    HEX STRING
d    DECIMAL STRING
n    NULLOBJ
b    BITS

If OPAQUE_SPECIAL_TYPES was defined while compiling the SNMP library, the
following are also valid:

U    unsigned int64
I    signed int64
F    float
D    double

As an example, using "i" would set an integer, and "s" would set a string.  If the SNMP host rejects the data type, you might get the following message: "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length."

If you specify an unknown or invalid OID, you might get a "Could not add variable" message.  When specifying an absolute OID (one that is already resolved) that is completely numeric, prepend it with a period.  For example, an OID that could enable/disable Ethernet ports on an Asante hub might be "1.3.6.1.2.1.22.1.3.1.1.3.6.4.0", but you would need to use ".1.3.6.1.2.1.22.1.3.1.1.3.6.4.0" in the OID parameter so that the SNMP library won't try to resolve an already resolved OID.  Friendly, unresolved OIDs do not need the period prepended, such as "system.SysContact.0"
up
-6
tridman
17 years ago
If you have importet the MIB-Files into the MIB Tree with "snmp_read_mib" you may use '=' as the "type" parameter.
In this case the type will also be taken from the loaded mib file. (Octest strings will be interpreted like strings though)
Comes in handy for a more dynamic use of snmpset.
To Top