3.19.5 コマンド実行時のイベント情報引き継ぎ
コマンドの実行内容に関する次の項目は,[イベントコンソール]画面に表示されたJP1イベントの情報を変数で指定できます。
-
実行ホスト名
-
実行コマンド
-
環境変数ファイル名
この機能を使用する場合は,調査や対策が必要なJP1イベントのイベントIDやメッセージの内容を,コマンドの引数に直接入力する必要はありません。これらのイベント情報は,コマンドの引数に変数で指定できます。
|
(1) 指定できるイベント引き継ぎ情報
イベント情報引き継ぎ機能では,JP1/IM - Viewに表示されているJP1イベントのうち,ダミーイベント(イベントDBに登録されないイベント)以外を引き継げます。なお,複数のイベントに含まれる情報をまとめて引き継ぐことはできません。
引き継ぐことができるJP1イベントを次に示します。なお,これらのJP1イベントは,JP1/IM - MOなどのJP1シリーズ製品が発行するJP1イベント,ユーザープログラムが発行するJP1イベント,および相関イベントです。
-
JP1/IM - ViewがログインしているマネージャーのイベントDB,または統合監視DBに登録されているJP1イベント
-
エージェントホストのイベントDBに登録されているJP1イベント
指定できる変数名と引き継ぐイベント情報の内容を,イベント属性の種別ごとに次の表に示します。以降の表中では凡例を,次のように表記しています。
- (凡例)
-
−:該当しない
△:半角スペース
表3‒32 変数名と引き継ぐイベント情報の内容(JP1イベントの基本属性) 項番
イベント属性
変数名
引き継ぐイベント情報の内容
1
−
EVBASE
イベントの基本情報全体を,次の形式に変換した値。
「イベントID△イベント発行元ユーザー名△イベント発行元ユーザーID△イベント発行元グループ名△イベント発行元グループID△イベント発行元イベントサーバ名△イベント発行元プロセスID△イベント登録年月日△イベント登録時刻△イベント発行元ホストIPアドレス」
なお,値が設定されていない場合は,空文字に置換される。
2
B.ID
B.IDEXT
EVID
イベントIDを「基本コード:拡張コード」形式に変換した値。
基本コードおよび拡張コードは,8桁の16進数(A〜Fは大文字)で,各IDの前の0は省略される。
例えば,拡張コードが00000000の場合,「基本コード:0」となる。
3
B.ID
EVIDBASE
イベントIDを「基本コード」形式に変換した値。
8桁の16進数(A〜Fは大文字)で,IDの前の0は省略される。
4
B.TIME
EVDATE
登録時刻を「yyyy/mm/dd」形式に変換した値。JP1/IM - Viewのタイムゾーンで変換する。
5
B.TIME
EVTIME
登録時刻を「hh:mm:ss」形式に変換した値。JP1/IM - Viewのタイムゾーンで変換する。
6
B.PROCESSID
EVPID
発行元プロセスIDの値。
7
B.USERID
EVUSRID
発行元プロセスのユーザーIDの値。
8
B.GROUPID
EVGRPID
発行元プロセスのグループIDの値。
9
B.USERNAME
EVUSR
発行元ユーザー名の値。
10
B.GROUPNAME
EVGRP
発行元グループ名の値。
11
B.SOURCESERVER
EVHOST
発行元ホスト名の値。
12
B.SOURCEIPADDR
EVIPADDR
発行元IPアドレスをIPv4アドレス形式,またはIPv6アドレス形式にした文字列。※
13
B.SEQNO
EVSEQNO
イベントDB内通し番号の値。
14
B.ARRIVEDTIME
EVARVDATE
到着時刻を「yyyy/mm/dd」形式に変換した値。
15
B.ARRIVEDTIME
EVARVTIME
到着時刻を「hh:mm:ss」形式に変換した値。
16
B.SOURCESEQNO
EVSRCNO
発生元のイベントDB内通し番号の値。
17
B.MESSAGE
EVMSG
メッセージの値。該当する属性が存在しない場合,空文字に置換される。
注※
-
IPv4アドレス形式
32ビットのアドレス値を8ビット単位でピリオド(.)区切り,10進数(0〜255)で出力した形式。
例:0.64.128.255
-
IPv6アドレス形式
128ビットのアドレス値を16ビット単位でコロン(:)区切り,16進数(0000〜ffff)で出力した形式。
例:0011:2233:4455:6677:8899:aabb:ccdd:eeff
表3‒33 変数名と引き継ぐイベント情報の内容(JP1イベントの拡張属性(共通情報)) 項番
イベント属性
変数名
引き継ぐイベント情報の内容
1
E.SEVERITY
EVSEV
重大度の値。※1
Emergency,Alert,Critical,Error,Warning,Notice,Information,Debug,または重大度に設定された値。
2
E.USER_NAME
EVUSNAM
ユーザー名の値。※1
3
E.OBJECT_TYPE
EVOBTYP
オブジェクトタイプの値。※1
4
E.OBJECT_NAME
EVOBNAM
オブジェクト名の値。※1
5
E.ROOT_OBJECT_TYPE
EVROBTYP
登録名タイプの値。※1
6
E.ROOT_OBJECT_NAME
EVROBNAM
登録名の値。※1
7
E.PRODUCT_NAME
EV"PRODUCT_NAME"
プロダクト名の値。※2
8
E.OBJECT_ID
EV"OBJECT_ID"
オブジェクトIDの値。※2
9
E.OCCURRENCE
EV"OCCURRENCE"
事象種別の値。※2
10
E.START_TIME
EV"START_TIME"
開始時刻の値。※2
11
E.END_TIME
EV"END_TIME"
終了時刻の値。※2
12
E.RESULT_CODE
EV"RESULT_CODE"
終了コードの値。※2
13
E.JP1_SOURCEHOST
EV"JP1_SOURCEHOST"
発生元ホスト名の値。※2
14
−
EV"拡張属性名"※1
拡張属性名で指定された属性の値。※2属性に含まれる情報については,JP1イベント発行元の各製品のマニュアルを参照してください。
- 注※1
-
該当する属性が存在しない場合,空文字に置換されます。
- 注※2
-
該当する属性が存在しない場合,変数の文字列に置換されます。
表3‒34 変数名と引き継ぐイベント情報の内容(その他) 項番
イベント属性
変数名
引き継ぐイベント情報の内容
1
−
EV"@JP1IM_ACTTYPE"
アクション種別を示す値。
-
0:アクション対象外
-
1:コマンド
-
2:ルール
-
3:コマンドおよびルール
2
−
EV"@JP1IM_ACTCONTROL"
アクション対象かどうかを示す値。
-
0:アクション対象外
-
1:実行した
-
2:抑止した
-
3:一部抑止した
3
−
EV"@JP1IM_SEVERE"
重要イベントかどうかを示す値。
-
0:重要イベントではない
-
1:重要イベントである
4
−
EV"@JP1IM_CORRELATE"
相関イベントかどうかを示す値。
-
0:相関イベントではない
-
1:相関成立イベントである
-
2:相関不成立イベントである
5
−
EV"@JP1IM_RESPONSE"
応答待ちイベントかどうかを示す値。
-
0:応答待ちイベントではない
-
1:応答待ちイベントである
6
−
EV"@JP1IM_ORIGINAL_SEVERITY"
重大度(変更前)の値。※
(Emergency,Alert,Critical,Error,Warning,Notice,Information,Debug,または重大度に設定された値)
重大度変更機能が有効な場合だけ設定する属性。
7
−
EV"@JP1IM_CHANGE_SEVERITY"
重大度を変更したかどうかを示す値。
-
0:重大度を変更していない
-
1:重大度を変更した
8
−
EV"@JP1IM_DEALT"
対応状況を示す値。
-
0:未対処
-
1:処理済み
-
2:処理中
-
3:保留
9
−
EV"@JP1IM_RELEASE"
重要イベントを解除したかどうかを示す値。
-
0:解除されていない
-
1:解除された
10
−
EV"@JP1IM_DISMISSED"
重要イベントを削除したかどうかを示す値。
-
0:削除されていない
-
1:削除された
11
−
EV"@JP1IM_MEMO"
メモ情報の値。※
12
−
EV"@JP1IM_DISPLAY_MESSAGE"
メッセージ(変更後)の値。
表示メッセージ変更機能が有効な場合だけ設定する属性。
13
−
EV"@JP1IM_CHANGE_MESSAGE"
表示メッセージを変更したかどうかを示す値。
-
0:メッセージを変更していない
-
1:メッセージを変更した
表示メッセージ変更機能が有効な場合だけ設定する属性。
14
−
ACTHOST
マネージャーホスト名の値。
- 注※
-
該当する属性が存在しない場合,変数の文字列に置換されます。
-
なお,自動アクションで指定できるイベント引き継ぎ情報については,「5.3.4 イベント引き継ぎ情報」を参照してください。
(2) 変数の指定方法
コマンド実行機能では,引き継ぐイベント情報を変数で指定します。JP1/IM - Viewは,変数が指定されている個所をJP1イベントの情報に変換してからコマンドを実行します。なお,変数の大文字と小文字は区別されます。
以降で,変数の指定方法と変換後の文字列について説明します。
変数は,「$変数名」の形式で指定します。「$」だけを指定した場合も変数と見なされますが,変換はされません。「$」を文字として指定したい場合は,エスケープ文字「\」を「$」の前に指定してください。指定できる文字列については,「3.19.5(1) 指定できるイベント引き継ぎ情報」を参照してください。
イベント発行ホスト名に「server01」が設定されている場合の指定と変換結果の例を,次の表に示します。
項番 |
指定形式 |
変換結果 |
---|---|---|
1 |
ping $EVHOST |
ping server01 |
2 |
/\$EVHOST |
/$EVHOST |
変数の直後に半角英数字および_(アンダーバー)を指定すると,正しく変換されません。このような場合は,変数名を{}で囲んでください。
イベントID($EVIDBASE)に「100」,拡張属性EX($EV"EX")に「ABC」が設定されている場合の指定と変換結果の例を,次の表に示します。
項番 |
指定形式 |
変換結果 |
---|---|---|
1 |
$EVIDBASE abc |
100 abc |
2 |
$EVIDBASEabc |
$EVIDBASEabc※ |
3 |
${EVIDBASE}abc |
100abc |
4 |
$EVIDBASE_abc |
$EVIDBASE_abc※ |
5 |
${EVIDBASE}_abc |
100_abc |
6 |
$EV"EX" abc |
ABC abc |
7 |
$EV"EX"abc |
ABCabc |
- 注※
-
指定先がコマンドラインで実行先ホストがUNIXの場合,コマンドの実行時にOSの環境変数として解釈されるため,空文字として処理されます。
変換元の文字情報に,次に示す制御文字が含まれていた場合,その制御文字は半角スペース(0x20)に変換されて処理されます。
半角スペースに変換される制御文字:0x01〜0x1F(タブ(0x09)を除く),0x7F
例えば,$EVMSGの指定によって取得したメッセージの中に改行コード(0x0A)が含まれていた場合,改行コード(0x0A)は半角スペース(0x20)に変換されて処理されます。
- 重要
-
「$」は「\」を直前に指定することで,文字として扱われます。ただし,ファイルパスなどで「\」に続いて変数を指定したい場合は,「\」が変換されて,文字列として扱われません。この場合の回避方法を,次に示します。
- 実行コマンドに指定する場合
-
変数を引数に指定したバッチファイルを作成します。「\」を使用するコマンドラインの組み立ては,バッチファイル内で指定します。
実行コマンドの指定例:
・実行コマンド:AppTest.bat $ACTHOST
・バッチファイル:application.exe c:\work\%1\result.txt
この例では,「%1」に「$ACTHOST」を変換した値が設定されます。
- 変数をファイルパスに使用する場合
-
変数に任意のプレフィックスを付けます。
「EV"PRODUCT_NAME"」に「IM-VIEW」が設定されている場合の例を,変換できる場合とできない場合に分けて次に示します。
変数を変換できない例:
・指定例:C:\$EV"PRODUCT_NAME"
・変換結果:C:$EV"PRODUCT_NAME"
この例では,「\$」が指定されているため,「EV"PRODUCT_NAME"」が変換されません。
変数を変換できる例:
・指定例:C:\pre_$EV"PRODUCT_NAME"
・変換結果:C:\pre_IM-VIEW
この例では,「pre_」を変数の前に付けることで,「EV"PRODUCT_NAME"」が変換されます。
- 重要
-
属性値を引き継いだ場合,OSが特別な意味として取り扱う文字を,別の文字列に変換できます。これは,自動アクションでコマンドを実行する場合と同じです。特殊文字の変換については,マニュアル「JP1/Integrated Management - Manager コマンド・定義ファイルリファレンス」の「自動アクション定義ファイル(actdef.conf)」(2. 定義ファイル)の変数の記述での注意点の説明を参照してください。また,特定のASCII文字を別の文字に変換する場合は,イベント引き継ぎ情報変換設定ファイルの設定に従います。イベント引き継ぎ情報変換設定ファイルについては,マニュアル「JP1/Integrated Management - Manager コマンド・定義ファイルリファレンス」の「イベント引き継ぎ情報変換設定ファイル(event_info_replace.conf)」(2. 定義ファイル)を参照してください。
コマンドの実行内容に指定する実行コマンドには,JP1イベントの情報をURLエンコーディングした値やBase64エンコーディングした値を指定することができます。実行ホスト名および環境変数ファイルには指定できません。
指定形式を次に示します。
$変数名$エンコーディングの種類
イベント情報を引き継ぐ場合に指定できるエンコーディングの種類と指定形式の一覧を,次の表に示します。
項番 |
エンコーディングの種類 |
指定形式 |
説明 |
---|---|---|---|
1 |
URLエンコーディング |
$変数名$URLENC |
引き継ぐイベント情報をUTF-8の文字列としてURLエンコードする。 実行コマンドには,引き継ぐイベント情報をエンコードした結果の文字列が渡される。
|
${変数名$URLENC} |
|||
2 |
Base64エンコーディング |
$変数名$ENC |
引き継ぐイベント情報をBase64エンコードする。 実行コマンドには,引き継ぐイベント情報をエンコードした結果の文字列が渡される。
|
${変数名$ENC} |
|||
3 |
Base64コーディングとURLコーディングの両方 |
$変数名$ENC$URLENC |
引き継ぐイベント情報をBase64エンコードし,さらにURLエンコードする。 実行コマンドには,引き継ぐイベント情報をエンコードした結果の文字列が渡される。
|
${変数名$ENC$URLENC} |
|||
4 |
エンコーディングしない |
$変数名 |
URLエンコードもBase64エンコードもしない。 実行コマンドには,引き継ぐイベント情報がそのまま渡される。 詳細については,「3.19.5(1) 指定できるイベント引き継ぎ情報」の各表を参照してください。
|
${変数名} |
- 重要
-
エンコードの種類の直後に半角英数字,または_(アンダーバー)を指定する場合は,「変数名$エンコードの種類」を{}で囲んでください。
また,次の場合,「$変数名$エンコーディングの種類」または「${変数名$エンコーディングの種類}」は,文字列と見なされて変換されません。
-
「変数名」に該当するイベントが存在しない。
-
指定形式が誤っている。
-
指定形式と変換結果を,次の表に示します。
項番 |
指定形式 |
変換結果 |
説明 |
---|---|---|---|
1 |
$EVMSG$URLENC |
%E3%81%82 |
$EVMSGが「あ」。 |
2 |
$EVMSG$ENC |
QUJDREVGRw== |
$EVMSGが「ABCDEFG」。 |
3 |
$EVMSG$ENC$URLENC |
QUJDREVGRw%3D%3D |
$EVMSGが「ABCDEFG」。 |
4 |
$HOGE$URLENC |
$HOGE$URLENC |
$HOGEは不正な変数。 |
5 |
${EV"A0"$URLENC}abc |
${EV"A0"$URLENC}abc |
EV"A0"という属性が存在しない。 |
6 |
$EVMSG$URL |
ABCDEFG$URL |
$EVMSGが「ABCDEFG」。また,$URLは不正な変数。 |
7 |
${EVMSG$URL}abc |
${EVMSG$URL}abc |
$EVMSGが「ABCDEFG」また,$URLは不正な変数。 |
8 |
$EVMSG$ENC\$URLENC |
QUJDREVGRw==$URLENC |
$EVMSGが「ABCDEFG」。$ENCによってBase64エンコード。また,「\$」で「\」をエスケープ。 |
9 |
$EVMSG\$URLENC |
あ$URLENC |
$EVMSGが「あ」。また,「\$」で「\」をエスケープ。 |
10 |
$EVMSG$URLENC |
空文字 |
$EVMSGが空文字。 |
(3) 引き継ぎ対象イベントの指定方法
コマンドの実行内容に引き継ぐJP1イベントは,次に示す操作で指定できます。
項番 |
画面の種類 |
画面名 |
[コマンド実行]画面の起動操作※1 |
引き継ぎ対象イベント |
---|---|---|---|---|
1 |
イベント一覧 |
[イベントコンソール] |
メニュー−[表示]−[コマンド実行(イベント情報引き継ぎ)] |
[イベントコンソール]画面の次のページで選択したJP1イベント。
|
2 |
メニュー−[オプション]−[コマンド実行]※2 |
|||
3 |
ツールバー−[コマンド実行]ボタン※2 |
|||
4 |
ポップアップメニュー−[コマンド実行(イベント情報引き継ぎ)] |
|||
5 |
[関連イベント一覧(集約)] |
ポップアップメニュー−[コマンド実行(イベント情報引き継ぎ)] |
[関連イベント一覧(集約)]画面の次のテーブルで選択したJP1イベント
|
|
6 |
[関連イベント一覧(相関)] |
ポップアップメニュー−[コマンド実行(イベント情報引き継ぎ)] |
[関連イベント一覧(相関)]画面の次のテーブルで選択したJP1イベント
|
|
7 |
イベント詳細 |
[イベント詳細] |
[コマンド実行]ボタン |
画面に表示されているJP1イベント。ただし,ダミーイベントの場合は,イベント情報を引き継げない。 |
8 |
[イベント詳細(編集)] |
|||
9 |
[イベント詳細 - 関連イベント一覧(集約)] |
|||
10 |
[イベント詳細(編集) - 関連イベント一覧(集約)] |
|||
11 |
[イベント詳細 - 関連イベント一覧(相関)] |
|||
12 |
[イベント詳細(編集) - 関連イベント一覧(相関)] |
- 注※1
-
選択しているイベントが次に示す場合,[コマンド実行(イベント情報引き継ぎ)]メニューが非活性となり,選択できません。また,ダミーイベントの[イベント詳細]画面の[コマンド実行]ボタンが非活性となり,クリックできません。
・JP1イベントがない
・JP1イベントを複数選択している
・ダミーイベントを選択している
- 注※2
-
すでに[コマンド実行]画面を表示している場合,その[コマンド実行]画面が最前面に表示されます。
指定したイベントは,[コマンド実行]画面に表示されます。表示されるJP1イベントの表示項目(属性)は,[イベントコンソール画面]のイベント一覧の表示項目(属性)と同じです。表示項目(属性)については,「3.19.5(1) 指定できるイベント引き継ぎ情報」を参照してください。
[コマンド実行]画面の表示中に,JP1イベントを指定し直して[コマンド実行]画面にイベントを引き継ぐ操作をすると,表示されているJP1イベントが変更されます。また,[ユーザー環境設定]画面で表示項目を変更した場合,[コマンド実行]画面で表示されている属性値も変更されます。
- 重要
-
イベント情報を引き継ぎできないメニューやボタンをクリックしてから[コマンド実行]画面を起動した場合,引き継ぎ対象のイベントを表示できません。この場合,[コマンド実行]画面の[情報を引き継ぐ]チェックボックスはチェックされず,イベント情報は空欄で表示されます。
(4) コマンドの実行内容のプレビュー
イベント情報を引き継いだ場合,コマンドの実行前に[コマンド実行内容プレビュー]画面が表示されます。[コマンド実行内容プレビュー]画面には,変数をイベントの情報に置き換えたあとのコマンドの実行内容が表示されます。
[コマンド実行内容プレビュー]画面に表示された内容は,修正することができ,修正した内容でコマンドを実行できます。変数をイベントの情報に置き換えたあとのコマンドの実行内容のサイズが上限値を超えた場合は,超過分を切り捨てた内容が[コマンド実行内容プレビュー]画面に表示されます。コマンドの実行内容が切り捨てられた場合は,超過分を切り捨てる前の内容も確認できます。
[コマンド実行内容プレビュー]画面については,マニュアル「JP1/Integrated Management - Manager 画面リファレンス」の「2.41 [コマンド実行内容プレビュー]画面」を参照してください。
なお,履歴として保存されるのは,変数を置き換える前の値([コマンド実行]画面の値)となります。[コマンド実行内容プレビュー]画面で表示または編集した値は,履歴として残りません。