dbde051558
Submitted by: Nobuyuki Koganemaru <n-kogane at syd odn ne jp> Reviewed by: Watanabe Kazuhiro <CQG00620 at nifty ne jp>, Sarumaru Yoshihiko <mistral at imasy or jp>, koizumistr at minos ocn ne jp
274 lines
8 KiB
Groff
274 lines
8 KiB
Groff
.\"
|
|
.\" Copyright (c) 2001-2003
|
|
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Author: Harti Brandt <harti@freebsd.org>
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $Begemot: bsnmp/snmpd/bsnmpd.1,v 1.4 2004/08/06 08:47:10 brandt Exp $
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.Dd August 15, 2002
|
|
.Dt SNMPD 1
|
|
.Os
|
|
.Sh 名称
|
|
.Nm snmpd
|
|
.Nd "シンプルで拡張可能な SNMP デーモン"
|
|
.Sh 書式
|
|
.Nm
|
|
.Op Fl dh
|
|
.Op Fl c Ar file
|
|
.Op Fl D Ar options
|
|
.Op Fl I Ar paths
|
|
.Op Fl l Ar prefix
|
|
.Op Fl m Ar variable Ns Op = Ns Ar value
|
|
.Op Fl p Ar file
|
|
.Sh 解説
|
|
.Nm
|
|
デーモンはインターネット SNMP (Simple Network Managment Protocol)
|
|
の役目を果たします。
|
|
.\" 原文: servers は serves の誤り。
|
|
それは最も基本的な MIB だけの役目をすることを目的として、
|
|
他のすべての MIB はローダブルモジュールを通して実装しています。
|
|
.\" 原文: server は serve の誤り。(現在は修正済)
|
|
このように、想定外の用途にも
|
|
.Nm
|
|
を使用することができます。
|
|
.Pp
|
|
オプションは次の通りです:
|
|
.Bl -tag -width ".It Fl D Ar options"
|
|
.It Fl d
|
|
このオプションは
|
|
.Nm
|
|
のデバッグに使用し、自身をデーモン化しません。
|
|
.It Fl h
|
|
このオプションは短い使用法のメッセージを表示します。
|
|
.It Fl c Ar file
|
|
標準の設定ファイルの代わりに
|
|
.Ar file
|
|
を使用します。
|
|
.It Fl D Ar options
|
|
デバッグオプションは
|
|
.Fl o
|
|
の後にオプション文字列をコンマで区切って指定します。
|
|
次のオプションが利用可能です。
|
|
.Bl -tag -width ".It Cm trace Ns Cm = Ns Cm level"
|
|
.It Cm dump
|
|
このオプションは、すべての送受信した PDU を端末にダンプします。
|
|
.It Cm events
|
|
これはイベントライブラリ
|
|
.Xr ( eventlib 3
|
|
参照) のデバッグレベルを 10 に設定します。
|
|
.It Cm trace Ns Cm = Ns Cm level
|
|
このオプションは、snmp ライブラリのトレースフラグを
|
|
指定された値に設定します。
|
|
この値は通常の C の構文で数を指定することができます。
|
|
.El
|
|
.It Fl I Ar paths
|
|
このオプションは、設定インクルードファイルを検索する
|
|
ディレクトリのリストをコロンで区切って指定します。
|
|
デフォルトは
|
|
.Pa /etc:/usr/etc/:/usr/local/etc
|
|
です。
|
|
これらのパスは <> 括弧を使って指定された include でのみ検索されます。
|
|
.\" 原文: parantheses は parenthesis の誤り。(現在は修正済)
|
|
.It Fl l Ar prefix
|
|
pid と設定ファイルの basename として
|
|
.Ar prefix
|
|
を使用します。
|
|
.It Fl m Ar variable Ns Op = Ns Ar value
|
|
設定変数を定義します。
|
|
.It Fl p Ar file
|
|
デフォルトの pid ファイルの代わりに代替とするファイルを指定します。
|
|
.El
|
|
.Sh 設定
|
|
.Nm
|
|
はデフォルトまたはユーザ指定の設定ファイルのどちらかから設定を読み込みます。
|
|
設定ファイルは次のタイプの行からなります:
|
|
.Bl -bullet -offset indent
|
|
.It
|
|
変数代入
|
|
.It
|
|
セクション分離符 (セパレータ)
|
|
.It
|
|
インクルード命令
|
|
.It
|
|
MIB 変数代入
|
|
.El
|
|
.Pp
|
|
行が長過ぎる場合、
|
|
バックスラッシュで行を終わらせることによって、
|
|
次の行に続けることができます。
|
|
空行と最初の非空白文字が
|
|
.Dq #
|
|
記号である行は無視されます。
|
|
.Pp
|
|
(入れ子になった設定ファイルを含めて) 全体の設定においてすべての MIB 変数代入は
|
|
単一のトランザクションとして、すなわち、
|
|
まるで単一の SET PDU が届いたかのように扱われます。
|
|
初期設定を読み込む間に失敗があれば、
|
|
.Nm
|
|
は終了します。
|
|
モジュールのロードにともなう設定の読み込みにおける失敗は、
|
|
モジュールのロードの失敗を引き起こします。
|
|
.Pp
|
|
設定は
|
|
.Nm
|
|
の初期化、モジュールがロードされるとき、および
|
|
.Nm
|
|
が SIGHUP を受け取ったときに読み込まれます。
|
|
.\" 原文: red は read の誤り。(現在は修正済)
|
|
.Ss 変数代入
|
|
変数代入は 2 つの形式のうちの 1 つをとります。
|
|
.Bd -unfilled -offset indent
|
|
variable := string
|
|
variable ?= string
|
|
.Ed
|
|
.Pp
|
|
string は等号の後の最初の非空白文字から
|
|
最初の改行か
|
|
.Dq #
|
|
文字までです。
|
|
1 つ目の場合、string は無条件に変数に代入され、
|
|
2 つ目の場合は、その変数がまだ存在していない場合にのみ代入されます。
|
|
.Pp
|
|
変数名は文字かアンダースコアで始まり、
|
|
文字、数字またはアンダースコアのみを含むようなものである必要があります。
|
|
.Ss セクション分離符 (セパレータ)
|
|
設定は名前が付けられたセクションからなります。
|
|
.Dq snmpd
|
|
と名前が付けられたセクションの MIB 変数の代入は
|
|
初期セットアップの間か
|
|
.Nm
|
|
が SIGHUP を受け取ったときにだけ実行されます。
|
|
他のすべてのセクションは、
|
|
同じ名前がセクションにあるモジュールがロードされるか、または
|
|
.Nm
|
|
が SIGHUP を受け取ったときに既にモジュールがロードされていた場合に
|
|
実行されます。
|
|
.\" and that = しかも、それも、その上、~など
|
|
設定開始時のデフォルトセクションは
|
|
.Dq snmpd
|
|
です。
|
|
セクションを切り替えるには次のような構文を使います
|
|
.Bd -unfilled -offset indent
|
|
%secname
|
|
.Ed
|
|
.Pp
|
|
ここで、
|
|
.Ar secname
|
|
はセクションの名前です。
|
|
同じ
|
|
.Ar secname
|
|
は、設定の複数の場所で使うことができます。
|
|
これらの断片すべては 1 つのセクションにまとめられます。
|
|
.Ss インクルード命令
|
|
インクルード命令を使用して現在の設定ファイルに別のファイルを含めることができ、
|
|
この命令には次の 2 つの形式があります:
|
|
.Bd -unfilled -offset indent
|
|
\&.include "file"
|
|
\&.include <"file">
|
|
.Ed
|
|
.Pp
|
|
1 つ目の形式はカレントディレクトリでファイルで検索し、
|
|
2 つ目の形式はシステムインクルードパスで指定されたディレクトリで検索します。
|
|
入れ子の深さは利用可能なメモリによってのみ制限されます。
|
|
.Ss MIB 変数代入
|
|
MIB 変数は次の構文で代入され。
|
|
.Bd -unfilled -offset indent
|
|
oid [ suboids ] = value
|
|
.Ed
|
|
.Pp
|
|
.Va oid
|
|
は設定される変数の名前です。
|
|
全体の名前の最後の要素だけがここで使用されます。
|
|
変数がスカラであるなら、インデックス (.0) が自動的に追加され、
|
|
指定する必要がありません。
|
|
変数がテーブル列であるなら、インデックス
|
|
.Va ( suboids )
|
|
を指定しなければなりません。
|
|
インデックスの要素はそれぞれドットによって前のものと区切ります。
|
|
.\" 原文: seperated は separated の誤り。(現在は修正済)
|
|
要素は数値、文字列または [] 括弧で囲まれたホスト名のいずれかです。
|
|
要素が数値であるなら、それは現在の oid に追加されます。
|
|
要素が文字列であるなら、文字列の長さと各文字の
|
|
.Tn ASCII
|
|
コードが現在の oid に追加されます。
|
|
要素がホスト名であるなら、ホストの IP アドレスが検索され、
|
|
IP アドレスの 4 つの要素が oid に追加されます。
|
|
.Pp
|
|
例えば、
|
|
.Bd -unfilled -offset indent
|
|
myvariable.27.foooll.[localhost]."&^!"
|
|
.Ed
|
|
.Pp
|
|
の oid は oid
|
|
.Bd -unfilled -offset indent
|
|
myvariable.27.6.102.111.111.111.108.108.127.0.0.1.38.94.33
|
|
.Ed
|
|
.\" 次の .sp は翻訳で追加。
|
|
.sp
|
|
となります。
|
|
.Pp
|
|
代入の値は空、文字列または数値のいずれかです。
|
|
文字列が文字またはアンダースコアから始まって、文字、数字、アンダースコアおよび
|
|
マイナス記号だけからなるなら、引用符なしで書くことができます。
|
|
それ以外の場合は、文字列を二重引用符で囲まなければなりません。
|
|
.Sh 置換
|
|
変数の置換は次のように書きます。
|
|
.Bd -unfilled -offset indent
|
|
$(variable)
|
|
.Ed
|
|
.Pp
|
|
ここで
|
|
.Ar variable
|
|
は置換する変数の名前です。
|
|
未定義変数の使用はエラーとみなされます。
|
|
.Sh 関連ファイル
|
|
.Bl -tag -width ".It Pa /var/run/ Ns Ao Ar prefix Ac Ns \&.pid" -compact
|
|
.It Pa /etc/ Ns Ao Ar prefix Ac Ns \&.config
|
|
デフォルトの設定ファイル。
|
|
ここで、デフォルトの
|
|
.Aq prefix
|
|
は
|
|
.Dq snmpd
|
|
です。
|
|
.It Pa /var/run/ Ns Ao Ar prefix Ac Ns \&.pid
|
|
デフォルトの pid ファイル。
|
|
.It Pa /etc:/usr/etc/:/usr/local/etc
|
|
システムインクルードファイルのデフォルト検索パス。
|
|
.It Pa /usr/share/snmp/mibs/FOKUS-MIB.txt
|
|
.It Pa /usr/share/snmp/mibs/BEGEMOT-MIB.txt
|
|
.It Pa /usr/share/snmp/mibs/BEGEMOT-SNMPD.txt
|
|
デーモンで実装された MIB のための定義。
|
|
.El
|
|
.Sh 関連項目
|
|
.Xr gensnmptree 1
|
|
.Sh 規格
|
|
.Nm
|
|
は関連する IETF RFC に適合しています。
|
|
.Sh 作者
|
|
.An Hartmut Brandt Aq harti@freebsd.org
|
|
.Sh バグ
|
|
きっとある。
|