Hitachi

JP1 Version 13　JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス

表示メッセージ変更定義ファイル（jcochmsg.conf）

〈このページの構成〉

形式

DESC_VERSION=1
#表示メッセージ変更定義のコメント
def 定義名1
    [cmt コメント]
    [define {enable | disable}]
    [addflag {true | false}]
    cnd
        イベント条件
    end-cnd
    msg メッセージ
end-def
 
def 定義名2
    [cmt コメント]
    [define {enable | disable}]
    [addflag {true | false}]
    cnd
        イベント条件
    end-cnd
    msg メッセージ
end-def

ページの先頭へ

ファイル

jcochmsg.conf（表示メッセージ変更定義ファイル）

jcochmsg.conf.model（表示メッセージ変更定義ファイルのモデルファイル）

ページの先頭へ

格納先ディレクトリ

Windowsの場合
物理ホストのとき

Consoleパス\conf\chattr\ jcochmsg.conf

論理ホストのとき

共有フォルダ\jp1cons\conf\chattr\jcochmsg.conf

UNIXの場合
物理ホストのとき

/etc/opt/jp1cons/conf/chattr/jcochmsg.conf

論理ホストのとき

共有ディレクトリ/jp1cons/conf/chattr/jcochmsg.conf

ページの先頭へ

説明

表示メッセージ変更機能でメッセージの表示を変更するJP1イベントの条件と，変更後のメッセージを定義するファイルです。このファイルの定義に従い，イベント条件に一致するJP1イベントの属性を変更します。このファイルは，JP1/IM - Managerの動作する言語コードで記述してください。

このファイルの最大サイズは，22メガバイト（23,068,672バイト）です。

表示メッセージ変更定義ファイルのパラメーターには，次の2種類があります。

ページの先頭へ

定義の反映時期

イベントの表示メッセージ変更機能が有効で，次のどれかが成立する場合に有効になります

ページの先頭へ

記述内容（表示メッセージ変更定義ファイルバージョン）

DESC_VERSION

DESC_VERSIONには，表示メッセージ変更定義ファイルの形式を決定するファイルバージョンをバージョン情報として定義します。指定する値は1です。DESC_VERSIONの指定を省略した場合，ファイルバージョンを1と見なして処理します。

DESC_VERSIONは，定義ファイルの先頭行（空行，コメント行を除いた行のうちファイルのはじめに記述された行）に記載します。先頭行にファイルバージョンがなかった場合は，ファイルバージョンを1と見なして処理します。

ページの先頭へ

記述内容（表示メッセージ変更定義パラメーター）

表示メッセージ変更定義パラメーターは，図に示すとおり，定義ブロックとイベント条件ブロックで構成されています。

図2‒10　表示メッセージ変更パラメーター

[図データ]

定義ブロックは複数指定できます。指定できる定義ブロックの数は，0〜3,000個です。定義ブロックの数が最大数を超えていた場合，KAVB4640-Wのメッセージを出力し，3,001個以降の定義ブロックを無視して処理を続行します。

def〜end-def（定義ブロック）

表示メッセージ変更定義の開始と終了のパラメーターです。def〜end-defブロックは省略でき，この場合「すべてのJP1イベントのメッセージ変更をしない」と解釈します。

def以降には，表示メッセージ変更定義の定義名を記述します。「def△△△定義1△△△定義2△△△」と指定した場合，「△△定義1△△△定義2△△△」が定義名となります（△は半角スペースを表す）。

定義名は，表示メッセージ変更定義ファイル内で一意になるように1〜50バイトの文字列を指定します。指定できる文字は，制御文字（0x00〜0x1F，0x7F〜0x9F）以外の文字列です。

cmt コメント

表示メッセージ変更定義のコメントを記述します。cmtに指定されたコメントは，［表示メッセージ変更定義設定］画面のコメント欄に表示されます。cmtパラメーターは，定義ブロック内に一つだけ指定できます。このパラメーターは省略できます。コメントは1,024バイト以内で指定してください。指定できる文字は，制御文字（0x00〜0x1F，0x7F〜0x9F）以外の文字列です。

define {enable | disable}

表示メッセージ変更定義を有効にするかどうかを指定します。defineパラメーターは，定義ブロック内に一つだけ指定できます。表示メッセージ変更定義を有効にする場合は「enable」を，無効にする場合は「disable」を指定します。defineパラメーターは，省略できます。デフォルトは，「enable」です。英大文字・英小文字は区別しません。

addflag {true | false}

追加表示メッセージ変更定義を画面から追加したことを示すパラメーターで，表示メッセージ変更定義が追加表示メッセージ変更定義かどうかを指定します。そのため，表示メッセージ変更定義ファイルを編集する場合は，addflagパラメーターを指定する必要はありません。addflagパラメーターは定義ブロック内に一つだけ指定できます。追加表示メッセージ変更定義の場合は「true」を，表示メッセージ変更定義の場合は「false」を指定します。「true」を指定した場合は，［表示メッセージ変更定義一覧］画面の［種別］にアイコン（[図データ]）が表示されます。addflagパラメーターは，省略できます。デフォルトは，「false」です。英大文字・英小文字は区別しません。

cnd〜end-cnd（イベント条件ブロック）

表示メッセージを変更するJP1イベントのイベント条件を指定する，ブロックの開始と終了のパラメーターです。イベント条件ブロックは，定義ブロック内に必ず一つ指定します。省略はできません。受信したJP1イベントが，複数のイベント条件に一致する場合，表示メッセージ変更定義ファイルの先頭に近い定義ブロックが優先されます。cndおよびend-cndパラメーターの前後のタブやスペースは，無視されます。

イベント条件

表示メッセージを変更するJP1イベントの条件を指定します。イベント条件ブロックに指定できるイベント条件は0〜256件です。イベント条件とイベント条件は，AND条件となります。イベント条件は，次の形式で指定します（△は半角スペースを表す）。

　属性名△比較キーワード△オペランド[△オペランド]…

なお，半角スペースまたはタブだけで構成された行は，無視して処理を続行します。

・属性名

属性名には，比較したい属性の名称を記述します。基本属性を指定する場合は，名称の前に「B.」を付けます。拡張属性（共通情報），拡張属性（固有情報）を指定する場合は，名称の前に「E.」を付けます。英大文字・英小文字を区別します。

指定できる属性名と比較キーワードの組み合わせおよびオペランドを次に示します。

表2‒77　指定できる属性名と比較キーワードの組み合わせおよびオペランド

項番

項目

属性名

比較

キーワード

オペランド

1

イベントID

B.ID

  • と一致する

  • と一致しない

複数指定できる。複数指定では最大100件指定できる。

16進数形式で指定する。大文字・小文字は区別しない。

指定できる範囲は0〜7FFFFFFFである。

2

登録要因

B.REASON

  • と一致する

  • と一致しない

複数指定できる。複数指定では最大100件指定できる。

3

発行元プロセスID

B.PROCESSID

  • と一致する

  • と一致しない

複数指定できる。複数指定では最大100件指定できる。

指定できる範囲は，-2,147,483,648〜2,147,483,647である。

4

発行元ユーザーID

B.USERID

  • と一致する

  • と一致しない

複数指定できる。複数指定では最大100件指定できる。

指定できる範囲は，-2,147,483,648〜2,147,483,647である。

5

発行元グループID

B.GROUPID

  • と一致する

  • と一致しない

複数指定できる。複数指定では最大100件指定できる。

指定できる範囲は，-2,147,483,648〜2,147,483,647である。

6

発行元ユーザー名

B.USERNAME

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

7

発行元グループ名

B.GROUPNAME

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

8

発行元イベントサーバ名(登録ホスト名)※1

B.SOURCESERVER

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

9

送信先イベントサーバ名※1

B.DESTSERVER

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

10

メッセージ

B.MESSAGE

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

11

重大度

E.SEVERITY

と一致する

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。"Emergency"，"Alert"，"Critical"，"Error"，"Warning"，"Notice"，"Information"，"Debug"のどれかを指定できる。

12

ユーザー名

E.USER_NAME

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

13

プロダクト名

E.PRODUCT_NAME

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

14

オブジェクトタイプ

E.OBJECT_TYPE

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

15

オブジェクト名

E.OBJECT_NAME

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

16

登録名タイプ

E.ROOT_OBJECT_TYPE

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

17

登録名

E.ROOT_OBJECT_NAME

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

18

オブジェクトID

E.OBJECT_ID

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

19

事象種別

E.OCCURRENCE

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

20

終了コード

E.RESULT_CODE

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

21

発生元ホスト名※1

E.JP1_SOURCEHOST

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。

22

固有の拡張属性※3

E.xxxxxxx

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

属性名には，先頭が英大文字で英大文字，数字，およびアンダースコア（_）から構成される32バイトまでの名称を設定できる。

複数指定できる。ただし，正規表現を指定した場合は，複数指定できない。複数指定では最大100件指定できる。
注※1

統合監視DBおよびIM構成管理DBが有効な場合に，比較キーワードが，「と一致する」「と一致しない」のとき，パス表記で業務グループ名を指定できます。

統合監視DBおよびIM構成管理DBが無効な場合，および［と一致する］［と一致しない］以外を選択した場合，パス表記で業務グループ名を指定しても，ホスト名として扱われます。

jcoimdefコマンドの-ignorecasehostオプションの指定を「ON」にしている場合に，比較キーワードで［正規表現］以外を選択すると，文字列の英大文字・英小文字を区別しません。

注※2

各JP1製品固有の拡張属性も使用できます。例えば，JP1/AJSのジョブの実行ホストは，E.C0です。製品固有の拡張属性についての詳細は，JP1イベントを発行する各製品のマニュアルを参照してください。

・比較キーワード

比較キーワードには，「BEGIN（から始まる）」，「IN（と一致する）」，「NOTIN（と一致しない）」，「SUBSTR（を含む）」，「NOTSUBSTR（を含まない）」，「REGEX（正規表現）」のどれか一つを指定できます。英大文字・英小文字を区別します。

・オペランド

比較キーワードで属性値と比較する値を文字列で指定します。英大文字・英小文字を区別します。

オペランドを複数指定する場合は，一つ以上の連続した半角スペースまたはタブをオペランドとオペランドの間に挿入して区切ります。オペランドとオペランドは，OR条件となります。ただし，正規表現を指定している場合は，複数指定できません。

オペランドに，半角スペース，タブ，改行コード（CR，LF）および%を指定したい場合，次のように記述します。

項番

指定したい値

指定方法

1

タブ（0x09）

%09

2

半角スペース（0x20）

%20

3

%（0x25）

%25

4

改行コード LF（0x0a）

%0a

5

改行コード CR（0x0d）

%0d

定義フォーマットの上限チェックの場合，%20，%25は1文字として扱います。%のあとに指定する文字コードは，英大文字・英小文字を区別しません。複数選択した場合の定義例「IDが100と200に一致する」を示します。

B.ID△IN△100△200

（凡例）　△：半角スペース（0x20）

オペランドは，イベント条件1件当たり4,096バイトまで，イベント条件ブロック1件当たり4,096バイト（イベント条件ブロックに記述したオペランドの合計バイト数）まで指定できます。

msg

表示用のメッセージを記述するパラメーターです。

msgパラメーターは，定義ブロック内に必ず一つ指定します。省略はできません。

msgは1,023バイト以内で指定してください。指定できる文字は，制御文字（0x00〜0x1F，0x7F〜0x9F）以外の文字列です。

msgパラメーターが，定義ブロックの外で指定された場合，KAVB4629-Wのメッセージを出力し，msgパラメーターの指定を無視して処理を続行します。

また，msgパラメーターが次の場合，KAVB4631-Wのメッセージを出力し，エラーがあった定義ブロックを無視して処理を続行します。

  • msgパラメーターを省略した場合

  • msgパラメーターの指定が複数ある場合

  • msgパラメーターに指定したメッセージが1,023バイトを超える場合

  • msgパラメーターに指定したメッセージに制御文字が指定されていた場合

変更後のメッセージに$EVSEVのように変数を指定すると，イベントの属性値の引き継ぎができます。

指定できる変数を次に示します。

情報の種類

変数名

内容

JP1イベント基本属性に含まれる情報

EVBASE

イベント基本情報全体※1

EVID

イベントID（基本コード:拡張コード）

EVIDBASE

イベントID（基本コード）

EVDATE

イベント登録日（YYYY/MM/DD）※2

EVTIME

イベント登録時刻（hh:mm:ss）※2

EVPID

イベント発行元プロセスID

EVUSRID

イベント発行元プロセスのユーザーID

EVGRPID

イベント発行元プロセスのグループID

EVUSR

イベント発行元ユーザー名

EVGRP

イベント発行元グループ名

EVHOST

イベント発行元ホスト名

EVIPADDR

イベント発行元IPアドレス

EVSEQNO

イベントDB内通し番号

EVARVDATE

イベント到着日（YYYY/MM/DD）※2

EVARVTIME

イベント到着時刻（hh:mm:ss）※2

EVSRCNO

イベント発生元のイベントDB内通し番号

EVMSG

メッセージテキスト全体※3

EVDETAIL

イベント詳細情報全体※3，※4

JP1イベント拡張属性に含まれる情報

EVSEV

イベント拡張情報重大度（Emergency, Alert, Critical, Error, Warning, Notice, Information, Debug）※3

EVUSNAM

ユーザー名※3

EVOBTYP

オブジェクトタイプ※3

EVOBNAM

オブジェクト名※3

EVROBTYP

登録タイプ※3

EVROBNAM

登録名※3

EV"PRODUCT_NAME"

プロダクト名※5

EV"OBJECT_ID"

オブジェクトID※5

EV"OCCURRENCE"

事象種別※5

EV"START_TIME"

開始時刻※5

EV"END_TIME"

終了時刻※5

EV"RESULT_CODE"

終了コード※5

EV"JP1_SOURCEHOST"

発生ホスト名※5

EV"拡張属性名"

任意の拡張属性※5

その他

EV"@JP1IM_CORRELATE"

相関イベントフラグ

  • 相関イベントではない：0

  • 相関成立イベントである：1

  • 相関不成立イベント：2

EV"@JP1IM_ORIGINAL_SEVERITY"

イベント拡張情報重大度(変更前)

（Emergency, Alert, Critical, Error, Warning, Notice, Information, Debug）※3

EV"@JP1IM_CHANGE_SEVERITY"

重大度変更フラグ

  • 重大度を変更していない：0

  • 重大度を変更した：1

ACTHOST

マネージャーホスト名の値※3

EVENV1〜EVENV20

イベント条件の指定で，正規表現中に"( )"を指定して切り出したデータ※5

（マネージャーホストで拡張正規表現を使用している場合だけ使用できる）
注※1

JP1イベントの基本情報が次の形式に変換されて変更後のメッセージに渡されます（△は半角スペース）。

イベントID△イベント発行元ユーザー名△イベント発行元ユーザーID△イベント発行元グループ名△イベント発行元グループID△イベント発行元イベントサーバ名△イベント発行元プロセスID△イベント登録年月日△イベント登録時刻△イベント発行元ホストIPアドレス

設定されていない項目は空文字となります。

注※2

JP1/IM - Managerのタイムゾーンで変換して変更後のメッセージに渡されます。

注※3

該当する属性が存在しない場合，メッセージ変更時に変数が空文字に変換されて変更後のメッセージに渡されます。

注※4

JP1イベントの詳細属性の情報がバイナリー形式の場合は，変数が空文字に変換されて変更後のメッセージに渡されます。

注※5

該当する属性が存在しない場合，変数の文字列がそのまま変更後のメッセージに渡されます。

変数の記述での注意点

イベント引き継ぎ情報の変換機能

#コメント行

#で始まる行は，コメント扱いとなります。なお，JP1/IM - Viewから表示メッセージ変更定義を設定した場合，#のコメント行は削除されます。

ページの先頭へ

定義例

イベントIDが100または200に一致，かつ重大度がWarningで，かつ登録ホストがhostA，hostB，hostCに一致する場合に，メッセージの先頭に日付時刻を付加して「DBサーバで障害が発生しました」に変更する例を次に示します。 

DESC_VERSION=1
def 表示メッセージ変更1
    cmt コメント1
    define enable
    addflag false
    cnd
        B.ID IN 100 200
        E.SEVERITY IN Warning
        B.SOURCESERVER IN hostA hostB hostC
    end-cnd
    msg $EVDATE $EVTIME DBサーバで障害が発生しました
end-def

HntrログのメッセージID，メッセージテキスト部分を抽出する例を次に示します。

DESC_VERSION=1
def 表示メッセージ変更1
    cmt コメント1
    define enable
    addflag false
    cnd
        E.OBJECT_TYPE IN LOGFILE
        E.OBJECT_NAME SUBSTR HNTRLib2
        E.ROOT_OBJECT_TYPE IN LOGFILE
        E.PRODUCT_NAME IN /HITACHI/JP1/NT_LOGTRAP
        B.MESSAGE REGEX [0-9]{4}%20[0-9]{4}/[0-9]{2}/[0-9]{2}%20[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}[%20]+.*[%20]+[0-9A-Z]+%20[0-9A-Z]+[%20]+([^%20]+)[%20]+(.*)
    end-cnd
    msg $EVENV1 $EVENV2
end-def

特定プロダクトのメッセージの先頭に，一律で文字列を追加する例を次に示します。

DESC_VERSION=1
    def 表示メッセージ変更1
    cmt コメント1
    define enable
    addflag false
    cnd
        E.PRODUCT_NAME IN PRODUCT_A
    end-cnd
    msg [製品A]$EVMSG
end-def

ページの先頭へ

Copyright (C) 2023, 2024 Hitachi, Ltd.

Copyright (C) 2023, 2024 Hitachi Solutions, Ltd.