SNMP

SNMP v1、v2c、v3 に応答するネットワーク機器（UPS、PDU、スイッチ、ルーター、精密空調、環境センサー）を、各タグの読み出し周期ごとにエージェントを通して読みます。「SNMP エージェント」のカード、数字または標準名で書くタグの OID、各オブジェクトを読むデータ型、読み取りと書き込み、エージェントのオブジェクトを見つけるたどり、そして 2 つの完全な例です。

SNMP ドライバーは、機械室の機器をその SNMP エージェントを通して読み書きします。UPS、PDU、スイッチ、ルーター、精密空調、温度や湿度のセンサーです。サーバーの管理コントローラーを読む Redfish ドライバーを補うもので、両方で機械室全体をカバーします。各タグはエージェントのオブジェクトを 1 つ、upsBatteryStatus.0 や ifHCInOctets.2 のような OID で読み、値はほかのどのタグの値とも同じところに届きます。Logic、ダッシュボード、そして Process の試験台の実行記録です。

問い合わせるのはステーションです。各タグは読み出し周期ごとに SNMPv1、SNMPv2c、SNMPv3 のいずれかで読まれ、「機器」のカードの読み出し周期（ms）はどのドライバーとも同じように働き、各タグで上書きできます。機器が自分から送るもの、つまりトラップは受け取りません。知っておきたい制限を参照してください。

このドライバーの機器はエージェント 1 つで、そのホストの UDP ポート 161 で到達します。機器はドライバーの下に置かれ、フォルダーに整理でき、シリアル回線もブローカーも持たないどのドライバーとも同じく ドライバー → フォルダー → 機器 → タグ となります。

ドライバーのページ

Connector の構成の権限があるとき、ページにはこのドライバー独自のスキャンの範囲のカードがあり、機器検出がたどるエージェントとサブツリーを持ちます（機器検出を参照）。その下には、どのドライバーとも同じ機器の表（機器の表を参照）があり、タイトルの右にある機器を追加で増やします。空のときは「機器はまだありません。」と表示します。ドライバーのバーには機器検出があり、スキャンの範囲のカードがそろうまで灰色です。

機器

接続

新しい機器にはホストがありません。「ホストがまだ入力されていません」と表示し、ホストが入るまで何も送りません。見出しに出る Base URI は実行時のアドレスで、バージョン、有効な SNMPv3 のセキュリティ、応答のタイムアウト、再試行回数を含みます。snmp://192.168.10.40:161?version=2c&timeoutMs=2000&retries=1、または snmp://192.168.10.2:161?version=3&security=authPriv&auth=sha256&priv=aes128&timeoutMs=2000&retries=1 です。community、ユーザー、パスワードは決して含みません。

「SNMP エージェント」のカード

「接続」のカードの下にある SNMP エージェントのカードは、エージェントへの問い合わせ方を示します。描かれる欄はバージョンと、SNMPv3 ではセキュリティレベルに従います。

2 つのパスワードの下には「各パスワードは、エージェントがこのユーザーに設定しているもので、8 文字以上です。」と出ます。ユーザー、セキュリティレベル、2 つのプロトコルは、機器自身の設定ページでエージェントがそのユーザーに設定しているものです。ステーションはそれをエージェントに問い合わせることができません。MD5、SHA-1、DES を選べるのは、設置済みの多くの機器がそれより新しいものを受け付けないからです。

まだ入力されていない資格情報は誤りではありません。機器は保存され、それが入るまでドライバーはエージェントに何も送らず、カードの下の落ち着いた 1 行が足りないものを示します。次のうち最初のものです。

ホストがあって資格情報がまだ足りない機器は接続せず、その最後のエラーがエージェントの待っている資格情報を示します。カードが受け付けられない値は保存されず、カードがその理由を赤で示します。

保存もカードと同じ規則を守り、拒否したときは操作ログ帯がそう伝えます：「機器 'UPS room 1' に、ドライバーが使えない SNMP の設定があります。開いて、パネルが示す欄を直してください。」community と 2 つのパスワードは、どの機器の資格情報とも同じように保管されます（資格情報と証明書を参照）。入力した Windows アカウントのために保存時に保護され、構成のエクスポートでは封印され、Base URI、診断ログ、エージェントの応答には決して出ません。別の Windows アカウントで入力されたものは空で戻り、機器は一度も入力されていないときと同じようにそれを待ちます。

タグのアドレス

OID

このドライバーのタグは、エージェントのオブジェクトを 1 つ読みます。タグの「信号源」のカードには OID の欄があり、その下に「数字で書いた OID（例: 1.3.6.1.2.1.1.3.0）か、インスタンス付きの標準名（例: sysUpTime.0、ifInOctets.2、upsBatteryStatus.0）」という助言が出ます。タグをどの形で書いても、リクエストが運ぶのは数字です。

欄の下には、読み取り専用で、OID が 2 つの形で出ます。

標準名のないオブジェクトでは「機器独自の MIB のオブジェクトです。MIB ファイルは読まないため、数字で表示します。」という行が加わります。ドライバーが読めない OID のタグは保存されず、タグのページがその理由を示します。

保存も同じ規則を守ります：「タグ 'Battery status' は、SNMP ドライバーが読める OID を指していません。開いて、タグのパネルが示すアドレスを直してください。」読み取り専用の行取得元のアドレス（バス上）は、ドライバーが受け取る数字を示します。upsBatteryStatus.0 と書いたタグなら 1.3.6.1.2.1.33.1.2.1.0 です。

ドライバーが知っている名前

ドライバーは、名前を付ける価値のある標準 MIB のオブジェクトの表を 1 つ持っています。RFC から書き起こしたもので、どのステーションでも名前は同じ意味です。MIB ファイルは読みません。

driver_capabilities はすべての名前を OID とともに一覧にします。エージェントのツールを参照してください。

データ型とアクセス

データ型の一覧には、オブジェクトを損失なく読める型だけが出ます。

カウンターは 16,777,216 を超えると丸めてしまう Float では選べず、Counter64 は半分を超えるカウントを拒否してしまう Int64 では選べません。Boolean は決して選べません。SNMP には真偽値がなく、その TruthValue（1 が真、2 が偽）と機器独自の 0 と 1 では、同じ型を正反対の 2 通りに読んでしまうため、状態は Int32 で読みます。OID が変わると、新しいオブジェクトが読めない型は、いちばん自然に読める型に変わります。読めない型は拒否され、読める型が示されます：「ifHCOutOctets.2 は次のいずれかとして読みます: UInt64, Double, String。」

MIB が読み取り専用と宣言している標準オブジェクト（カウンター、sysUpTime、状態）では読み取りのみだけが選べ、「アクセス」の欄には「読み取り専用：この値は機器が報告するもので、外から設定するものではありません。」と出ます。MIB が書き込み可能と宣言している標準オブジェクト（sysContact、sysName、sysLocation、ifAdminStatus、ifAlias、UPS-MIB のテスト、制御、設定のオブジェクト）と機器独自の MIB のオブジェクトでは、すべてのアクセスが選べます。書き込みを受け付けるかどうかはエージェント自身の答えです。

読み取り

各タグの読み出し周期ごとに、ステーションは GET を送ります。エージェントの応答が、タグに何を表示するかを決めます（値の変換経路を参照）。

機器は一度に 1 つのリクエストを送ります。読み取りはタグのオブジェクトを問い合わせ、同じリクエストで、新しい応答を持たない機器のほかのタグも、32 個の OID まで問い合わせます。リクエストが大きすぎる（tooBig）と答えるエージェントには、それ以降その半分を送ります。こうして持ち帰った応答は、別のタグの読み出し周期の半分より新しいあいだ、そのタグ自身の読み取りに使われるので、40 個のタグでも 1 巡あたり 1 つか 2 つのリクエストで済みます。SNMPv3 エージェントのエンジンは接続ごとに 1 回学習し、エージェントが時間の窓の外だと報告したリクエストは、エージェント自身の値でもう一度送ります。

書き込み

書き込むアクセスのタグは、機器のキューを通して SET を送ります。書き込みはほかのどのドライバーとも同じ経路を通ります。書き込み欄は工学値を受け取り、生の値を送る前に変換段階を逆にたどります（Connectorを参照）。SET が運ぶ値の種類は、エージェントがそのオブジェクトに最後に答えた種類、それがなければ MIB が宣言する種類、それもなければいま GET が答える種類、最後にタグ自身の型です（Int32 は Integer32、UInt32 は Gauge32、String は OCTET STRING）。その種類に収まらない値は、何も送る前に拒否されます。

機器検出

「スキャンの範囲」のカード

Connector の構成の権限があるとき、ドライバーのページにはスキャンの範囲のカードがあり、その下に「1 つのエージェントの標準サブツリーをたどり、見つかったものを一覧にします。SNMPv3 エージェントは機器を通してスキャンするので、その機器をエージェントとして選んでください。」という行があります。

範囲にまだ足りないものはカードの下に赤で示され、そろうまで機器検出は灰色のままです。

スキャンする機器に保存できない編集があるときは、スキャンは始まりません：「スキャンする機器の編集を保存できなかったため、機器検出は始まりませんでした。」

スキャンが提示するもの

機器検出はまずエージェントに名前（sysName.0）を尋ね、これでエージェントがその資格情報に応答することも確かめます。そのあと、チェックした各サブツリーと指定したサブツリーを、SNMPv2c と SNMPv3 では GETBULK、SNMPv1 では GETNEXT で、エージェントがその外を答えるまでたどります。進行の行は読んだ数を数えます：「192.168.10.40:161 の SNMP エージェントをたどっています: 120 個のオブジェクトを検出。」スキャンは最大 2000 個のオブジェクトを最長 60 秒たどります。そこで打ち切られたとき、または途中でエージェントが黙ったときは、見つけたものを残し、そう伝えます：「192.168.10.40:161 のたどりは途中で止まりました（2000 個のオブジェクトを検出）。スキャンは最大 2000 個のオブジェクトを最長 60 秒たどり、エージェントが応答しなくなった時点で止まります。」

スキャンはエージェントごとに候補を 1 つ提示します。名前は sysName（エージェントが名前を返さないときは機器の名前かホスト）で、読んだときのバージョン、タイムアウト、再試行回数を持ち、見つけたオブジェクトを候補のタグとして持ちます。

どのタグの型にも収まらない値は除かれます。入力したアドレスのスキャンから追加した機器は、スキャンが使った community を保持し、どの機器の資格情報とも同じように保護します。機器のスキャンから追加した機器は、その機器の資格情報を持ちます。このドライバーの機器がすでにエージェントを読んでいる候補（スキャンした機器、または同じホストとポートの別の機器）は設定済みと示されます。そのカードには、その機器のどのタグもまだ読んでいないオブジェクトだけが並び（名前で書いた OID と数字で書いた OID は同じものと数えます）、開くの前にあるタグにして追加が、チェックしたものをその機器に追加します。スキャンのそのほかの動きは機器検出にあります。

機器自身のページでも、ドライバーのページを使わずに同じことができます。「タグ」のカードの見出しにあるタグ検出は、その機器の設定と資格情報でエージェントを巡回し、標準のサブツリーと、タグがすでに読んでいるメーカーの枝（その下のタグがあれば enterprises.318）をたどって、まだタグがないオブジェクトだけを出します（機器のタグを検出するを参照）。

例：SNMPv2c の UPS

ネットワークカード付きの UPS が 192.168.10.40 で SNMPv2c に応答し、そのカードに読み取り用の community が設定されています。バッテリーを読みます。

1. ドライバーのページで機器を追加し、名前を UPS room 1 にして、ホストに 192.168.10.40 を入力し、ポートは 161 のままにします。
2. SNMP エージェントのカードで SNMPv2c のままにし、Community にカードの読み取り用 community を入力し、応答のタイムアウト（ms）は 2000、再試行回数は 1 のままにします。community を求めていた行が消えます。
3. タグを追加で Battery status、OID upsBatteryStatus.0、データ型 Int32 にします。欄の下では MIB の名前が upsBatteryStatus.0 で UPS-MIB · Integer32 · 読み取り専用 と出て、数字の OID は 1.3.6.1.2.1.33.1.2.1.0、アクセスは読み取りのみのままです。値は 1 unknown、2 batteryNormal、3 batteryLow、4 batteryDepleted のいずれかです。
4. タグを追加で Battery charge、OID upsEstimatedChargeRemaining.0、データ型 Int32、単位 % にします。
5. UPS が報告するなら、タグを追加で Minutes remaining、OID upsEstimatedMinutesRemaining.0、データ型 Int32、単位 min にします。

Base URI は snmp://192.168.10.40:161?version=2c&timeoutMs=2000&retries=1 です。エージェントはツールで同じことをします。

device_upsert name="UPS room 1" driver=Snmp host=192.168.10.40 snmpVersion=V2c snmpCommunity="<the UPS card's read community>"
tag_upsert device="UPS room 1" name="Battery status" address=upsBatteryStatus.0 opcUaType=Int32
tag_upsert device="UPS room 1" name="Battery charge" address=upsEstimatedChargeRemaining.0 opcUaType=Int32 unit=%
tag_upsert device="UPS room 1" name="Minutes remaining" address=upsEstimatedMinutesRemaining.0 opcUaType=Int32 unit=min

例：SNMPv3 でのスイッチのインターフェースカウンター

192.168.10.2 のマネージドスイッチが、ユーザー scada に対して SNMPv3 で応答し、スイッチ側では SHA-256 の認証と AES-128 の暗号化が設定されています。ポート 2 のトラフィックと状態を読みます。

1. 機器を追加し、名前を Core switch、ホストを 192.168.10.2、ポートを 161 にします。
2. SNMP エージェントのカードで SNMPv3 を選び、SNMPv3 ユーザーに scada と入力し、署名と暗号化（authPriv）のままにし、認証プロトコルで SHA-256 を選んでそのパスワードを入力し、暗号化プロトコルは AES-128 のままにしてそのパスワードを入力します。どちらもスイッチが scada に設定しているもので、8 文字以上です。
3. タグを追加で Port 2 in、OID ifHCInOctets.2 にします。データ型は 64 ビットのカウンターを読む型である UInt64 になり、一覧には UInt64、Double、String だけが出ます。単位は B です。
4. タグを追加で Port 2 out、OID ifHCOutOctets.2、UInt64、単位 B にします。
5. タグを追加で Port 2 state、OID ifOperStatus.2、データ型 Int32 にします。1 up、2 down、3 testing、7 lowerLayerDown です。

.2 はスイッチのインターフェースのインデックスで、ifName.2 が名前を示すものです。インターフェースのサブツリーをスキャンすると、すべてのインターフェースがインデックスとともに一覧になります。Base URI は snmp://192.168.10.2:161?version=3&security=authPriv&auth=sha256&priv=aes128&timeoutMs=2000&retries=1 です。ツールでは、オブジェクトが読めない opcUaType（ifHCOutOctets.2 に Int32 など）は、読める型を示して拒否されます。

device_upsert name="Core switch" driver=Snmp host=192.168.10.2 snmpVersion=V3 username=scada password="<authentication password>" snmpSecurityLevel=AuthPriv snmpAuthProtocol=Sha256 snmpPrivacyProtocol=Aes128 snmpPrivacyPassword="<privacy password>"
tag_upsert device="Core switch" name="Port 2 in" address=ifHCInOctets.2 opcUaType=UInt64 unit=B
tag_upsert device="Core switch" name="Port 2 out" address=ifHCOutOctets.2 opcUaType=UInt64 unit=B
tag_upsert device="Core switch" name="Port 2 state" address=ifOperStatus.2 opcUaType=Int32

エージェントのツール

driver_capabilities はこのドライバーを snmp の下で説明します。バージョンとそれぞれが受け取る資格情報、セキュリティレベルとプロトコル、応答のタイムアウトと再試行回数、OID の書き方、値の種類ごとの型、ドライバーが知っているすべての名前（MIB、OID、書き込みを受け付けるか）、読み取りと書き込みの動き、機器検出、上の 2 つの例です。device_upsert driver=Snmp は host、port（既定は 161）、snmpVersion（V1、既定の V2c、V3）、SNMPv1 と SNMPv2c では snmpCommunity（'' で消去）、SNMPv3 では username（ユーザー）、password（その認証パスワードで 8 文字以上）、snmpSecurityLevel（既定の AuthPriv、AuthNoPriv、NoAuthNoPriv）、snmpAuthProtocol（Md5、既定の Sha1、Sha256、Sha384、Sha512）、snmpPrivacyProtocol（Des、既定の Aes128、Aes192、Aes256）、snmpPrivacyPassword を受け取り、さらに responseTimeoutMs（100 から 60000、既定は 2000）と snmpRetries（0 から 5、既定は 1）を受け取ります。SNMPv3 の機器への community や、community の機器への SNMPv3 の項目は拒否されます。ツールが返す機器は snmp を持ちます。バージョン、hasCommunity、有効なセキュリティレベルとプロトコル、hasPrivacyPassword、タイムアウト、再試行回数、そしてまだ待っている資格情報を示す missingCredential です。秘密は決して返しません。tag_upsert は OID を address として受け取り、opcUaType の既定はオブジェクトをいちばん自然に読む型です。wireQuantity と eipPath は拒否されます。device_discover driver=Snmp は、target（ホストで、161 でなければ port も）を snmpVersion（V1 か V2c）と snmpCommunity とともにたどるか、このドライバーの機器の名前である snmpDevice をたどります。SNMPv3 エージェントをスキャンする唯一の方法は後者です。snmpSubtrees は標準サブツリー（System、Interfaces、Ups、Sensors、HostResources をコンマ区切り）を選び、snmpSubtree はもう 1 つ加えます。ツールはスキャンの community を保持しません。スキャンが見つけたものから作る機器は device_upsert でもう一度それを受け取り、設定済みの機器に足りないタグは tag_upsert で追加します。そのほかのツールはエージェントのツールにあります。

知っておきたい制限

• 何かが起きたときに機器が自分から送るトラップとインフォームは受け取りません。どの値も読み出し周期ごとに読むので、残量の減ったバッテリーは、その状態を次に読んだときにわかります。
• MIB ファイルは取り込みません。ドライバーが知っている名前は、内蔵する標準 MIB のものです。enterprises の下にある機器独自の MIB のオブジェクトは数字で書き、数字で表示し、その意味はメーカーの資料で確かめます。
• ステーションは SNMP エージェントではありません。ステーション自身を SNMP で読むことはできません。
• スキャンが SNMPv3 エージェントに届くのは、そのユーザーとパスワードを持つ機器を通したときだけで、community やユーザーを自分から試すことはありません。
• スキャンは最大 2000 個のオブジェクトを最長 60 秒たどります。大きなスイッチでは、要らないサブツリーのチェックを外すか、要るサブツリーを指定してください。
• Boolean のタグはありません。TruthValue や機器独自のオンとオフは Int32 で読みます。