モニター画面呼び出し定義ファイル
形式
[@encode 文字コード] DESC_VERSION=0300 {キー定義(SUBKEYパラメーターを使用) サブキー定義 関連づけ定義 |キー定義(INTERFACEパラメーターを使用)} 呼び出しインターフェース定義
ファイル
hitachi_xxxx_mon.conf(連携製品のモニター画面呼び出し定義ファイル)
会社名_製品名_mon.conf(ユーザー定義のモニター画面呼び出し定義ファイル)
会社名_シリーズ名_製品名_mon.conf(ユーザー定義のモニター画面呼び出し定義ファイル)
格納先ディレクトリ
- Windowsの場合
-
- 物理ホストのとき
-
Consoleパス\conf\console\monitor\
- 論理ホストのとき
-
共有フォルダ\jp1cons\conf\console\monitor\
- UNIXの場合
-
- 物理ホストのとき
-
/etc/opt/jp1cons/conf/console/monitor/
- 論理ホストのとき
-
共有ディレクトリ/jp1cons/conf/console/monitor/
説明
モニター画面呼び出し定義ファイルは,インテリジェント統合管理基盤の統合オペレーション・ビューアー,またはセントラルコンソールの[イベントコンソール]画面から,イベント発行元などのモニター画面を呼び出すための定義ファイルです。この定義ファイルは,イベントIDや属性などの情報からキーを作り,イベント属性からコマンドラインパラメーターを作成するために使用します。
モニター画面呼び出し定義ファイルは,Linux版のJP1/IM - ManagerではUTF-8コード,Linux版以外のJP1/IM - ManagerではシフトJIS,またはEUCJISコードで定義する必要があります。また,標準提供ファイル名称用に「hitachi」を使用しているため,「会社名」には「hitachi」以外の名称を使用してください。
会社名が「hitachi」のモニター画面呼び出し定義ファイルは,システム標準定義情報であるため,ユーザーによる新規作成,変更,削除はできません。
なお,JP1/IMには,モニター画面呼び出し定義ファイルの記述内容をチェックするためのコマンド「jcomonitorfcheck」が用意されています。このコマンドの詳細については,「jcomonitorfcheck」(1. コマンド)を参照してください。
定義の反映時期
JP1/IM - Managerを再起動したあと,またはjco_spmd_reloadコマンドを実行すると定義内容が有効になります。なお,インテリジェント統合管理基盤またはJP1/IM - Viewのログイン中に定義を変更した場合,ログイン中のインテリジェント統合管理基盤またはJP1/IM - Viewに変更した定義内容は反映されません。変更した定義を有効にするには,インテリジェント統合管理基盤またはJP1/IM - Viewを再起動する必要があります。
記述内容
- @encode
-
モニター画面呼び出し定義ファイルで使用する文字コードを指定します。
モニター画面呼び出し定義ファイルを追加で作成する場合は,@encodeステートメントで定義ファイルの文字コードを指定してください。
項目名には,@encodeステートメントに指定した文字コードで表現できる文字を記載します。また,モニター画面呼び出し定義ファイルは,@encodeステートメントに指定した文字コードで保存します。
次の場合,統合オペレーション・ビューアーまたはJP1/IM - Viewに表示される項目名が文字化けすることがあります。
-
項目名に,@encodeステートメントに指定した文字コードで表現できない文字を使用した場合
-
@encodeステートメントに指定した文字コード,ファイルを保存した文字コード,および@encodeステートメントに指定した文字コードが不一致の場合
@encodeステートメントが存在しない場合,および@encodeステートメントのあとに指定した文字コードに誤りがある場合は,文字コードが自動判別されます。ただし,定義ファイルの内容によっては正しく判別できないおそれがあります。
指定できる文字コードは次のとおりです。
-
C
-
EUCJIS
-
SJIS
-
UTF-8
-
GB18030
- 注意事項
-
定義ファイルをUTF-8で保存する場合は,BOM(byte order mark)が付与されないように保存してください。
次の場合,エラーが出力されます。
-
C,EUCJIS,SJIS,UTF-8,およびGB18030以外の文字コードを指定した場合
-
@encodeを定義ファイルの先頭以外に記述した場合
-
@encodeのあとに文字コードを指定しなかった場合
- 注意事項
-
他製品から提供されたイベント拡張属性定義ファイルを使用する場合,定義ファイルで使用されている文字コードと,@encodeステートメントに指定する文字コードが一致していることを確認してください。また,定義ファイルを転送して配置する際は,定義ファイルの文字コードを変換しないようにしてください。
-
- DESC_VERSION=0300
-
テーブルバージョンレコードです。
- キー定義
-
モニター画面の呼び出し時にイベント属性中で固定的にキーとなる項目を定義します。キーとなる項目は次の三つです。
-
イベントID
-
プロダクト名
-
バージョン
それぞれの属性の組み合わせによって,動作やサブキーへのリンクを定義します。
- 形式
-
DEF_KEY PRODUCT_NAME="プロダクト名"
EVENT_ID=イベントID
[VERSION=バージョン|ALL]
{SUBKEY=サブキー
|INTERFACE=インターフェース名}
- 引数
-
・PRODUCT_NAME="プロダクト名"
/HITACHI/JP1/AJSなどの製品名を表す文字列です。拡張属性「PRODUCT_NAME」に設定する値と同一のものを指定します。
・EVENT_ID=イベントID
8けたの16進数値文字列で,IDの基本部だけを指定します。拡張部は無視されます。JP1/SES形式のイベントに設定されている拡張部を含める場合は,サブキーを使用してください。
・VERSION=バージョン
ここで指定したバージョンは,JP1イベントの拡張属性「ACTION_VERSION」と比較されます。バージョンとして使用できる文字は,半角の数字(0〜9),英字(A〜Z),「/」,「-」です。英字の大文字と小文字は区別されません。
一つのバージョンは8バイト以内で指定します。バージョンの範囲を指定する場合は,開始バージョンと終了バージョンの両方を「-」で区切って指定します。その場合,区切りとなる「-」の前後に一つ以上の空白が必要です。
ほかのキー定義で指定したバージョンと重複するバージョンは指定できません。
・SUBKEY=サブキー
サブキーの名称を記述します。このパラメーターとINTERFACEパラメーターは,どちらかを指定できます。
SUBKEYパラメーターを指定した場合は,SUBKEYに指定したサブキー名に対応したサブキー定義,関連づけ定義が必要です。
・INTERFACE=インターフェース名
インターフェースの名称を記述します。定義するキーに対して,モニター画面起動時のインターフェースを一つだけ指定します。このパラメーターとSUBKEYパラメーターは,どちらかを指定できます。
INTERFACEパラメーターを指定した場合はサブキー定義,関連づけ定義は使用できません。
- 注意事項
-
・バージョンの比較は昇順で実行されます。開始バージョンよりも終了バージョンの方が小さい場合は,エラーは発行されませんが,そのキー定義自体が無視されます。
・「PRODUCT_NAME」に指定する値は,JP1イベントの拡張属性「PRODUCT_NAME」に指定する値と同じにする必要があります。
-
- サブキー定義
-
サブキー定義は,モニター画面の呼び出し時に固定キーからリンクされ,イベント属性をキーとして登録します。
- 形式
-
DEF_SUBKEY
NAME=サブキー名
KEYS=属性名1 [, 属性名2[,属性名3[,属性名4]]]
- 引数
-
・NAME=サブキー名
サブキーの名称を指定します。名称は,空白や制御文字を含まない16バイト以内の半角英数字文字列で指定します。大文字と小文字は区別されません。
・KEYS=属性名1 [, 属性名2[,属性名3[,属性名4]]]
属性名の指定形式を次に示します。
表2‒67 属性名の指定形式 指定形式
値の形式
意味および内容
B.ARRIVEDTIME
13けたの10進数文字列
到着時刻(UTC1970年1月1日00:00:00からのミリ秒数)
B.DESTSERVER
文字列
送信先イベントサーバ名
B.GROUPNAME
文字列
発行元グループ名
B.IDBASE
8けたの16進数文字列
イベントIDの基本部
B.IDEXT
8けたの16進数文字列
イベントIDの拡張部
B.PROCESSID
10進数文字列
発行元プロセスID
B.SEQNO
10進数文字列
DB内通し番号
B.SOURCESEQNO
10進数文字列
発行元別通し番号
B.SOURCESERVER※
文字列
発行元イベントサーバ名
B.TIME
13けたの10進数文字列
登録時刻(UTC1970年1月1日00:00:00からのミリ秒数)
B.USERNAME
文字列
発行元ユーザー名
B.MESSAGE
文字列
メッセージ
E.JP1_SOURCEHOST※
文字列
発生元ホスト名
E.xxxxxxx
文字列
拡張属性
- 注※
-
発行元イベントサーバ名(B.SOURCESERVER),発生元ホスト名(E.JP1_SOURCEHOST)には業務グループ名を使用できません。業務グループ名を指定した場合,ホスト名として扱われます。
- 関連づけ定義
-
サブキーの値とインターフェースの関連づけを定義します。
- 形式
-
DEF_IF_RELATION
SUBKEY_NAME=サブキー名
{ VALUE1=" 属性値1"[[ VALUE2=" 属性値2"]…]
|KEY_DEFAULT }
IF_NAME=インターフェース名
- 引数
-
・SUBKEY_NAME=サブキー名
サブキーの名称を指定します。名称は,空白や制御文字を含まない16バイト以内の半角英数字文字列で指定します。大文字と小文字は区別されません。
・VALUEn=" 属性値"
nは,サブキー定義のKEYSパラメーターで指定した属性の並び順に1〜4の数です。キーの値は完全に一致させる必要があります。値に正規表現などは使用できません。指定できる属性の一覧と指定形式については,サブキー定義の説明を参照してください。
VALUE1,VALUE2,…のすべての属性が完全に一致しないJP1イベントは,「KEY_DEFAULT」で指定したインターフェースとなります。
・KEY_DEFAULT
VALUE1,VALUE2,…に指定した値と一致しないケースをインターフェースと関連づける際に,VALUE1,VALUE2,…の代わりに指定します。
・IF_NAME=インターフェース名
サブキー値が一致した場合に呼び出すインターフェース名称を指定します。インターフェース名称は,空白や制御文字を含まない16バイト以内の半角英数字文字列で指定します。大文字と小文字は区別されません。
- 呼び出しインターフェース定義
-
モニター画面呼び出し時のインターフェースを定義します。
- 形式
-
DEF_MTR_CALL
NAME=インターフェース名
EXEC_ID=アプリケーション実行定義識別子
PATH="コマンド引数"
[PARAM= 属性名1[,属性名2…]]
- 引数
-
・NAME=インターフェース名
インターフェースの名称を指定します。名称は,空白や制御文字を含まない16バイト以内の半角英数字文字列で指定します。大文字と小文字は区別されません。
・EXEC_ID=アプリケーション実行定義識別子
アプリケーション実行定義識別子を指定します。識別子には,ビューアー上のアプリケーション実行定義ファイルで定義したIDを指定します。
EXEC_IDパラメーターには「"default_browser"」を指定してデフォルトのブラウザーを起動できます。また,EXEC_IDパラメーターに「"default_browser"」を指定する場合は,PATHパラメーターにURLを記載します。
なお,「"jco_"」で始まる文字列はアプリケーション実行定義識別子として予約されているため,使用できません。
・PATH="コマンド引数"
EXEC_IDで指定した実行形式ファイルに渡すコマンド引数を指定します。EXEC_IDで指定した実行形式ファイル名とここで指定した引数によってコマンドラインが構成されます。例えば,次のようなコマンドラインがあるとします。
"app.exe arg1 arg2"
コマンド引数には,この「arg1」「arg2」の部分を指定します。
PATHには,ビューアーの動作環境属性およびイベント属性値で置換できる予約キーワードを指定できます。置き換えキーワードを次に示します。
表2‒68 置き換えキーワード キーワード
置換する語句
%JCO_JP1USER%
インテリジェント統合管理基盤またはセントラルコンソールのログインユーザー名
%JCO_INSTALL_PATH%※
ビューアーのインストールフォルダ名
%IM_EVC_PARAMETER_n%
PARAMで指定したイベント属性値に置き換える
(nは1以上の整数)
%IM_EVC_LANGUAGE%
言語環境に応じて「Japanese」または「English」に置き換える
- 注※
-
インテリジェント統合管理基盤の場合は置き換えされません。
・PARAM=属性名1 [, 属性名2…]
イベント属性値で置き換える場合のイベント属性を属性名で指定します。属性名には,指定した順に1から順序番号が付けられます。順序番号は,置き換えキーワードの「n」に当たります。
複数のイベント属性を指定する場合は,「,」で区切って指定します。例を示します。
B.EXTID,E.A0
指定できるイベント属性は,基本属性の一部と拡張属性です。指定できる属性と指定形式については,サブキーの説明を参照してください。
定義例
WindowsのイベントログをトラップしたJP1イベントからモニター画面を呼ぶ場合の例を示します。
- 注
-
この例では,説明のために行頭に行番号を入れて示しています。
- 1行目
-
定義ファイルの文字コードで,文字コードが「UTF-8」であることを示します。
- 2行目
-
「DESC_VERSION=0300」は,このファイルの記述形式のバージョンが「0300」であることを示します。
- 3〜5行目
-
コメント行です。動作バージョンの適用範囲を含めることをお勧めします。
- 6行目
-
キー定義レコードで,プロダクト名が「/HITACHI/JP1/NTEVENT_LOGTRAP」,イベントIDが「00003A71」の場合に,サブキー「SAMPLE」を使用して,呼び出すモニター画面を決定することを意味します。
- 7行目
-
サブキー定義レコードで,サブキー名を「SAMPLE」として,拡張属性「PRODUCT_NAME」と,拡張属性「A5」(WindowsのイベントログのID)を使用することを宣言します。
- 8行目
-
関連づけ定義レコードで,サブキーに設定した「E.A5」の値が「8010」と一致した場合,インターフェース「NETM_DM」を使用してモニター画面を表示することを意味します。
- 9行目
-
呼び出しインターフェース定義レコードです。インターフェース名称を「NETM_DM」とし,アプリケーション実行定義識別子が「HITACHI_NETM_DM」で定義されているコマンドに引数として「netmdm_argument」を渡して実行することを意味します。