(PHP 5 >= 5.4.0, PHP 7, PHP 8)
SNMP::set — SNMP オブジェクトの値を設定する
$objectId, array|string $type, array|string $value): bool
リモート SNMP エージェントに対して、
objectId で指定した SNMP オブジェクトの値を設定させます。
objectId が文字列のときは、
type と value
も文字列にしなければなりません。
objectId が配列のときは、
value も同じサイズの配列にして、対応する値を含めなければなりません。
type は、文字列でもいいし
(この値を、すべての objectId-value ペアに適用する)、
同じサイズの配列 (OID ごとに設定する) でもかまいません。
その他の組み合わせで指定すると、E_WARNING
メッセージが表示されます。
objectIdSNMP オブジェクト ID。
object_id 配列の OID 数がオブジェクトの max_oids プロパティより多ければ、set メソッドは複数のクエリで値の更新をしなければなりません。 この場合、型や値のチェックはチャンク単位で行われるので、 二番目以降のクエリでリクエストする ODI に対して型や値の問題があれば失敗するかもしれません。 そのため、object_id 配列の OID 数が max_oids プロパティより多いときには警告が発生します。
typeMIB は、オブジェクトIDごとのタイプを定義します。 これは、以下の一覧から指定される一文字でなければなりません。
| = | 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 が定義されていた場合、
以下も正しい値になります:
| 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 型の値変数を設定する方法は二通りあることに注意しましょう。
詳細は、サンプルを参照ください。
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');
?>