7.2.4　対処アクションの自動実行

〈この項の構成〉

(1)　自動対処アクション定義オブジェクト

(1)　自動対処アクション定義オブジェクト

機能

自動対処アクション定義の情報を表すjsonオブジェクトです。このオブジェクトのサイズは10MB未満までに制限されています。

形式

{
  "meta":{
    "version":"バージョン情報"
  },
  "actions":[
    {"actionGroup":"アクショングループ",
     "actionId":"アクションID",
     "label":"アクション名",
     "description":"コメント",
     "valid":"有効/無効",
     "conditions":[
       {"type":"種別",
        "key":"属性名",
        "ope":"オペレーター",
        "val":["属性値",．．．]
       },
       …
     ],
     "action":{
       "type":"アクション種別",
       "params":"アクション内容"
     }
    },
  …
  ]
}

上記の定義内の項目で文字列を指定する場合，「"」，「\」を通常の文字として含める場合は，直前に「\」を付けて「\"」「\\」とします。

定義

メンバー

メンバーを次の表に示します。

表7‒25　自動対処アクション定義オブジェクトのメンバー
項番	メンバー名			データ型	指定要否	説明
1	`meta`			object	必須	対処アクションの自動実行機能の全体に関わる共通情報を設定するオブジェクト
2		`version`		string	必須	バージョンを指定します。固定値として「1」を指定します。
3	`actions`			object[]	任意	対処アクションを実行する契機となる条件や対処アクションの実行内容を設定する自動対処アクション設定の配列指定できる件数は，0〜1,000件（デフォルト値）です。
4		`actionGroup`		int	必須	対処アクショングループの番号を0〜9の整数で指定します。対処アクショングループの数字の大小は，実行条件判定の優先順位および対処アクションの実行条件とは関係ありません。グループごとに1つの対処アクションの実行を指定できるため，1つのシステム状況の変化に対して，最大10件の対処アクションを同時に実行できます。
5		`actionId`		int	必須	自動対処アクション設定ごとに一意に割り振るアクションIDを指定します。指定できる値は，0〜2,147,483,647の整数です。
6		`label`		string	必須	自動対処アクション設定を識別するためのアクション名を1〜50バイトの文字列で指定します。制御文字（0x00〜0x1F，0x7F〜0x9F）以外の文字を指定できます。
7		`description`		string	任意	自動対処アクション設定に対するコメント（実行する対処アクションの説明や解説文）を1〜1,040バイトの文字列で指定します。制御文字（0x00〜0x1F，0x7F〜0x9F）以外の文字を指定できます。この項目は，対処アクションの自動実行には影響しません。
8		`valid`		boolean	任意	該当する自動対処アクション設定の有効/無効を指定します。 true：有効 false：無効省略時は「true」が仮定されます。
9		`conditions`		object[]	必須	対処アクションを実行する契機となる条件を指定します。指定できる条件数は1〜256件です。複数の実行条件を指定した場合，すべてのイベント条件に合致（AND条件）したときに，実行条件に一致したと判定されます。
10			`type`	string	必須	実行条件の種別を指定します。固定値として「event」を指定します。
11			`key`	string	必須	実行条件の属性名を指定します。指定できる属性名を次に示します。 B.ID（イベントID） B.REASON（登録要因） B.PROCESSID（発行元プロセスID） B.USERID（発行元ユーザーID） B.GROUPID（発行元グループID） B.TIME（登録時刻） B.ARRIVEDTIME（到着時刻） B.USERNAME（発行元ユーザー名） B.GROUPNAME（発行元グループ名） B.SOURCEIPADDR（発行元IPアドレス） B.SOURCESERVER（発行元イベントサーバ名） B.MESSAGE（メッセージ） E.START_TIME（開始時刻） E.END_TIME（終了時刻） E.PRODUCT_NAME（プロダクト名） E.OBJECT_TYPE（オブジェクトタイプ） E.OBJECT_NAME（オブジェクト名） E.ROOT_OBJECT_TYPE（登録名タイプ） E.ROOT_OBJECT_NAME（登録名） E.OBJECT_ID（オブジェクトID） E.OCCURRENCE（事象種別） E.USER_NAME（ユーザー名） E.RESULT_CODE（終了コード） E.SEVERITY（重大度） E.*（固有の拡張属性） E.@JP1IM_DISPLAY_MESSAGE（メッセージ（変更後））
12			`ope`	string	必須	keyに指定した属性名の比較条件を指定します。比較条件には，次のどれかを指定できます。 BEGIN（から始まる） IN（と一致する） NOTIN（と一致しない) SUBSTR（を含む） NOTSUBSTR（を含まない） REGEX（正規表現）属性名ごとに指定できる比較条件については，下記の「■実行条件に指定できる設定の組み合わせ」の表を参照してください。
13			`val`	string[]	必須	keyに指定した属性名の比較値（文字列）を指定します。英小文字・英大文字を区別します。比較値に正規表現を指定していない場合，複数指定できます（最大100個）。複数指定した場合，どれかに一致（OR条件）したときに，実行条件に一致したと判定されます。比較値には，次の条件を満たす文字列を指定できます。比較値1個当たり4,096バイトまで，実行条件1件につき合計4,096バイト（実行条件に記述した比較値の合計バイト数）までの文字列 keyに指定した属性名の比較値属性名ごとに指定できる比較条件については，下記の「■実行条件に指定できる設定の組み合わせ」の表を参照してください。
14		`action`		object	必須	実行条件に一致した場合に実行する内容を設定するオブジェクト
15			`type`	string	必須	実行するアクションの種別を指定します。 cmd：OSコマンドを実行する場合に指定します。 restapi：REST APIを実行する場合に指定します。
16			`params`	object	必須	実行するアクションの内容を指定します。この項目には，イベント引き継ぎ情報を含む値を指定できます。アクションの種別が「cmd」の場合指定できるメンバーについては，下記の「■typeがcmdの場合に指定できるメンバー」の表を参照してください。アクションの種別が「restapi」の場合指定できるメンバーについては，下記の「■typeがrestapiの場合に指定できるメンバー」の表を参照してください。

■実行条件に指定できる設定値の組み合わせ

key（属性名）	種別	ope（比較条件）	val（比較値）
B.ID （イベントID）	数値	IN（と一致する） NOTIN（と一致しない）	イベントIDを指定する。大文字・小文字を区別しない。指定できる範囲は，0〜7FFFFFFFFである。イベントID基本部またはイベントID拡張部が8桁未満の値であった場合，先頭を0で埋め，8桁の文字列とする。
B.REASON （登録要因）	数値		登録要因を指定する。指定できる範囲は，-2,147,483,648〜2,147,483,648である。
B.PROCESSID （発行元プロセスID）	数値		発行元アプリケーションのプロセスIDを指定する。指定できる範囲は，-2,147,483,648〜2,147,483,648である。
B.USERID （発行元ユーザーID）	数値		発行元プロセスのユーザーID（数値）を指定する。指定できる範囲は，-2,147,483,648〜2,147,483,648である。
B.GROUPID （発行元グループID）	数値		発行元プロセスのグループID（数値）を指定する。指定できる範囲は，-2,147,483,648〜2,147,483,648である。
B.TIME （登録時刻）	時刻	REGEX（正規表現）	JP1イベントが発行元ホストのイベントDBに登録された時刻を指定する。 YYYYMMDDhhmmssの形式で正規表現で指定する。
B.ARRIVEDTIME （到着時刻）	時刻	REGEX（正規表現）	JP1イベントが発行元ホストのイベントDBに到着した時刻を指定する。 YYYYMMDDhhmmssの形式で正規表現で指定する。
B.USERNAME （発行元ユーザー名）	文字列	BEGIN（から始まる） IN（と一致する） NOTIN（と一致しない） REGEX（正規表現）	発行元プロセスのユーザー名を指定する。
B.GROUPNAME （発行元グループ名）	文字列		発行元プロセスのグループ名を指定する。
B.SOURCEIPADDR （発行元IPアドレス）	文字列		発行元イベントサーバに対応するIPアドレスを指定する。 IPアドレスの指定形式については，下記の「■アクションの実行条件に指定できる値」の表を参照してください。
B.SOURCESERVER （発行元イベントサーバ名）	文字列		JP1イベントが発生したホストのホスト名（イベントサーバ名）を指定する。
B.MESSAGE （メッセージ）	文字列		イベント基本属性のメッセージを指定する。
E.START_TIME （開始時刻）	文字列	REGEX（正規表現）	実行開始または再実行開始の時刻を指定する。通算秒の正規表現指定で指定する。
E.END_TIME （終了時刻）	文字列	REGEX（正規表現）	実行終了の時刻を指定する。通算秒の正規表現指定で指定する。
E.PRODUCT_NAME （プロダクト名）	文字列	BEGIN（から始まる） IN（と一致する） NOTIN（と一致しない） SUBSTR（を含む） NOTSUBSTR（を含まない） REGEX（正規表現）	JP1イベントを発行したプログラムの名称を指定する。
E.OBJECT_TYPE （オブジェクトタイプ）	文字列		JP1イベントのオブジェクトの種類を指定する。
E.OBJECT_NAME （オブジェクト名）	文字列		JP1イベントのオブジェクト名を指定する。
E.ROOT_OBJECT_TYPE （登録名タイプ）	文字列		JP1イベントの登録名タイプを指定する。
E.ROOT_OBJECT_NAME （登録名）	文字列		JP1イベントの登録名を指定する。
E.OBJECT_ID （オブジェクトID）	文字列		JP1イベントのオブジェクトIDを指定する。
E.OCCURRENCE （事象種別）	文字列		JP1イベントの事象種別を指定する。
E.USER_NAME （ユーザー名）	文字列		JP1イベントを発行したユーザー名を指定する。
E.RESULT_CODE （終了コード）	文字列		終了コードを指定する。
E.SEVERITY （重大度）	文字列	IN（と一致する） REGEX（正規表現）	JP1イベントの重大度を指定する。 opeにIN（と一致する）を指定した場合，"Emergency"（緊急），"Alert"（警戒），"Critical"（致命的），"Error"（エラー），"Warning"（警告），"Notice"（通知），"Information"（情報），"Debug"（デバッグ）の中から指定する。
E.* （固有の拡張属性）	文字列	BEGIN（から始まる） IN（と一致する） NOTIN（と一致しない） SUBSTR（を含む） NOTSUBSTR（を含まない） REGEX（正規表現）	keyにE.*形式で指定した属性名の値を指定する。
E.@JP1IM_DISPLAY_MESSAGE （メッセージ（変更後））	文字列		JP1イベントのIM属性のメッセージを指定する。

■アクションの実行条件に指定できる値

発行元IPアドレスのイベント条件には，IPv4アドレスの条件に加え，IPv6アドレスの条件をIPv6アドレス表記で指定できます（IPv6表記の英字部分は，英小文字で指定してください）。

発行元IPアドレスのイベント条件に指定できるIPアドレスの条件を次に示します。

発行元IPアドレス		指定例	指定可否
IPv4アドレス		`11.22.33.44`	可
IPv6アドレス		`0011:2233:4455:6677:8899:aabb:cccdd:eeff`	可
		`0011:2233:4455:6677:8899:AABB:CCDD:EEFF`	不可
		`2012:7:8::a:b`	不可
特殊なIPv6アドレス	IPv4射影アドレス	`::ffff:11.22.33.44`	不可
特殊なIPv6アドレス	IPv6射影アドレス	`::11.22.33.44`	不可

■typeがcmdの場合に指定できるメンバー

メンバー名	データ型	指定要否	説明
`host`	string	必須	コマンドの実行先ホスト名を1〜255バイトの範囲で指定します。
`cmd`	string	必須	実行コマンドと引数を1〜4,096バイトの範囲で指定します。コマンド名に空白を含む場合は「`"`」（ダブルクォーテーション）で囲みます。
`envFile`	string	任意	実行先ホストの環境変数ファイルの絶対パスを1〜255バイトの範囲で指定します。環境変数ファイルについては，「環境変数ファイル（任意のファイル名）」（2.　定義ファイル）を参照してください。

メンバー名

データ型

指定要否

説明

host

string

必須

コマンドの実行先ホスト名を1〜255バイトの範囲で指定します。

cmd

string

必須

実行コマンドと引数を1〜4,096バイトの範囲で指定します。

コマンド名に空白を含む場合は「"」（ダブルクォーテーション）で囲みます。

envFile

string

任意

実行先ホストの環境変数ファイルの絶対パスを1〜255バイトの範囲で指定します。

環境変数ファイルについては，「環境変数ファイル（任意のファイル名）」（2.　定義ファイル）を参照してください。

■typeがrestapiの場合に指定できるメンバー

メンバー名	データ型	指定要否	説明
`method`	string	必須	REST APIのメソッドを指定します。
`url`	string	必須	REST APIのURLを指定します。ホスト名を含むURLを指定する場合，ホスト名は`hosts`ファイルやDNSに登録し，JP1/IM - ManagerホストのOS上で名前解決できるようにしてください。`jp1hosts`ファイルおよび`jp1hosts2`ファイルの設定は参照されません。
`headers`	object	必須	次の形式で，REST APIのリクエストヘッダーを指定します。 `{` `"`要素名1`":"`要素の値1`",` `"`要素名2`";"`要素の値2`"` `}`
`body`	string	任意	任意の文字列の形式で，REST APIのリクエストボディーを指定します。

指定例

{
  "meta":{
    "version":"1"
  },
  "actions":[
    {"actionGroup":0,
     "actionId":"0",
     "label":"イベント異常時_資料採取用",
     "description":"特定のイベントIDで異常検知時に資料採取を実行",
     "valid":true,
     "conditions":[
       {"type":"event",
        "key":"B.ID",
        "ope":"IN",
        "val":["00004860","00004861"]
       },
       {"type":"event",
        "key":"E.SEVERITY",
        "ope":"IN",
        "val":["Error","Emergency"]
       }
     ],
     "action":{
       "type":"cmd",
       "params":{
         "host":"${event:EVHOST:}",
         "cmd":"\"C:\\Program Files (x86)\\Hitachi\\JP1IMM\\tools\\jim_log\" -f C:\\temp -q",
         "envFile":"C:\\tmp\\envFile.txt"
       }
     }
    }
  ]
}

ページの先頭へ

7.2.4 対処アクションの自動実行

(1) 自動対処アクション定義オブジェクト

7.2.4　対処アクションの自動実行

(1)　自動対処アクション定義オブジェクト