PHP 8.4.2 Released!

    snmp3_set

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

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

    説明

    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() は、 object_id で指定した SNMP オブジェクトの値を設定します。

    セキュリティレベルに auth や priv を使っていなくても、 protocol/password には有効な値を指定しなくてはなりません。

    パラメータ

    hostname

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

    security_name

    セキュリティ名。通常はユーザー名のようなもの。

    security_level

    セキュリティレベル (noAuthNoPriv|authNoPriv|authPriv)。

    auth_protocol

    認証プロトコル (MD5 あるいは SHA)。

    auth_passphrase

    認証パスフレーズ。

    privacy_protocol

    プライバシープロトコル (DES あるいは AES)。

    privacy_passphrase

    プライバシーパスフレーズ。

    object_id

    SNMP オブジェクト ID。

    type

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

    types
    =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' はどれも 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 snmp3_set() の使用法

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

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

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

    Found A Problem?

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

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top