SNMP::set

(PHP 5 >= 5.4.0, PHP 7)

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

説明

public SNMP::set ( mixed $object_id , mixed $type , mixed $value ) : bool

リモート SNMP エージェントに対して、 object_id で指定した SNMP オブジェクトの値を設定させます。

パラメータ

object_id が文字列のときは、 type と value も文字列にしなければなりません。 object_id が配列のときは、 value も同じサイズの配列にして、対応する値を含めなければなりません。 type は、文字列でもいいし (この値を、すべての object_id-value ペアに適用する)、同じサイズの配列 (OID ごとに設定する) でもかまいません。その他の組み合わせで指定すると、E_WARNING メッセージが表示されます。

object_id

SNMP オブジェクト ID。

object_id 配列の OID 数がオブジェクトの max_oids プロパティより多ければ、set メソッドは複数のクエリで値の更新をしなければなりません。この場合、型や値のチェックはチャンク単位で行われるので、二番目以降のクエリでリクエストする ODI に対して型や値の問題があれば失敗するかもしれません。そのため、object_id 配列の OID 数が max_oids プロパティより多いときには警告が発生します。

type

The MIB defines the type of each object id. It has to be specified as a single character from the below list.

**types**
=	The type is taken from the MIB
i	INTEGER
u	INTEGER
s	STRING
x	HEX STRING
d	DECIMAL STRING
n	NULLOBJ
o	OBJID
t	TIMETICKS
a	IPADDRESS
b	BITS

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

**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

新しい値。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

エラー / 例外

このメソッドは、デフォルトでは一切例外をスローしません。ライブラリでエラーが発生したときに SNMPException をスローさせるには SNMP クラスパラメータ exceptions_enabled に値を設定しなければなりません。詳細は SNMP::$exceptions_enabled の説明を参照ください。

例

例1 単一の SNMP オブジェクト ID の設定


<?php
  $session = new SNMP(SNMP::VERSION_2C, "127.0.0.1", "private");
  $session->set('SNMPv2-MIB::sysContact.0', 's', "Nobody");
?>

例2 単一の SNMP::set() コールによる複数の値の設定


<?php
  $session = new SNMP(SNMP::VERSION_2C, "127.0.0.1", "private");
  $session->set(array('SNMPv2-MIB::sysContact.0', 'SNMPv2-MIB::sysLocation.0'), array('s', 's'), array("Nobody", "Nowhere"));
// あるいは
  $session->set(array('SNMPv2-MIB::sysContact.0', 'SNMPv2-MIB::sysLocation.0'), 's', array("Nobody", "Nowhere"));
?>

例3 BITS SNMP オブジェクト ID の設定による SNMP::set() の使用法


<?php
  $session = new SNMP(SNMP::VERSION_2C, "127.0.0.1", "private");
  $session->set('FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// あるいは
  $session->set('FOO-MIB::bar.42', 'x', 'F0');
?>

参考

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