5.2.9 JP1イベント受信監視ジョブ定義情報の記述方法
JP1イベント受信監視ジョブ定義情報の記述方法を説明します。
JP1イベント受信監視ジョブ定義情報の形式,およびパラメーターを次に示します。
- 形式
[evwid=イベントID;] [evusr="イベント発行元ユーザー名";] [evgrp="イベント発行元グループ名";] [evhst="イベント発行元ホスト名";] [evipa=イベント発行元IPアドレス;] [evwms="メッセージ";] [evdet="イベント詳細情報";] [evwsv=em[:al[:cr[:er[:wr[:no[:in[:db]]]]]]];] [evwfr=任意の拡張属性名:"値";] [evtmc={n|a|n:"ファイル名"|a:"ファイル名" |d:"ファイル名"|b:"ファイル名"};] [evuid=イベント発行元ユーザーID;] [evgid=イベント発行元グループID;] [evpid=イベント発行元プロセスID;] [jpoif=マクロ変数名:引き継ぎ情報名;] [etm=n;] [fd=実行所要時間;] [ex="実行エージェント名";] [ha={y|n};] [eu={ent|def};] [evesc={no|分};] [ets={kl|nr|wr|an};] [mm={and|or};] [nmg={y|n};] [eun=待ち合わせ対象ユニット名;] [ega={exec|execdeffer|none};] [uem={y|n};]
- パラメーター
-
- evwid=イベントID;
-
受信対象のイベントIDを定義します。
指定できる値は,16進数の値で,00000000:00000000〜FFFFFFFF:FFFFFFFFです。
- evusr="イベント発行元ユーザー名";
-
受信対象のイベント基本情報中の,イベント発行元ユーザー名を定義します。
指定できる文字数は,1〜20(単位:バイト)です。
ユーザー名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
なお,ユーザー名には正規表現が使用できます。
- evgrp="イベント発行元グループ名";
-
受信対象のイベント基本情報中の,イベント発行元グループ名を定義します。
指定できる文字数は,1〜20(単位:バイト)です。
グループ名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
なお,グループ名には正規表現が使用できます。
- evhst="イベント発行元ホスト名";
-
受信対象のイベント基本情報中の,イベント発行元ホスト名を定義します。
指定できる文字数は,1〜255(単位:バイト)です。
ホスト名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
なお,ホスト名には正規表現が使用できます。
また,マクロ変数を指定できます。
- evipa=イベント発行元IPアドレス;
-
受信対象のイベント基本情報中の,イベント発行元IPアドレスを定義します。
指定できる値は,「XXX.YYY.xxx.yyy」の形式で,0.0.0.0〜255.255.255.255です。「XXX」「YYY」「xxx」「yyy」に指定できる値は,それぞれ0〜255です。
- evwms="メッセージ";
-
受信対象のイベントのメッセージ部分と比較する文字列を定義します。
指定できる文字数は,1〜1,024(単位:バイト)です。
メッセージ中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
なお,メッセージには正規表現が使用できます。
- evdet="イベント詳細情報";
-
受信対象のイベントの詳細情報部分と比較する文字列を定義します。
指定できる文字数は,1〜1,024(単位:バイト)です。
詳細情報中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
なお,詳細情報には正規表現が使用できます。
- evwsv=em[:al[:cr[:er[:wr[:no[:in[:db]]]]]]];
-
受信対象のイベント拡張属性の重大度を定義します。
-
em:「Emergency」を一致条件とします。
-
al:「Alert」を一致条件とします。
-
cr:「Critical」を一致条件とします。
-
er:「Error」を一致条件とします。
-
wr:「Warning」を一致条件とします。
-
no:「Notice」を一致条件とします。
-
in:「Information」を一致条件とします。
-
db:「Debug」を一致条件とします。
-
- evwfr=任意の拡張属性名:"値";
-
受信対象のイベント拡張属性に対して,ユーザー任意の属性名および属性値を指定している場合に,「evwfr=任意の拡張属性名:"値"」の形式で定義します。
指定できる文字数は,1〜2,048(単位:バイト)です。複数指定できます(「evwfr=任意の拡張属性名:"値";」の形式で,バイト数の合計が2,048バイトまで複数指定できます)。
値中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
なお,値には正規表現およびマクロ変数が使用できます。
- evtmc={n|a|n:"ファイル名"|a:"ファイル名"|d:"ファイル名"|b:"ファイル名"};
-
終了判定条件を定義します。省略した場合,nが仮定されます。
-
n:常に正常終了とします。
-
a:常に異常終了とします。
-
n:"ファイル名":メッセージが指定したファイルの内容と一致すれば正常終了とします。
-
a:"ファイル名":メッセージが指定したファイルの内容と一致すれば異常終了とします。
-
d:"ファイル名":詳細情報が指定したファイルの内容と一致すれば正常終了とします。
-
b:"ファイル名":詳細情報が指定したファイルの内容と一致すれば異常終了とします。
ファイル名に指定できる文字数は,1〜256(単位:バイト)です。
-
- evuid=イベント発行元ユーザーID;
-
受信対象のイベント基本情報中の,イベント発行元ユーザーIDを定義します。
指定できる値は,−1〜9,999,999,999です。
- evgid=イベント発行元グループID;
-
受信対象のイベント基本情報中の,イベント発行元グループIDを定義します。
指定できる値は,−1〜9,999,999,999です。
- evpid=イベント発行元プロセスID;
-
受信対象のイベント基本情報中の,イベント発行元プロセスIDを定義します。
指定できる値は,−1〜9,999,999,999です。
- jpoif=マクロ変数名:引き継ぎ情報名;
-
マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
このパラメーターは,「jpoif=マクロ変数名:引き継ぎ情報名;」の形式で,バイト数の合計が2,048バイトまで指定できます。
このパラメーターでは,後続のUNIXジョブ,PCジョブ,フレキシブルジョブ,HTTP接続ジョブ,およびアクションジョブに対してイベント情報を引き継げます。
- etm=n;
-
実行打ち切り時間を,実行開始時刻からの相対分で定義します。指定できる値は,1〜1,440(単位:分)です。起動条件内のジョブの場合,このパラメーターは無効になります。
- fd=実行所要時間;
-
終了遅延監視するジョブの実行所要時間を定義します。
指定できる値は,10進数の値で1〜1,440(単位:分)です。
起動条件として定義する場合,このパラメーターはジョブ実行時に無効になります。
- ex="実行エージェント名";
-
ジョブを実行する実行エージェント名を定義します。
指定できる文字数は,1〜255(単位:バイト)です。
実行エージェント名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
マクロ変数を指定できます。
- ha={y|n};
-
ジョブの実行を保留するかを定義します。省略した場合,nが仮定されます。起動条件内のジョブの場合,このパラメーターは無効になります。
-
y:保留します。
-
n:保留しません。
-
- eu={ent|def};
-
ジョブ実行時のJP1ユーザーを定義します。省略した場合,entが仮定されます。イベントジョブの場合,このパラメーターの指定は無視されます。
-
ent:ジョブネットを登録したJP1ユーザーをジョブ実行時のJP1ユーザーとします。
-
def:ジョブを所有するJP1ユーザーをジョブ実行時のJP1ユーザーとします。
-
- evesc={no|分};
-
JP1イベント受信監視ジョブが実行された直後(JP1イベントの監視を始める前)に,それ以前に発生したJP1イベントを受信監視の対象とするかどうかを定義します。省略した場合,noが仮定されます。
-
no:過去のJP1イベントを検索しません。
-
分:JP1イベント受信監視ジョブが実行された時刻から指定された時間だけさかのぼった時刻以降のJP1イベントを検索します。指定できる値は,10進数の値で,1〜720(単位:分)です。
-
- ets={kl|nr|wr|an};
-
実行打ち切り時間が経過したあとのイベントジョブの状態を定義します。省略した場合,klが仮定されます。起動条件内のジョブの場合,このパラメーターは無効になります。
-
kl:強制終了
-
nr:正常終了
-
wr:警告検出終了
-
an:異常検出終了
-
- mm={and|or};
-
指定した待ち合わせ対象ユニットとの待ち合わせ方法を指定します。
省略した場合はandが仮定されます。
-
and:すべての待ち合わせ対象ユニットが終了したら実行を開始する。
-
or:待ち合わせ対象ユニットが一つでも終了したら実行を開始する。
-
- nmg={y|n};
-
指定した待ち合わせ対象ユニットのルートジョブネットに待ち合わせる世代がないときの動作を指定します。
省略した場合はnが仮定されます。
-
y:実行を開始する。
-
n:実行を開始しない。
-
- eun=待ち合わせ対象ユニット名;
-
待ち合わせ対象ユニットとするユニットを,完全名で指定します。
待ち合わせ対象ユニットを複数指定する場合,このパラメーターを複数回指定します。最大で32個指定できます。
待ち合わせ対象ユニット名に指定できる文字数は1〜930(単位:バイト)です。
- ega={exec|execdeffer|none};
-
起動条件付きジョブネットを待ち合わせ対象に指定していて,実行世代に異常終了がある場合の動作を指定します。
省略した場合はnoneが仮定されます。
-
exec:実行を開始する。
-
execdeffer:実行を開始しない。ただし,実行世代が「繰り越し未実行」状態の場合は,実行を開始する。
-
none:実行を開始しない。
-
- uem={y|n};
-
起動条件付きジョブネットを待ち合わせ対象に指定していて,監視世代が監視未起動終了の場合の動作を指定します。
省略した場合はnが仮定されます。
-
y:実行を開始する。
-
n:実行を開始しない。
-
- 注意事項
-
イベントジョブの受信情報を引き継ぎ情報として,標準ジョブやアクションジョブのパラメーターに引き継ぐ場合で,引き継ぐ情報に「"(ダブルクォーテーションマーク)」が含まれるとき,「\」を前に付けて指定する必要があります。「\」を付けない場合,受信情報を引き継いでも「"(ダブルクォーテーションマーク)」が無視されるなどの現象が発生します。これを防止するためには,「"(ダブルクォーテーションマーク)」を含むデータを指定したとおりに引き継ぎ情報として引き継がせるオプションを設定してください。
設定については,マニュアル「JP1/Automatic Job Management System 3 構築ガイド 6.3.4 「"(ダブルクォーテーションマーク)」を含むデータをイベントジョブおよびカスタムイベントジョブの引き継ぎ情報に使用するための設定」(Windowsの場合)またはマニュアル「JP1/Automatic Job Management System 3 構築ガイド 15.3.4 「"(ダブルクォーテーションマーク)」を含むデータをイベントジョブおよびカスタムイベントジョブの引き継ぎ情報に使用するための設定」(UNIXの場合)を参照してください。