snmpset

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

snmpset — SNMP オブジェクトの値を設定する

説明

snmpset(
    string $hostname,
    string $community,
    array|string $object_id,
    array|string $type,
    array|string $value,
    int $timeout = -1,
    int $retries = -1
): bool

snmpset() 関数は、 object_idで指定した SNMP オブジェクトの値を設定するために使用します。

パラメータ

hostname

SNMP エージェント (サーバー) のホスト名。

community

ライトコミュニティ。

object_id

SNMP オブジェクト ID。

type

MIB は、オブジェクトIDごとのタイプを定義します。これは、以下の一覧から指定される一文字でなければなりません。

**types**
=	MIBから取得するタイプ
i	INTEGER
u	INTEGER
s	STRING
x	HEX STRING
d	DECIMAL STRING
n	NULLOBJ
o	OBJID
t	TIMETICKS
a	IPADDRESS
b	BITS

SNMP ライブラリをコンパイルする際、 OPAQUE_SPECIAL_TYPES が定義されていた場合、以下も正しい値になります:

**types**
U	unsigned int64
I	signed int64
F	float
D	double

これらの大半は、対応する ASN.1 の型を使います。's', 'x', 'd' および 'b' はどれも OCTET STRING を異なる方法で表したものであり、'u' も Gauge32 値を扱うためのものです。

MIB ファイルが "snmp_read_mib" や libsnmp の設定で MIB ツリーに読み込まれている場合は、 type に '=' を使うことができます。これはすべてのオブジェクト ID を表し、型は自動的に MIB から読み込みます。

"SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}" のような BITS 型の値変数を設定する方法は二通りあることに注意しましょう。

型として "b" を使い、ビット番号の一覧を指定する。この方法はおすすめしません。同じ OID に対して GET クエリを実行しても 0xF8 などを返すからです。
Using type "x" and a hex number but without(!) the usual "0x" prefix. 型として "x" を使い、通常のプレフィックス "0x" をつけずに(!) 16 進数を指定する。

詳細は、サンプルを参照ください。

value

新しい値。

timeout

最初のタイムアウトまでのマイクロ秒数。

retries

タイムアウト発生時の再試行回数。

戻り値

成功した場合に true を、失敗した場合に false を返します。

SNMP ホストがデータ型を却下すると、"Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." のような’ E_WARNING メッセージが表示されます。未知の OID あるいは無効な OID を指定した場合は、おそらく "Could not add variable" のような警告となります。

例

例1 snmpset() の使用法

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

例2 BITS SNMP オブジェクト ID を設定した snmpset() の使用法

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

参考

snmpget() - SNMP オブジェクトを取得する

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 3 notes

down

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');

down

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");

down

slawrance at technologist dot com ¶

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

＋add a note