BSNMPGET(1) | FreeBSD General Commands Manual | BSNMPGET(1) |
名称
bsnmpget, bsnmpwalk, bsnmpset — SNMP エージェントに問い合わせするための簡単なツール書式
bsnmpget | [ -aDdehnK][ -A options][ -b buffersize][ -C options][ -I options][ -i filelist][ -l filename][ -M max-repetitions][ -N non-repeaters][ -o output][ -P options][ -p pdu][ -r retries][ -s [trans::][community@][server][:port]][ -t timeout][ -U options][ -v version][ OID ...] |
bsnmpwalk | [ -dhnK][ -A options][ -b buffersize][ -C options][ -I options][ -i filelist][ -l filename][ -o output][ -P options][ -r retries][ -s [trans::][community@][server][:port]][ -t timeout][ -U options][ -v version][ OID ...] |
bsnmpset | [ -adehnK][ -A options][ -b buffersize][ -C options][ -I options][ -i filelist][ -l filename][ -o output][ -P options][ -r retries][ -s [trans::][community@][server][:port]][ -t timeout][ -U options][ -v version] OID= syntax: value [ OID= syntax: value ...] |
解説
bsnmpget, bsnmpwalk と bsnmpset は、Simple Network Management Protocol (SNMP) エージェントから管理情報を検索して、そのエージェントに管理情報を設定するための簡単なツールです。オプション bsnmpget 建築物によって、SMNP GetRequest、GetNextRequest または GetBulkRequest パケットのいずれかは、成功して受信するなら、値が検索されるオブジェクトのオブジェクト識別子 (OID) に書き込んで、応答を待ち、それを印刷します。
bsnmpwalk は、SMNP GetNextRequest または GetBulkRequest パケットのいずれかでエージェントに問い合わせし、提供された OID をルートとするオブジェクトのサブツリーの一部である OID インスタンスの値を要求します。
SMNP SetRequest パケットを組み立てる bsnmpset は、OID (オブジェクト識別子) に書き込み、値が設定されるオブジェクトの構文と値、サーバからの応答を待ちます。
オプション
オプションは、次の通りです (すべての 3 つのプログラムにすべて適用しません):- -A options
-
SNMPv3 PDU で使用する認証オプション。
- proto=[md5|sha]
- PDU メッセージダイジェストを計算するとき、使用するプロトコル。
- key=authkey
- PDU メッセージダイジェストを計算するとき、使用するバイナリのローカル化された認証キー。
デフォルトで、SNMPv3 PDU は、認証されずに送信されます。
- -a
- OID を Protocol Data Unit (PDU) に追加するとき、あらゆる整合性のチェックをスキップします: 構文/アクセスタイプを無視し、GetPdu と読み込み専用オブジェクトのためのリーフでないオブジェクトを SetPDU に追加することを許可します。
- -b buffersize
- 送信と受信パケットに使用されるバッファのサイズを調整します。デフォルトサイズは、エージェントが本当に大きいオクテッド文字列を送信しないなら、十分であるはずの 10000 バイトです。最大の許可された長さは、Structure of Management Information (SMIv2) に従って 65535 です。
- -C options
-
SNMPv3 PDU で問い合わせるためのコンテキスト。
- context=name
- コンテキスト名。デフォルトは、"" (空) です。
- context-engine=engine-id
- バイナリのオクテッド文字列として表された、SNMPv3 PDU で問い合わせするためのコンテキストの SNMP Engine ID。デフォルトで、これは、SNMP エージェントの Engine ID に設定されます。
- -D
- 特定のオブジェクトの値のための要求を送信するのではなく、 SNMP USM Engine Discovery を実行します。
- -d
- デバッグをオンにします。このオプションによって、送信され、受信されたパケットは、端末にダンプされます。
- -e
- エラーのときに、再試行します。エラーが応答 PDU で返されるなら、有効な応答が受信されるまで、エラーを引き起こした変数を取り除く要求を再送します。これは、GetRequest- と GetNextRequest-PDU のためだけに役に立ちます。
- -h
- 様々なオプションのためのデフォルト値の短い説明文を印刷します。
- -I options
-
シンボリックなオブジェクト名をそれらの数値表現とその逆も同様に変換するために、与えられたリストからの各 MIB の記述ファイルをロードします。デフォルトでない振る舞いを獲得するために別のオプションを使用します:
- cut=OID
- MIB 記述ファイルを作り出すとき、 gensnmpdef(1) によって cut された初期の OID を指定します。デフォルト値は、/usr/share/snmp/defs の下でインストールされたすべてのファイルのために使用されるべきである .iso(1).org(3).dod(6) です。 -c オプションを gensnmpdef(1) に与えて、利用者自身のファイルを生成した場合にだけ、これを使用します。
- path=filedir
- リストのファイルが検索されるディレクトリ。デフォルトは、 /usr/share/snmp/defs/ です。
- file=filelist
- 上記の 2 つのオプションが適用されるファイルのコンマで区切られたリスト。
ファイルのサブオプションは、それらのデフォルトでない値がファイルのリストに適用されるように、他のサブオプションの後に来なければなりません。各ファイルのサブオプションの前の他のサブオプションの順序は、ランダムの場合があります。サブオプションは、コンマか空白によって区切られます。空白を使用するなら、例えば、引用文を使用して、全体のオプションの文字列が 1 つの引数となるようにしてください、
- -i filelist
- MIB 記述ファイルのリストは、 bsnmpget, bsnmpwalk または bsnmpset が数値の OID をそれらのシンボリックなオブジェクト名に変換するために検索する、 gensnmpdef(1) によって作成されます。何度もこのオプションを与えるか、またはファイル名のコンマで区切られたリストのいずれかを複数のファイルに提供することができます。ファイル名が文字で始まるなら、デフォルトのディレクトリ /usr/share/snmp/defs が検索されます。
- -K
- プレーンテキストのパスワードに対応するローカル化された認証とプライバシキーを計算して、表示します。パスワードは、環境を通して取得されます。さらに、1 つ以上の OID が指定されるなら、 SNMPv3 要求を処理するとき、計算されたキーが使用されます。
- -l filename
- ローカル転送が使用されているなら、posix のローカル (unix ドメイン) のソケットのパス。
- -M max-repetitions
- GetBulk PDU の最大の繰り返しフィールドのための値。デフォルトは、10 です。
- -N non-repeaters
- GetBulk PDU のリピータでないフィールドのための値。デフォルトは、0 です。
- -n
- 入力と出力の OID のための数値表現をのみ使用し、シンボリックなオブジェクト名を解決しないようにします。対応する文字列表現が MIB 記述ファイルで見つけられないなら、 bsnmpget, bsnmpwalk と bsnmpset は、とにかく数値の OID を印刷することに注意してください。
- -o [quiet|short|verbose]
- 受信された応答を印刷するために使用される形式。 quiet は、値のみを印刷し、short (デフォルト) は、簡略化された OID 表現と値を印刷します。 short の出力に加えて、verbose は、値の前にタイプを印刷します。
- -P options
-
SNMPv3 PDU で使用されるプライバシオプション。
- proto=[aes|des]
- SNMPv3 PDU データを暗号化する/復号化するとき使用するプロトコル。
- key=privkey
- SNMPv3 PDU でーたを暗号化する/復号化するとき使用するバイナリのローカル化されたプライバシキー。
デフォルトで、プレーンテキストの SNMPv3 PDU が送信されます。
- -p [get|getnext|getbulk]
- bsmpget と bsnmpwalk によって送信される PDU タイプ。デフォルトは、 bsmpget に対して、get で、 bsnmpwalk に対して、getnext です。 getbulk は、 bsnmpwalk によって単一の PDU で検索される複数のカラムの値を可能にする、いわゆる SNMP "bulkwalks"を実行することを可能にします。
- -r retries
- エージェントが最初の試みの後に応答しないなら、あきらめる前に、要求パケットを再送する数。デフォルトは、3 です。
- -s [trans::] [community@] [server] [:port]
-
それぞれのサーバ仕様のコンポーネントは、オプションですが、
-s オプションが使用されているなら、少なくとも 1 つが提供されなければなりません。サーバ仕様は、次の方法で構成されます:
- trans::
- 転送タイプは、udp、stream または dgram のひとつです。このオプションが提供されないなら、最も一般的である、 udp inet/inet6 ソケットが使用されます。 dgram が指定されるなら、posix のローカルのストリームソケットと posix のローカルのデータグラムソケットのためのストリームスタンドが使用されます。
- community@
- パケットを送信するとき使用される SNMP 共同体 (community) 文字列を指定します。オプションがスキップされるなら、デフォルト "public"は、 bsnmpget と bsnmpwalk に使用され、デフォルト "private"共同体文字列は、 bsnmpset に使用されます。
- server
- これは、エージェントが listen (接続を受け付け) するとき、 IP アドレスまたはホスト名のいずれかであるかもしれません。デフォルトは、“localhost”です。
- port
- 要求を送信する宛先ポート。これは、SNMP エージェントがデフォルトでないポートで listen (接続を受け付け) するなら、役に立ちます。デフォルトは、 /etc/services、ポート 161 の“snmp”エントリで与えられます。
- -t timeout
- エージェントが応答しないなら、要求パケットを再送する前の秒数。デフォルト値は、3 秒です。
- -U options
-
SNMPv3 PDU を送信するときのユーザ資格証明。
- engine=id
- バイナリオクテッド文字列として表現される SNMP エージェントの Engine ID。
- engine-boots=value
- SNMP エージェントの snmpEngineBoots の値。
- engine-time=value
-
SNMP エージェントの snmpEngineTime の値。
上記のいずれも指定されないなら、SNMP USM Engine Discovery が試みられます。また、これは、デフォルトの振る舞いです。
- name=username
- SNMPv3 PDU に含まれている USM ユーザ名。デフォルトで、ユーザ名は環境を通して取得されます。
- -v version
- 要求を送信するとき使用する SNMP プロトコルバージョン。 SNMP バージョン 1、2 と 3 がサポートされています。バージョンオプションが提供されないなら、 bsnmpget, bsnmpwalk と bsnmpset は、バージョン 2 を使用します。 GetBulkRequest-PDU は、SNMPv2 で導入され、従って、バージョンを 1 に設定し、 GetBulk PDU の送信と互換性がないことに注意してください。
- OID
-
検索する値であるオブジェクト識別子。要求を送信することができる
bsnmpget のために、少なくとも 1 つの OID が提供されるべきです。
bsnmpwalk に関して、これは、値が検索されるサブツリーのルートのオブジェクト識別子です。 OID が提供されないなら、 bsnmpwalk は、.iso(1).org(3).dod(6).internet(1).mgmt(2).mib2(1) をルートとする mib2 サブツリーをたどります。
入力 OID として有効である単一の変数を印刷するために使用される形式は、次のいずれかです:
- 1.3.6.1.2.1.25.1.1.0
- sysDescr
- ifPhysAddress.1
- ifRcvAddressStatus.2.6.255.255.255.255.255.255
- ifRcvAddressType[2,ff:ff:ff:ff:ff:ff]
- ifRcvAddressStatus[Integer:1,OctetString:ff:ff:ff:ff:ff:ff]
- ( -o verbose オプションを必要とします)
角括弧は、エントリのインデックスを指示するために使用されます。入力 OID で使用されるとき、角括弧は、エスケープされなければなりません、または OID は、シェルから保護するために引用 (quote) されなければなりません。 ifName.1 と "ifName[1]"の間に違いがないことに注意してください。
- OID= [syntax:] value
-
その構文タイプと設定される値があるオブジェクト識別子。少なくともその 1 つの文字列 OID=[syntax:]value は、要求を送信することができる
bsnmpset に提供されるべきです。
- OID
-
OID は、文字列として入力され、文字列は、ドットによって区切られた整数 (suboids) のランダムの数、ドットによって区切られた整数のシーケンスが続きます、 - すなわち、
-n オプションが使用されるなら - そのような場合に、構文は、あらゆる値に必要とされるか、または文字列は、角括弧 (エントリのインデックスを指示するために使用される) と対応するインデックスが続きます。
bsnmpset によって単一の変数を印刷するために使用される形式のいずれも、入力 OID として同様に有効です:
- 1.3.6.1.2.1.25.1.1.0=TimeTicks:537615486
- sysLocation=OctetString:"@ Home" ( -o verbose オプションを付けて)
- sysLocation.0="@ Home"
- 1.3.6.1.2.1.2.2.1.6.1=OctetString:ffffffffffff
- ifPhysAddress.1="00:02:b3:1d:1c:a3"
- ifRcvAddressStatus.1.6.255.255.255.255.255.255=1
- ifRcvAddressStatus[Integer:1,OctetString:ff:ff:ff:ff:ff:ff]=Integer:1
- ( -o verbose オプションを付けて)
- syntax
- ここで、構文の文字列は、次の 1 つです: Integer, OctetString, OID, IpAddress, Counter32, Gauge, TimeTicks, Counter64。
- value
- 設定される値 - u.u.u.u の形式の IP アドレス - 例えば、 1.3.1.6.1.2.0=IpAddress:192.168.0.1、それらに、何か特殊の文字または空白が含まれているなら、文字列は、引用符を必要とします、すてべの他の数値タイプは、不要です。
環境変数
bsnmpget, bsnmpwalk と bsnmpset は、次の環境変数を使用します:- SNMPAUTH
- デフォルトの SNMP USM 認証プロトコルを指定します。
- SNMPPRIV
- デフォルトの SNMP USM プライバシプロトコルを指定します。
- SNMPUSER
- デフォルトの SNMP USM ユーザ名を指定します。
- SNMPPASSWD
- ローカル化された認証とプライバシキーを計算するとき、使用する SNMP USM プレーンテキストのパスワードを指定します。この変数が環境に存在しているなら、SMNPv3 は、発信要求に使用するデフォルトバージョンです。
関連項目
gensnmpdef(1)作者
<syrinx@FreeBSD.org>January 10, 2012 | FreeBSD |