A.6 SNMPトラップ XML定義ファイル説明

SNMPトラップ XML 定義ファイルを用いて、障害監視方法をカスタマイズできます。このファイルは、マネージャー側とエージェント側で定義します。

マネージャー側の SNMPトラップ XML 定義ファイル

障害管理する各装置（サーバノードを含む）から SNMPトラップを受信した時のイベントログのメッセージ、Systemwalker Centric Manager 連携、Shell/Bat連携、外部スクリプト連携の動作を定義できます。ストレージシステムの運用環境に応じて、マネージャー側でのこれらの処理をデフォルトから変更したい場合にカスタマイズしてください。

このファイルを作成することで、サポートレベル I の装置も、サポートレベル A および B と同等の障害監視を実現できます。

エージェント側のSNMPトラップ XML定義ファイル: エージェントのサーバノードに対する障害監視方法を定義します。エージェントの障害監視方法をデフォルトから変更したい場合にカスタマイズしてください。

設定ファイルの反映方法

マネージャー側の設定ファイルは動的に本製品に読み込まれるため、特別な反映方法はありません。

エージェント側の設定ファイルは静的に本製品に読み込まれるため、反映のためにエージェントの再起動が必要です。

カスタマイズ

注意

XML 定義ファイルに誤りがある場合は、イベントログに下記の形式でメッセージが出力されます。このとき、障害レベルは Information レベルで通知されます。また、Systemwalker Centric Manager 連携・Shell/Bat連携も動作しません。
```
メッセージ形式："XML parse error (detected trap: (SNMPトラップデータ文字列))"
```
Systemwalker Centric Manager に通知されるときの swsag コードは、一部の装置を除き、すべて 4821 となります。
SNMPトラップ処理をカスタマイズする場合は、カスタマイズディレクトリ内の定義ファイルを編集するようにし、インストールディレクトリ内の定義ファイルを編集しないでください。

マネージャーでのファイル名と格納場所

SNMPトラップ XML 定義ファイルは、装置ごとに作成され、マネージャーのインストール時、アップグレード時に以下のディレクトリに格納されます。

マネージャーのOS種別	絶対パス名
Windows	$INS_DIR\ESC\Manager\opt\FJSVssmgr\lib\snmpth （$INS_DIR は、マネージャーをインストールした時の「プログラムディレクトリ」です。）
Solaris OS、 Linux	/opt/FJSVssmgr/lib/snmpth

カスタマイズする際は、上記ディレクトリの SNMPトラップ XML 定義ファイルを以下のカスタマイズ用ディレクトリにコピーし、コピーしたファイルを編集してください。

マネージャーのOS種別	絶対パス名（カスタマイズ用）
Windows	$ENV_DIR\ESC\Manager\etc\opt\FJSVssmgr\current\snmpth （$ENV_DIR は、マネージャーをインストールした時の「環境設定ディレクトリ」です。）
Solaris OS、 Linux	/etc/opt/FJSVssmgr/current/snmpth

マネージャーの動作は、以下のようになります。

カスタマイズ用ディレクトリに SNMPトラップ XML 定義ファイルがある場合
カスタマイズ用ディレクトリのファイル内容に従います。
カスタマイズ用ディレクトリに SNMPトラップ XML 定義ファイルがない場合
インストールディレクトリ内のファイル内容（デフォルト）に従います。

ファイル名は、装置のトラップに含まれるエンタープライズコードの"."を"_"に置き換えたものです。

表A.1 マネージャー導入時に存在する SNMPトラップ XML 定義ファイル
装置種	ファイル名
SN200、Brocade、PRIMERGY ファイバーチャネルスイッチブレード、Brocade VDX series、PRIMERGY コンバージドスイッチブレード	1_3_6_1_4_1_1588_2_1_1_1.xml
ETERNUS SN200 MDS、 Cisco MDS	1_3_6_1_4_1_9_9_117_2.xml 1_3_6_1_4_1_9_9_289_1_3.xml 1_3_6_1_4_1_9_9_302_1_3.xml 1_3_6_1_4_1_9_9_305_1_4_3.xml 1_3_6_1_4_1_9_9_91_2.xml
McDATA	1_3_6_1_4_1_289.xml
ETERNUS DX60, DX80, DX90	1_3_6_1_4_1_211_4_1_1_126_1_60.xml
ETERNUS DX80 S2/DX90 S2	1_3_6_1_4_1_211_4_1_1_126_1_100.xml
ETERNUS DX60 S2	1_3_6_1_4_1_211_4_1_1_126_1_101.xml
ETERNUS2000 モデル50, 100, 200	1_3_6_1_4_1_211_4_1_1_126_1_30.xml
ETERNUS4000 モデル300, 500 ETERNUS8000 モデル700, 900, 1100, 2100	1_3_6_1_4_1_211_4_1_1_126_1_20.xml
ETERNUS DX400 series ETERNUS DX8000 series ETERNUS4000 モデル400, 600 ETERNUS8000 モデル800, 1200, 2200	1_3_6_1_4_1_211_4_1_1_126_1_50.xml
ETERNUS DX400 S2 series	1_3_6_1_4_1_211_4_1_1_126_1_100.xml
ETERNUS DX8000 S2 series	1_3_6_1_4_1_211_4_1_1_126_1_102.xml
ETERNUS LT20(SCSI)	1_3_6_1_4_1_11_2_36_1.xml
ETERNUS LT200	1_3_6_1_4_1_119_1_83_1_21.xml
ETERNUS LT210, LT220, LT230	1_3_6_1_4_1_119_1_83_1_1.xml 1_3_6_1_4_1_119_1_83_1_2.xml
ETERNUS LT250	1_3_6_1_4_1_211_4_1_1_126_3_5.xml
ETERNUS LT270	1_3_6_1_4_1_211_4_1_1_126_3_2.xml
ETERNUS LT270 S2	1_3_6_1_4_1_211_4_1_1_126_3_6.xml
テープ暗号化装置	1_3_6_1_4_1_2021_250_10.xml
Fibre Alliance MIB サポート装置	1_3_6_1_3_94.xml
ETERNUS NR1000	1_3_6_1_4_1_789.xml
ETERNUS VS850	1_3_6_1_4_1_2_6_190.xml
ETERNUS LT20/LT20 S2/LT40/LT40 S2/LT60/LT60 S2 (SAS/FC)	1_3_6_1_4_1_20884_10893_2_101_3.xml
ETERNUS CS2000	1_3_6_1_4_1_231_2_48_2_0.xml
ETERNUS VX700 series	1_3_6_1_4_1_211_1_21_4_1_50.xml
性能管理からのイベント	1_3_6_1_4_1_211_4_1_3_21_3.xml
Solaris OS版またはWindows版エージェントからのイベントでマルチパス関係	1_3_6_1_4_1_211_4_1_3_21_2.xml (注1)
Solaris OS版エージェントからの Safe/PRIMECLUSTER GDS、GFS シリーズのイベント	1_3_6_1_4_1_211_4_1_3_21_2_2.xml (注1)(注2)
Solaris OS版エージェントからのマルチパス関係のイベント	1_3_6_1_4_1_211_4_1_3_21_2_21.xml (注1)(注2)
Windows版エージェントからのマルチパス関係のイベント	1_3_6_1_4_1_211_4_1_3_21_2_5.xml (注1)(注2)
Windows版エージェントからの MPIO のイベント	1_3_6_1_4_1_211_4_1_3_21_2_51.xml (注1)(注2)
Linux版エージェントからの ETERNUSマルチパスドライバのイベント	1_3_6_1_4_1_211_4_1_3_21_2_3.xml (注1)(注2)
Linux版エージェントからの PRIMECLUSTER GDS、GFS シリーズのイベント	1_3_6_1_4_1_211_4_1_3_21_2_31.xml (注1)(注2)
HP-UX版エージェントからの LVM（PV-Links）のイベント	1_3_6_1_4_1_211_4_1_3_21_2_4.xml (注1)(注2)
HP-UX版エージェントからの HBA ドライバのイベント	1_3_6_1_4_1_211_4_1_3_21_2_41.xml (注1)(注2)
AIX版エージェントからのイベントでマルチパス関係	1_3_6_1_4_1_211_4_1_3_21_2_6.xml (注1)(注2)

注1: このファイルは「定義ファイルの形式」の「定義内容」のうち、動作定義（flag属性）のSystemwalker Centric Manager連携（ただし、Shell/Bat連携の制御だけでSystemwalker Centric Manager連携はできません）、および外部スクリプト連携1、外部スクリプト連携2のon/off設定だけ変更可能です。障害レベルおよびメッセージは変更できません。

注2: このファイルを更新する場合は、エージェントの同名ファイルと同じ内容に更新する必要があります。

上記以外の装置に対しても、装置のエンタープライズコードを基にXMLファイルを作成することにより、装置に対するSNMPトラップ処理が可能です。

エージェントでのファイル名と格納場所

SNMPトラップ XML 定義ファイルの格納場所は、以下のとおりです。

エージェントのOS種別	絶対パス名
Windows	$ENV_DIR\ESC\Agent\etc\snmpth （$ENV_DIR は、エージェントをインストールした時の「環境設定ディレクトリ」です。）
Solaris OS、 Linux、 HP-UX、 AIX	/etc/opt/FJSVssage/snmpth

エージェントは、起動時にこのファイルを読み込んで動作します。このため、変更した内容をエージェントに反映するには、エージェントの再起動が必要です。

ファイル名は、エージェントがマネージャーに発行するトラップのエンタープライズコードの"."を"_"に置き換えたものです。

表A.2 エージェント導入時に存在する SNMPトラップ XML 定義ファイル
サーバノード	ファイル名（注）	監視対象
Solaris OS	1_3_6_1_4_1_211_4_1_3_21_2_2.xml	Safe/PRIMECLUSTER GDS、GFSシリーズ
	1_3_6_1_4_1_211_4_1_3_21_2_21.xml	ETERNUSマルチパスドライバ
	1_3_6_1_4_1_211_4_1_3_21_2_22.xml	EMC PowerPath
	1_3_6_1_4_1_211_4_1_3_21_2_23.xml	HITACHI JP1/HiCommand Dynamic Link Manager
	1_3_6_1_4_1_211_4_1_3_21_2_24.xml	Sun MPxIO
Windows	1_3_6_1_4_1_211_4_1_3_21_2_5.xml	ETERNUSマルチパスドライバ
Linux	1_3_6_1_4_1_211_4_1_3_21_2_3.xml	ETERNUSマルチパスドライバ
Linux	1_3_6_1_4_1_211_4_1_3_21_2_31.xml	PRIMECLUSTER GDS、GFSシリーズ
HP-UX	1_3_6_1_4_1_211_4_1_3_21_2_4.xml	PV-LINK（LVMの機能）
HP-UX	1_3_6_1_4_1_211_4_1_3_21_2_41.xml	HBA ドライバ
AIX	1_3_6_1_4_1_211_4_1_3_21_2_6.xml	MPIO

注: このファイルを更新する場合は、マネージャーの同名ファイルと同じ内容に更新する必要があります。

定義ファイルの形式

定義内容

定義ファイルには、トラップの Specific Trap Type ごとに、以下の項目について動作を定義します。

項目	内容
動作定義	画面に状態変化の通知を表示する/しないイベントログを出力する/しない Systemwalker Centric Manager連携、Shell/Bat連携を行う/行わない外部スクリプト連携1を行う/行わない外部スクリプト連携2を行う/行わない
障害レベル	各イベント、Systemwalker Centric Manager連携通知のレベル (Information/Warning/Error)
メッセージ	イベントおよび Systemwalker Centric Manager 連携に出力するメッセージ

項目

内容

動作定義

画面に状態変化の通知を表示する/しない

イベントログを出力する/しない

Systemwalker Centric Manager連携、Shell/Bat連携を行う/行わない

外部スクリプト連携1を行う/行わない

外部スクリプト連携2を行う/行わない

障害レベル

各イベント、Systemwalker Centric Manager連携通知のレベル

(Information/Warning/Error)

メッセージ

イベントおよび Systemwalker Centric Manager 連携に出力するメッセージ

ノード階層

タグのノード階層は以下のようになります。

タグと属性の種類

SNMPTrapControl タグ

属性名	内容
name	装置名
ver	この定義ファイルの Version

ExternalScript1 タグ、ExternalScript2 タグ（オプション）

外部スクリプト連携を利用するときにスクリプト名を定義します。ExternalScript1 タグが外部スクリプト連携1、ExternalScript2 タグが外部スクリプト連携2 になります。

ここで定義したスクリプトは、TrapType タグや Convert タグの flag 属性で該当する連携 bit を on にすることで実行されます。

ExternalScript1 タグ、ExternalScript2 タグは、TrapType タグ定義よりも前行に定義する必要があります。

属性名	内容
name	実行するスクリプト名（フルパス指定）

TrapType タグ

Specific Trap Type 単位にそのトラップの解析動作を定義します。このタグで定義しない Type のトラップは、解析処理を行わず破棄されます。

属性名	内容
type	"ST" + Specific Trap Type 番号（10進数）
flag	イベント、Systemwalker Centric Manager連携、スクリプト連携、およびメール通知の動作を、2進数7bitで定義します。 0 は off、1 は on と解釈されます。 bit6 … Informationイベントのメール通知（注1） bit5 … 外部スクリプト連携2 bit4 … 外部スクリプト連携1 bit3 … Systemwalker Centric Manager 連携、Shell/Bat 連携（注2） bit2 … イベントログ出力 bit1 … （変更不可） bit0 … 状態変化の通知例えば、Systemwalker Centric Manager 連携だけを on にするには、flag="0001000" と記述します。なお、4bit 分しか記述していない場合、bit4、bit5、および bit6 は 0 と解釈されます。例えば、flag="1111" は、flag="0001111" と同じ意味になります。
level	イベントおよび Systemwalker Centric Manager への通知レベルを定義します。 I … Information W … Warning E … Error
msg	イベント、Systemwalker Centric Manager 連携および外部スクリプト連携で表示するメッセージを定義します。メッセージには、以下のパラメーターを含めることができます。 %d … 10進数 %x … 16進数 %s … 文字列パラメーターを含めた分、ARG タグを定義する必要があります。 % に続く文字が d、x、s 以外の場合、その % はそのまま表示されます。

注1: Informationイベントのメール通知を有効にする場合、または、WarningイベントおよびErrorイベントのメール通知を無効にする場合に、onに設定します。

注2: エージェントのイベントは Systemwalker Centric Manager に通知されないため、エージェントの定義ファイルでは Shell/Bat 連携の制御だけとなります。

ARG タグ

ARG タグは、TrapType タグの msg 属性内で指定したパラメーターとトラップデータ内の Variable Binding のインデックスの対応を定義します。この ARG タグは、msg 属性内で指定したパラメーターと同じ数分定義する必要があります。

属性名	内容
index	TrapTypeタグのmsg属性値に含まれるパラメーターのインデックス番号（0～）
VBIndex	トラップデータ内のVariable Bindingのインデックス番号（0～）

Convert タグ（オプション）

Convert タグは、トラップの INTEGER タイプのデータ値に対する文字列表現を定義します。このタグの定義は必須ではありません。例えば、トラップデータ値0がステータスOKを示す場合、<Convert val="0" name="OK"/> と定義することで、イベントメッセージに"0"ではなく"OK"という文字列を表示できます。

また、flag属性、level属性（オプション）の指定によって、TrapType タグの level 属性で指定した障害レベルを変更して通知できます（msg 属性に複数の ARG があり、それぞれの Convert タグに flag 属性または level 属性がある場合は、最後の ARG の Convert タグの指定が採用されます）。

属性名	内容
val	トラップ内の INTEGER タイプのデータ数値（10進数）
flag（オプション）	イベント、Systemwalker Centric Manager 連携、スクリプト連携、メール通知制御（2進数7bit）値は「TrapType タグ」を参照
level（オプション）	障害レベル'I' or 'W' or 'E' TrapTypeタグよりも優先される
name	val に対応する文字列

定義に存在しない値を受信した場合は、そのまま数値表現で表示されます。

MSG タグ

MSG タグは、サーバノードエージェントが監視する監視キーワードを定義します。このMSGタグは、サーバノードエージェントにだけ有効です。

Windows版エージェントの場合：id属性,src属性,type属性で監視します(key属性は無視されます)。

Windows版以外のエージェントの場合：key属性で監視します(id属性、src属性、type属性は無視されます)。

属性名	内容
key	監視する監視キーワード（Windows版以外のエージェントの場合必須）
id	監視するイベントのイベントID（Windows版エージェントの場合必須）
src	監視するイベントのソース名（Windows版エージェントの場合必須）
line	VALタグを使用する（監視イベントの部分文字列を通知情報に追加する）場合、監視イベントの行数をline属性に指定する。1行の場合、またはWindowsの場合はline属性を省略できる。
type	監視するイベントログの種類を指定する。(Windows版エージェントの場合だけ有効) System：システムログを監視する(省略値) Application：アプリケーションログを監視する

監視キーワードを変更したい場合は、このキーワードを変更します。

監視キーワードには、正規表現を指定することもできます。

新たに監視する監視キーワードを追加したい場合は、TrapTypeタグ以降を追加します。この時、Specific Trap Type 番号が重複しないように指定してください。

VAL タグ（オプション）

VAL タグは、監視イベントから文字列を抽出して通知情報に追加する方法を定義します。このVALタグはサーバノードエージェントにだけ有効です。

属性名	内容
ref	通知する情報に追加する値を( )で指定する。()内は正規表現で指定。

DTDによるID属性指定

SNMPトラップ制御では TrapType タグの type 属性を ID 属性としてサーチするため、XML 定義ファイルに以下の DTD の記述が必要です。

<!DOCTYPE SNMPTrapControl[
<!ATTLIST TrapType type ID #REQUIRED>
]>

定義ファイルサンプル

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE SNMPTrapControl
<!ATTLIST TrapType type ID #REQUIRED>
]>
<SNMPTrapControl name="SW3800" ver=1.0">
  <TrapType type="ST1" flag="111111" level="E" msg="Faulty reason: %d">
    <ARG index="0" VBIndex="0">
      <Convert val="0" flag="000110" level="I" name="sw-ok"/>
      <Convert val="1" name="sw-faulty"/>
    </ARG>
  </TrapType>
  <TrapType type="ST2" flag="000111" level="E" msg="%s: is currently in state %d">
    <ARG index="0" VBIndex="4"/>
    <ARG index="1" VBIndex="0">
      <Convert val="1" name="unknown"/>
      <Convert val="2" name="faulty"/>
      <Convert val="3" name="below-min"/>
      <Convert val="4" flag="000110" level="I" name="nominal"/>
      <Convert val="5" name="above-max"/>
      <Convert val="6" name="absent"/>
    </ARG>
  </TrapType>
</SNMPTrapControl>

例

ETERNUS SN200 series、Brocade seriesのFCポートOnline/Offlineトラップの抑止方法

ETERNUS SN200 series、Brocade seriesのFCポートOnline/Offlineトラップを抑止したい場合は、該当XML定義ファイルについて下記の箇所を変更してください。

type属性が"ST3"の<ARG index="1" VBIndex="0">内の Convertタグの val="1"およびval="2"について、flag属性を"000000"に変更。

<Convert val="1" flag="000000" level="I" swsag="4203" name="Online"/>
<Convert val="2" flag="000000" level="I" swsag="4203" name="Offline"/>