ガイド情報ファイル(jcs_guide_xxx.txt)
形式1
DESC_VERSION=1 [EV_GUIDE_数字] NUM=数字 EV_COMP_数字=属性指定:正規表現 EV_TITLE=文字列 EV_GUIDE=メッセージ [END] [EV_GUIDE_数字] NUM=数字 EV_COMP_数字=属性指定:正規表現 EV_TITLE=文字列 EV_GUIDE=メッセージ [END] :
形式2
DESC_VERSION=2 [EV_GUIDE_数字] NUM=数字 EV_COMP_数字=属性指定:正規表現 EV_TITLE=文字列 EV_FILE=ガイドメッセージファイル [END] [EV_GUIDE_数字] NUM=数字 EV_COMP_数字=属性指定:正規表現 EV_TITLE=文字列 EV_FILE=ガイドメッセージファイル [END] :
ファイル
ガイド情報ファイル(jcs_guide_xxx.txt)は,JP1/IMの動作する言語コードによって,編集するファイルが異なります。JP1/IMの動作する言語コードと,編集するガイド情報ファイルの対応を次の表に示します。
OS |
言語種別 |
JP1/IMの動作する言語コード |
編集するファイル |
---|---|---|---|
Windows |
日本語 |
jcs_guide_sjis.txt(ガイド情報ファイル) |
|
jcs_guide_sjis.txt.model (ガイド情報ファイルのモデルファイル) |
|||
英語 |
jcs_guide.txt(ガイド情報ファイル) |
||
jcs_guide.txt.model(ガイド情報ファイルのモデルファイル) |
|||
UNIX※ |
日本語 |
シフトJISコード |
jcs_guide_sjis.txt(ガイド情報ファイル) |
jcs_guide_sjis.txt.model (ガイド情報ファイルのモデルファイル) |
|||
EUCコード |
jcs_guide_euc.txt(ガイド情報ファイル) |
||
jcs_guide_euc.txt.model (ガイド情報ファイルのモデルファイル) |
|||
UTF-8コード |
/etc/opt/jp1scope/conf/jcs_guide_UTF-8.txt |
||
共有ディレクトリ/jp1scope/conf/jcs_guide_UTF-8.txt |
|||
英語 |
jcs_guide.txt(ガイド情報ファイル) |
||
jcs_guide.txt.model (ガイド情報ファイルのモデルファイル) |
注※ OSがサポートしている言語と対応するファイルだけが存在します。
言語コードに対応したガイド情報ファイルを使用してください。
格納先ディレクトリ
- Windowsの場合
-
- 物理ホストのとき
-
Scopeパス\conf\
- 論理ホストのとき
-
共有フォルダ\jp1scope\conf\
- UNIXの場合
-
- 物理ホストのとき
-
/etc/opt/jp1scope/conf/
- 論理ホストのとき
-
共有ディレクトリ/jp1scope/conf/
説明
監視オブジェクトの状態変更の契機となったJP1イベントに関するガイド情報を定義するファイルです。
このファイルで記述した内容は,JP1/IM - Viewの[ガイド]画面に表示されます。
ガイド情報ファイルの最大サイズは,1メガバイトです。
形式2は,ユーザーによって作成されたTXT形式またはHTML形式のファイルをガイドメッセージファイルとして読み込んで[ガイド]画面に表示させる場合に,記述する方法です。
複数のガイド情報が一致する場合,ガイド情報ファイルで先に記述してある情報が有効になります。
Windowsの場合,07-00のJP1/IM - Central Scopeのガイド情報ファイルは,08-00以降のJP1/IM - Managerでも読み込めます。
Windowsの場合,08-00以降のJP1/IM - Managerのガイド情報ファイルは,07-00のJP1/IM - Central Scopeでも読み込むことはできますが,DESC_VERSION=2のEV_FILE=ガイドメッセージファイルの記述は無視され,EV_GUIDE=メッセージの記述が優先されます。両方の記述がない場合はエラーとなります。
#を指定した場合,#以降は改行されるまでコメント扱いとなります。ただし,開始タグ,属性情報,終了タグの後方にコメントを記述できません。開始タグと終了タグの後方にコメントを記述した場合は,エラーとなります。また,属性値の後方にコメントを書いた場合は,属性値の一部として認識されます。
\を記述する場合,\\と記述する必要があります。\nおよび\$以外に\を記述していた場合はログが出力され,\を記述した行を無視して処理します。
定義の反映時期
ガイド情報ファイル編集後,JP1/IM - Managerを再起動,またはjco_spmd_reloadコマンドを実行することで有効になります。
記述内容
- DESC_VERSION=1 | 2
-
ガイド情報ファイルのバージョンを表しています。指定できる値は1または2です。
EV_FILEパラメーターを指定してガイドメッセージファイル呼び出す場合は,値を2にする必要があります。
DESC_VERSION=1でEV_GUIDE=メッセージとEV_FILE=ガイドメッセージファイルを同時に指定した場合,EV_FILE=ガイドメッセージファイルの記述は無視されます。
DESC_VERSION=2でEV_GUIDE=メッセージとEV_FILE=ガイドメッセージファイルを同時に指定した場合,EV_FILE=ガイドメッセージファイルの記述が優先されます。
- [EV_GUIDE_数字]
-
ガイド情報の開始タグです。[EV_GUIDE_数字]〜[END]で一つの定義ブロックとなります。このパラメーターと[END]の間に[ガイド]画面への表示対象となるJP1イベントの条件および表示するメッセージを記述します。数字は,1からガイドの数だけ1ずつ増加します。
EV_GUIDE_数字タグ内の文字列は一意にしてください。不正な文字列がある場合はログが出力され,該当個所を無視して処理します。
EV_GUIDE_数字タグ内に記述できる属性以外が記述されている場合は,該当個所を無視して処理します。
- NUM=数字
-
数字には,EV_COMP_数字のエントリー数を記述します。
- EV_COMP_数字=属性指定:正規表現
-
このパラメーターは,比較する属性の数だけ記述します。数字は,1から1ずつ増加します。複数記述した場合は,AND条件が成立すると,EV_GUIDEパラメーターで記述したメッセージを[ガイド]画面に表示します。
EV_COMP_数字の数字は,NUMで指定された範囲内の数字(1〜NUM)でない場合は,無視されます。
イベントIDは8けた表記で記述してください。なお,EV_COMP_数字の属性指定にB.IDと記述し,一致条件にイベントIDの基本部だけを指定する場合,拡張部の記述を省略できます。
例
EV_COMP_1=B.ID:00004107:00000000またはEV_COMP_1=B.ID:00004107
- 属性指定
-
次の属性を指定できます。
・JP1イベントの基本属性:指定する場合「B.属性名」と指定します。
・JP1イベントの拡張属性:指定する場合「E.属性名」と指定します。
・監視ノードの属性:指定する場合「T.MONNODEID」(監視ノードID)を指定できます(監視ノードIDは,16進数8桁で指定してください)。
- 正規表現
-
属性指定で指定した属性の内容を正規表現で記述します。正規表現には拡張正規表現を使用します。正規表現の詳細については,マニュアル「JP1/Integrated Management - Manager 導入・設計ガイド」の「付録G 正規表現」を参照してください。
- EV_TITLE=文字列
-
文字列には,[ガイド]画面のタイトルに表示される文字列を記述します。このパラメーターは,[EV_GUIDE_数字]と[END]の間に一つしか記述できません。
- EV_GUIDE=メッセージ
-
メッセージには,[ガイド]画面のガイドメッセージに表示される文字列を記述します。HTMLタグを記述すれば,[ガイド]画面に表示されるガイドメッセージをHTML形式で表示できます(記述できるHTMLタグはEV_FILEの説明文にある「表2-46 ガイドメッセージとして使用できるHTMLタグ」を参照のこと)。このパラメーターは,[EV_GUIDE_数字]と[END]の間に一つしか記述できません。
また,文字数は10,240バイト以内にしてください。10,241バイト以上記述した場合,10,241バイト以降のメッセージは,[ガイド]画面に表示されません。
なお,メッセージ中に\を記述する場合は\\,$を記述する場合は\$と記述します。メッセージ中に$B.属性名△,$E.属性名△を指定した場合,JP1イベントの属性名に対応する属性値がメッセージとして展開されます(△は半角スペースを表す)。また,$T.MONNODEID△を指定した場合は,監視ノードIDに置き換えられます(△は半角スペースを表す)。対応する属性が存在しない場合は,空に置き換えられます。
メッセージに改行を入れる場合は,\nと指定します。
- EV_FILE=ガイドメッセージファイル
-
ガイドメッセージファイルには,[ガイド]画面に表示されるガイドメッセージの内容を記述したファイルの名称をフルパスまたは相対パス(起点はScopeパス\conf\guide\,または/etc/opt/jp1scope/conf/guide/)で指定します。このパラメーターは,[EV_GUIDE_数字]と[END]の間に一つしか記述できません。
ファイル名は,パスを含めて1,024バイト以内の文字数にしてください。1,024バイトを超えた場合,JP1/IM - Managerの起動時またはJP1/IM - Viewからのガイドメッセージファイル呼び出し時にエラーとなります。
また,このパラメーターを指定する場合は,DESC_VERSIONの値を2にしてください。
ガイドメッセージファイルとして指定できるファイルの名称,拡張子はユーザー任意です。なお,ファイル名称にはご利用元で管理しやすい名称を,拡張子は表示するガイドメッセージがTXT形式であれば.txtを,HTML形式であれば.html,.htmを使用することをお勧めします。
(例)guide001_AJS2.txt,またはguide001_AJS2.htm
- ガイドメッセージファイル
-
ガイドメッセージファイルには,[ガイド]画面から表示させたい情報をTXT形式またはHTML形式で記述します。記述できる内容は,ガイド情報ファイルのEV_GUIDEで記述できる内容と同じです。なお,ガイドメッセージファイルの場合,改行を挿入して体裁を整えることもできます。
ガイドメッセージファイルに記述されている内容および構文チェックはしません。
作成したガイドメッセージファイルは,任意のフォルダに格納できますが,クラスタ構成の場合にシステムのフェールオーバーに対応するためには次のフォルダに格納することを推奨します。
・Windowsの場合
共有フォルダ\jp1scope\conf\guide\
・UNIXの場合
共有ディレクトリ/jp1scope/conf/guide/
ガイドメッセージファイルの最大サイズは,1メガバイトです。1メガバイトを超えた場合,JP1/IM - Viewの[ガイド]画面からのガイドメッセージファイル読み込み時にエラーとなります。
HTML形式のガイドメッセージファイルを作成する場合に使用できるHTMLタグおよび属性を次に示します。
表2‒46 ガイドメッセージとして使用できるHTMLタグ タグ
属性
説明
HTML
−
HTML文章であることを宣言します。このタグは必須です。
HEAD
−
HTML文章のヘッダーを宣言します。
このタグは必須です。
BODY
−
HTML文章の本文を宣言します。
このタグは必須です。
A
HREF="URL"
リンク先URLを指定します。相対パスおよび「mailto:」で始まるURLは動作保証されません。
ここで指定したリンクは[ガイド]画面(HTML形式)に表示されます。クリックするとWWWブラウザーが起動し,指定したURLにアクセスできます。
H1,H2,H3,H4,H5,H6
−
見出しを指定します。
FONT
SIZE="文字サイズ"
文字サイズを指定します。指定できる値は1〜7です。
COLOR="文字色"
文字色を指定します。指定できる色は次の16色です。
black,silver,gray,white,maroon,red,purple,fuchsia,green,lime,olive,yellow,navy,blue,teal,aqua
これ以外の文字色は動作保証されません。
B
−
文字を太字にします。
I
−
文字を斜体にします。
HR
−
罫線を引きます。
BR
−
強制的に改行します。
(凡例) −:なし
なお,このほかのHTMLタグについては動作保証していません。
- [END]
-
ガイド情報の終了タグです。
定義例
# JP1/IM-CS Guide Information File. DESC_VERSION=1 [EV_GUIDE_1] NUM=2 EV_TITLE=JP1/AJS2 業務Aの異常終了 EV_COMP_1=T.MONNODEID:0000000A EV_COMP_2=B.ID:00000111 EV_GUIDE=業務Aが異常終了しました。$E.C0 のホストで異常が発生していないか確認してください。 [END] [EV_GUIDE_2] NUM=1 EV_COMP_1=B.ID:00004107 EV_GUIDE=ジョブが異常終了しました。$E.C0 のホストで異常が発生していないか確認してください。\n以前の障害例として,ホストAではメモリ不足によりジョブが失敗した事があります。vmstatコマンドでメモリ空き容量を確認してください。 [END]