man /usr/share/snmp/snmpd.conf (5): ucd-snmp SNMP エージェントの設定ファイル

説明

snmpd.conf は ucd-smnp SNMP エージェントの操作法を定義する設定ファイルである。このファイルは下記の「ディレクティブ」セクションにある任意のディレクティブを含むことができる。エージェントが mib エントリを操作したり表示したりするためには、このファイルは必要ない。

最初にお読みください

最初に man ページ snmp_config(5) を読んでおくこと。ここには ucd-snmp ファイルの操作法・場所・互いにどのように動作するかが書かれている。

さらに、 snmpconf アプリケーション (perl スクリプト) にざっと目を通すのもよいかもしれない。このアプリケーションはユーザーに情報を提示して snmpd.conf ファイルの作成を助けてくれる。試してみなさい。本当に。さあ、今すぐに。

snmpconf -g basic_setup

で始められます。

拡張可能 MIB

ucd-snmp SNMP エージェントは、 mib ツリーの 1.3.6.1.4.1.2021 セクションに対してクェリーを行い、多くの情報を表示する。このセクションの各 mib には以下のテーブルエントリがある。

.1 -- index: 以下にリストされた「ディレクティブ」に対するテーブルのインデックス番号。
.2 -- name: 指定されたテーブルエントリの名前。これは他と重ならない方が良いが、重なっても構わない。
.100 -- errorFlag: このテーブルエントリにエラーが見つかった場合に、整数 1 または 0 を返すフラグ。
.101 -- errorMsg: 上記の errorFlag を引き起こすエラーを説明する「表示文字列」。
.102 -- errorFix: このエントリが SNMPset から整数 1 で、かつ上で定義されている errorFlag が 1 の場合、上記のテーブルエントリ名を引き数としてプログラムやスクリプトが実行される。実行されるプログラムはコンパイル時に config.h ファイルで設定される。

ディレクティブ

proc NAME

proc NAME MAX

proc NAME MAX MIN

NAME という名前のプロセスがエージェントのマシンで稼働しているかをチェックする。 NAME という名前のプログラムが "/bin/ps -e" で表示されるプロセステーブルにない場合、エラーフラグ (1) と説明のメッセージが mib コラムの 1.3.6.1.4.1.2021.2.1.100 と 1.3.6.1.4.1.2021.2.1.101 に (それぞれ) 渡される。

MAX と MIN が指定されない場合、MAX は infinity (無限大) で MIN は 1 であると仮定される。

MAX は指定されているが、MIN は指定されていない場合、 MIN は 0 であると仮定される。

procfix NAME PROG ARGS

このディレクティブは、NAME で指定されたプロセスで発生したエラーを修正するためのコマンドを登録する。 NAME で指定されたプログラムに対して 1.3.6.1.4.1.2021.2.1.102 が整数値 1 に設定された場合、このコマンドが呼び出される。呼び出されるプログラムのデフォルトは、コンパイル時の値であり、 config.h ファイルの PROCFIXCMD で定義される。

exec NAME PROG ARGS

exec MIBNUM NAME PROG ARGS

MIBNUM が指定されない場合、エージェントは PROG という名前のプログラムを引き数 ARGS を付けて実行し、プログラム PROG の終了ステータスと標準出力の 1 行目を返す。これらはそれぞれ mib コラムの 1.3.6.1.4.1.2021.8.1.100 と 1.3.6.1.4.1.2021.8.1.101 の値をクェリーしたものである。標準出力の 1 行目以降は暗黙の内に省略される。

MIBNUM が指定された場合も、上と同じように動作するが、終了ステータスを MIBNUM.100.0 に返し、標準出力全体を mib テーブル内のテーブル MIBNUM.101 に返す。このとき MIBNUM.101 mib には標準出力への出力全体が入り、 1 つの mib テーブルエントリには出力の 1 行分が入る (つまり、出力の第 1 行は MIBNUM.101.1、第 2 行は MIBNUM.101.2、... となる)。

注意:: MIBNUM はドット区切りの整数値表記でなければならない。 (.1.3.6.1... の代わりに) ".iso.org.dod.internet..." のように指定することはできない。
注意:: エージェントは最初のクェリーを行った後、実行したプログラムの終了ステータスと標準出力を 30 秒間キャッシュする。これによりその後のテーブルのクェリーのスピードが上がり、情報の一貫性が管理できる。このキャッシュは 1.3.6.1.4.1.2021.100.VERCLEARCACHE を整数 (1) に設定する snmp-set 要求により消去される。

execfix NAME PROG ARGS

このディレクティブは NAME で指定された実行プログラムまたはシェルスクリプトで発生したエラーを修正するためのコマンドを登録する。 NAME で指定したエントリに対して 1.3.6.1.4.1.2021.8.1.102 が整数値 1 に設定されると、このコマンドが呼び出される。呼び出されるプログラムのデフォルトは、コンパイル時の値であり、 config.h ファイルの EXECFIXCMD で定義される。

disk PATH

disk PATH [ MINSPACE | MINPERCENT% ]

PATH にマウントされたディスクの使用可能なディスク容量をチェックする。ディスク容量が MINSPACE (kB) より少ない場合、または % 記号を指定して MINPERCENT (%) より少ない場合、または DEFDISKMINIMUMSPACE (kB) が指定されていない場合、 1.3.6.1.4.1.2021.9.1.100 mib テーブルの関連するエントリが (1) に設定され、エラーを説明するメッセージが 1.3.6.1.4.1.2021.9.1.101 のクェリーによって返される。

load MAX1

load MAX1 MAX5

load MAX1 MAX5 MAX15

マシンの平均負荷をチェックし、 1 分間・5 分間・15 分間の平均がそれぞれの最大値を超えている場合は、 1.3.6.1.4.1.2021.10.1.100 と 1.3.6.1.4.1.2021.10.1.101 をクェリーして、エラーフラグ (1) とテキスト文字列のエラーメッセージを返す。 MAX1, MAX5, MAX15 の値のうち指定されていないものは、デフォルトの DEFMAXLOADAVE になる。

file FILE [MAXSIZE]

ファイルサイズを監視し、(キロバイトで) 指定されたサイズを超えてないかをチェックする。 MAXSIZE が指定されていない場合のデフォルトは無限大になり、エラーを報告せずにサイズのみを監視する。

エラー

上記の情報を取得するためのエラーは、 1.3.6.1.4.1.2021.101.1.100 フラグと 1.3.6.1.4.1.2021.101.1.101 テキスト文字列をクェリーして表示される。

AGENTX サブエージェント

snmp マスターエージェントで AgentX サポートを有効にするためには、 snmpd.conf ファイルに以下のような行を書き込めばよい:

master agentx: このサポートはまだ実験的なもので、製品版のシステムでは使用すべきではない。詳細は README.agentx を参照すること。

SMUX サブエージェント

gated のような SMUX ベースのサブエージェントを有効にするためには、以下のように smuxpeer 設定エントリを使えばよい:

smuxpeer OID PASS: gated についての実際のエントリは smuxpeer .1.3.6.1.4.1.4.1.3 secret のようになる。

動的読み込み可能モジュール

エージェントが UCD-DLMOD-MIB のサポートを組み込んでいる場合、エージェント MIB モジュールを起動時に dlmod ディレクティブを使って動的にロードしたり、実行中に UCD-DLMOD-MIB を使って動的にロードすることができる。以下のディレクティブは、モジュール名プレフィックスが NAME である共有オブジェクトモジュールファイル PATH をロードする。

dlmod NAME PATH

アクセス制御

snmpd は RFC 2275 で規定されている View-Based Access Control Model (vacm) をサポートしている。このため、snmpd は設定ファイルにある com2sec, group, access, view というキーワードを認識する。また簡単に使用するためのラッパーディレクティブ rocommunity, rwcommunity, rouser, rwuser も認識する。

rocommunity COMMUNITY [SOURCE] [OID]

rwcommunity COMMUNITY [SOURCE] [OID]

これらディレクティブは読み込みしかできないコミュニティと読み書きできるコミュニティを作成し、エージェントにアクセスするために使用する。これらは以下の com2sec, group, access, view ディレクティブ行を簡単に使うための方法である。これらは効率的ではなく、グループが作成されないためにテーブルが幾分大きくなる。言い換えれば、複雑な状態を設定する場合には使用してはならない、ということである。

SOURCE のフォーマットは、以下の com2sec ディレクティブセクションで説明されているトークンと同じである。 OID トークンは、コミュニティのアクセスを、指定された OID 以下のものだけに制限する。

rouser USER [noauth|auth|priv] [OID]

rwuser USER [noauth|auth|priv] [OID]

SNMPv3 USM ユーザーを VACM アクセス設定テーブルに作成する。これもまた、com2sec, group, access, view ディレクティブを組み合わせて使用した方が効率的 (かつ強力) である。

ユーザーが使用しなければならない認証とプライバシーの最低レベルを最初のトークンで指定する (デフォルトは "auth" である)。 OID パラメータは、そのユーザーのアクセスを、指定された OID 以下のものだけに制限する。

com2sec NAME SOURCE COMMUNITY

このディレクティブはソース (SOURCE) とコミュニティ (COMMUNITY) のペアからセキュリティ名 (NAME) へのマッピングを指定する。 SOURCE はホスト名・サブネット・"default" である。サブネットは IP/MASK または IP/BITS で指定できる。入ってくるパケットにマッチするソースとコミュニティの組み合わせが選択される。

group NAME MODEL SECURITY

このディレクティブはセキュリティモデル (MODEL) とセキュリティ名 (SECURITY) のペアからグループ名 (NAME) へのマッピングを定義する。 MODEL は v1, v2c, usm のいずれか 1 つである。

access NAME CONTEXT MODEL LEVEL PREFX READ WRITE NOTIFY

access ディレクティブはグループセキュリティとモデルセキュリティのレベルを、あるビュー (view) にマップする。 MODEL は any, v1, v2c, usm のいずれか 1 つである。 LEVEL は noauth, auth, priv のいずれか 1 つである。 PREFX は入ってくる pdu の内容に対する CONTEXT のマッチの方法を指定するもので、 exact または prefix である。 READ, WRITE, NOTIFY はビューに対応するアクセス方法を指定するのに使われる。 v1 または v2c のアクセスでは、LEVEL は noauth、 CONTEXT は空文字列である。

view NAME TYPE SUBTREE [MASK]

このディレクティブは指定した名前のビュー (view) を定義する。 TYPE は included または excluded である。 MASK は 16 進数で表した 8 ビットを '.' または ':' で区切ってリストにしたものである。 MASK が指定されていない場合のデフォルトは "ff" である。

マスクを使用する理由は、比較的簡単にテーブルの 1 つの行 (row) へのアクセスを制御することにある。例えば、ISP ではそれぞれの顧客に対して顧客ごとのインタフェースにアクセスさせたいと考えるかもしれない:

view cust1 included interfaces.ifTable.ifEntry.ifIndex.1 ff.a0
view cust2 included interfaces.ifTable.ifEntry.ifIndex.2 ff.a0

(interfaces.ifTable.ifEntry.ifIndex.1 == .1.3.6.1.2.1.2.2.1.1.1 で ff.a0 == 11111111.10100000 である。これは行インデックスをうまい具合いにカバーして含んでいるが、行フィールドの変更をユーザーに許可している。)

VACM の例:

# sec.name source community com2sec local localhost private com2sec mynet 10.10.10.0/24 public com2sec public default public # sec.model sec.name group mygroup v1 mynet group mygroup v2c mynet group mygroup usm mynet group local v1 local group local v2c local group local usm local group public v1 public group public v2c public group public usm public # incl/excl subtree mask view all included .1 80 view system included system fe view mib2 included .iso.org.dod.internet.mgmt.mib-2 fc # context sec.model sec.level prefix read write notify access mygroup "" any noauth exact mib2 none none access public "" any noauth exact system none none access local "" any noauth exact all all all

デフォルトの VACM モデル

最初の状態でのエージェントのデフォルトの設定は、機能的には以下のエントリと等価である: com2sec public default public group public v1 public group public v2c public group public usm public view all included .1 access public "" any noauth exact all none none

SNMPv3 設定

engineID STRING: snmpd エージェントが SNMPv3 メッセージに応答するためには engineID を設定する必要がある。設定ファイルにこの行があれば、STRING から engineID を設定する。 engineID のデフォルト値は、マシンのホスト名に対して見つかる最初の IP アドレスに設定される。
createUser username (MD5|SHA) authpassphrase [DES] [privpassphrase]: このディレクティブは、他の場所にある通常の設定ファイルではなく、 "/var/ucd-snmp"/snmpd.conf ファイルに書くべきである。その理由は、情報がこのファイルから読み込まれた後、この行が削除され (ユーザーのマスターパスワードの格納場所から消去されて)、この行から得られるキーに置き換えられるためである。このキーはローカルなキーであり、盗まれたとしても他のエージェントにアクセスするのには使えない。しかしパスワードが盗まれた場合は、他のエージェントにアクセスできる。
: MD5 と SHA は使用される認証タイプであるが、 SHA を使用するためにはインストールされている openssl を使ってパッケージを作成しなければならない。現在のところプライバシープロトコルがサポートされているのは DES のみである。プライバシーパスフレーズが指定されていない場合、認証パスフレーズと同じであると仮定される。上で説明した VACM アクセス制御テーブルに入れなければ、作成したユーザーの使い道がない点に注意すること。
: 警告: パスフレーズは少なくとも 8 文字である。
: snmpusm コマンドを用いれば、実行中に SNMPv3 ユーザーを作成することができる。

システム情報の設定

syslocation STRING
syscontact STRING
sysname STRING: エージェントが置かれているシステムの場所 (location)・連絡先 (contact)・名前 (name) を設定する。この情報は mibII ツリーの 'system' グループに設定される。通常、これらのオブジェクト (sysLocation.0, sysContact.0 and sysName.0) は読み書き可能である。ただし、これらのオブジェクトの値に適切なトークンを付加して指定すれば、そのオブジェクトを読み込みのみにすることができ、オブジェクトの値を設定しようとしたときに notWritable エラーレスポンスを返すようにできる。
sysservices NUMBER: system.sysServices.0 オブジェクトの値を設定する。ホストの場合は、72 がよい。
agentaddress [(udp|tcp):]port[@address][,...]: デフォルトの 161 番ポートではなく、指定したソケットのリストでエージェントのリストを作成する。複数のポートをコンマで区切って指定できる。トランスポート名 ("udp" または "tcp")・コロン・ポート名のようにして、トランスポート名を指定できる。特定のインタフェースにバインドするために、アドレスを指定することができる。例えば agentaddress 161,tcp:161,9161@localhost のように指定すれば、エージェントに対して、全てのアドレスの udp ポート 161・全てのアドレスの tcp ポート 161・ localhost のアドレスに関連づけられたインタフェースの udp ポート 9161 を監視 (listen) させることができる。 -T フラグを用いれば、使用するデフォルトのトランスポートマッピングを変更することができる (上記の例では、デフォルトのトランスポートマッピングは udp である)。
agentgroup groupid: ポートをオープンした後で、グループ ID を指定した値に変更する。 groupid はグループ名またはグループ番号である。グループ番号の場合は '#' で始める。例えば agentgroup snmp の場合は、エージェントを snmp グループで動作させる。 agentgroup #10 の場合は、エージェントをグループ ID 10 番で動作させる。
agentuser uid: ポートをオープンした後で、ユーザー ID を指定した値に変更する。 userid はユーザー名またはユーザー番号である。ユーザー番号の場合は '#' で始める。例えば agentuser snmp の場合は、エージェントをユーザー snmp で動作させる。 agentuser #10 の場合は、エージェントをユーザー ID 10 番で動作させる。
interface NAME TYPE SPEED: エージェントがタイプやスピードの推測に失敗したインタフェースに対して、このディレクティブで追加の情報を提供することができる。 TYPE は IANAifType-MIB で指定されるタイプである。
ignoredisk STRING: 使用可能なディスクデバイスをスキャンする場合、エージェントは使用可能なディスクデバイスをオープンするときにブロックを行うことがある。これによってデバイスツリーを辿っているときにタイムアウトが起るかもしれない。次に辿ったときにタイムアウトになるかもしれないし、毎回タイムアウトになるかもしれない。
: このような現象が起った場合は、このディレクティブを追加し、チェックしない (つまりオープンしない) 全てのデバイスを指定する。設定ファイルにこのディレクティブを 1 つ以上の指定して、オープンしない全てのデバイスを書き込む。 bourne シェルの文法の似たワイルドカードを使って、デバイスを指定することもできる (下記の例を参照すること)。
: 注意: 全てのシステムでスキャンされるデバイスのリストは、ソース (host/hr_disk.c) を見て、 OS タイプに対応した Add_HR_Disk_entry() コールをチェックすること。
: 例:
: ignoredisk /dev/rdsk/c0t2d0
: このディレクティブは、デバイス /dev/rdsk/c0t2d0 をスキャンさせないようにする。
: ignoredisk /dev/rdsk/c0t[!6]d0
: このディレクティブは /dev/rdsk/c0t6d0 を除く /dev/rdsk/c0tXd0 の全てのデバイスをスキャンさせないようにする。多くのシステムで同様なディレクティブとしては以下のものがある:
: ignoredisk /dev/rdsk/c0t[0-57-9a-f]d0
: ignoredisk /dev/rdsk/c1*
: このディレクティブは、/dev/rdsk/c1 で始まる名前のデバイスを全てスキャンさせないようにする。
: ignoredisk /dev/rdsk/c?t0d0
: このディレクティブは、デバイス /dev/rdsk/cXt0d0 ('X' は任意の文字) を全てスキャンさせないようにする。
: どのディレクティブにおいても、このようなワイルドカード表現を 2 つ以上使うことできる。
authtrapenable NUMBER: authtrapenable を 1 に設定すると、認証の失敗が起った場合にトラップを生成する。デフォルトの値は disabled(2) である。通常これに対応するオブジェクト (snmpEnableAuthenTraps.0) は読み書き可能であるが、このトークンを使って値を設定すると読み込みだけになり、オブジェクトの値を設定しようとした場合には notWritable エラーレスポンスを返す。
trapcommunity STRING: このコマンドはトラップを送るときに使うデフォルトのコミュニティ文字列を定義する。このコマンドはコミュニティ文字列を使う以下の 3 つのコマンドより前に使用しなければならない点に注意すること。
trapsink HOST [COMMUNITY [PORT]]
trap2sink HOST [COMMUNITY [PORT]]
informsink HOST [COMMUNITY [PORT]]: これらのコマンドはトラップを受信する (通知を送る先の) ホストを定義する。このデーモンは起動時に Cold Start トラップを送る。有効になっている場合は、認証が失敗したときにもトラップを送る。 trapsink, trap2sink, informsink 行を複数指定すれば、複数の送信先を指定することができる。 trap2sink は SNMPv2 トラップを送るのに使う。 informsink は通知を発行するのに使う。 COMMUNITY が指定されていない場合、以前に trapcommunity ディレクティブで指定した文字列が使われる。 PORT が指定されていない場合、良く知られている SNMP トラップポート (162) が使われる。
trapsess [SNMPCMD_ARGS] HOST [COMMUNITY]: これはより基本的なトラップ設定トークンで、任意のトラップ送信先タイプと任意の SNMP バージョンを指定できる。 SNMPCMD ARGS として渡される引き数のより詳しい情報は、 snmpcmd(1) の man ページを参照すること。ここで挙げた引き数に加えて、特別な引き数 -Ci があり、 unacknowledged トラップではなく通知を使用することを指定する。 (この引き数を指定するには、バージョン番号 v2c または v3 を指定する必要がある)。

プロキシのサポート

proxy [SNMPCMD ARGS] HOST OID [REMOTEOID]: 警告: この機能はサポートはβ版である。
: このトークンは受信した OID 以下の任意のリクエストを HOST に中継して渡す。通常はローカルの OID ツリーを新しい REMOTEOID という場所に変更する。 HOST で認証されるためには、適切な SNMPCMD ARGS のセットを使わなければならない。詳細は snmpcmd の man ページを参照すること。
: 例:
: proxy -v 1 -c public remotehost .1.3.6.1.4.1.2021
: proxy -v 3 -l noAuthNoPriv -u user remotehost .1.3.6.1.3.10 .1.3.6.1.2.1.1

パススルー制御

pass MIBOID EXEC

MIBOID の全制御を EXEC プログラムに渡す。 EXEC プログラムは以下の 3 つのうちの 1 つの方法で呼び出す:

EXEC -g MIBOID

EXEC -n MIBOID

これらの呼び出しは SNMP get と getnext リクエストにマッチする。 EXEC プログラムは渡された引き数を受け取り、レスポンスを標準出力に返すと仮定されている。

標準出力の 1 行目は返り値の mib OID である。 2 行目は返される値の TYPE である。 TYPE はテキスト文字列 string, integer, unsigned, objectid, timeticks, ipaddress, counter, gauge のうちの 1 つである。標準出力の 3 行目は返された TYPE に対応する VALUE である。

例えば .1.3.6.1.4.100 へリクエストが送られたときにスクリプトが整数値 "42" を返す場合、スクリプトは以下の 3 行を返さなければならない:

:   .1.3.6.1.4.100

  integer

  42

end-of-mib 条件や不正なリクエスが原因で、スクリプトが応答できないことを表すには、単純に exit して標準出力に何も返さなければよい。 SNMP NO-SUCH-NAME レスポンスに対応する snmp エラーが生成される。

EXEC -s MIBOID TYPE VALUE

SNMP set リクエストを送るには、上の方法を用いる。 EXEC プログラムに渡される TYPE は、テキスト文字列 integer, counter, gauge, timeticks, ipaddress, objid, string のうちの 1 つである。これらは次の引き数で渡される VALUE のタイプを表す。

標準出力に何も返さなかった場合は、set が成功したものと仮定する。それ以外の場合としては、エラーを示すために not-writable または wrong-type のいずれかの文字列を返すことがあり、適当なエラーレスポンスが生成される。

注意:: デフォルトでは、ユーザーのスクリプトで write (つまり snmpset) が許可されるコミュニティは、 "private" コミュニティと上で説明した "community" トークンで別に定義したコミュニティ #2 のみである。どのコミュニティに書き込みアクセスを許可するかは、ソースファイル snmplib/snmp_impl.h の RWRITE 定義で制御できる。

(snmpd.conf における) 例:

pass .1.3.6.1.4.1.2021.255 /path/to/local/passtest

pass_persist MIBOID EXEC

MIBOID の全ての制御を EXEC プログラムに渡す。 pass と似ているが、EXEC プログラムは最初のリクエストに返答した後も稼働し続ける。

初期化の際には、EXEC に対して標準入力から文字列 "PING\n" が渡され、標準出力に "PONG\n" を表示して返答する。

get または getnext リクエストを送るには、 EXEC プログラムにコマンド (get または getnext) と mib OID という 2 行を渡す。 EXEC プログラムは、mib OID・返される VALUE の TYPE・返された TYPE に対応する VALUE という 3 行を返す。

例えば、.1.3.6.1.4.100 の値をリクエストする場合は、標準入力に以下の 2 行を渡す。

: get

.1.3.6.1.4.100

値、つまり 42 を返すために、スクリプトは以下のような書き出しを行う:

:   .1.3.6.1.4.100

  integer

  42

end-of-mib 条件または不正なリクエストが原因で、スクリプトがリクエストに応答できないことを表すには、標準出力に "NONE\n" を書き出す。

(snmpd.conf における) 例:

pass_persist .1.3.6.1.4.1.2021.255 /path/to/local/pass_persisttest

例

上記の情報が実際の例でどのように使われているかについては、ソースのトップディレクトリにある EXAMPLE.CONF ファイルを参照すること。

snmpd.conf と snmpd.local.conf の再読み込み

ucd-snmp エージェントは設定ファイルを再読み込みさせることが可能である。以下の 2 つのうちの 1 つを実行すればよい:

1.: snmpset で UCD-SNMP-MIB::versionUpdateConfig.0 (.1.3.6.1.4.1.2021.100.11.0) を整数 (1) に設定する。
2.: snmpd エージェントプロセスに "kill -HUP" シグナルを送る。

ファイル

/usr/share/snmp/snmpd.conf

説明