Hitachi

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

自動アクション定義ファイル（actdef.conf）

〈このページの構成〉

形式

[#自動アクション定義ファイルバージョン]
[DESC_VERSION=バージョン情報]
 
[#自動アクション状態監視パラメーター]
cmn
    [sta {true|false}]
end-cmn
 
[#自動アクション定義パラメーター]
act アクション名
    [prm パラメーターグループ]
    [cmt コメント]
    aid アクションID
    [valid true|false]
    eid イベントID
 
    cnd
        イベント条件
    end-cnd
 
    [usr ユーザー名]
    [hst {実行ホスト名|グループ名|業務グループ名|監視グループ名}]
    [{cmd アクション|rul}]
    [var 環境変数ファイル名]
 
    [det 抑止時間]
    [ret 遅延監視時間]
end-act

ページの先頭へ

ファイル

actdef.conf（自動アクション定義ファイル）

actdef.conf.model（自動アクション定義ファイルのモデルファイル）

ページの先頭へ

格納先ディレクトリ

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

Consoleパス\conf\action\

論理ホストのとき

共有フォルダ\jp1cons\conf\action\

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

/etc/opt/jp1cons/conf/action/

論理ホストのとき

共有ディレクトリ/jp1cons/conf/action/

ページの先頭へ

説明

JP1/IMの自動アクション機能で，アクションを実行する条件と，アクションとして実行するコマンドについて定義するファイルです。このファイルは，JP1/IM - Managerの動作する言語コードで記述してください。

自動アクション定義ファイルの最大サイズは，22（23,068,672バイト）メガバイトです。

自動アクション機能はファイルの定義に従い，特定の条件を満たすJP1イベントを受信した時に，自動的にコマンドを実行します。

各行のアクションの定義をパラメーターといいます。自動アクション定義ファイルのパラメーターには，次の3種類があります。

自動アクション定義ファイルバージョンおよび自動アクション状態監視パラメーターは，自動アクション定義パラメーターの前に記述してください。自動アクション定義パラメーターの後ろに，自動アクション定義ファイルバージョンおよび自動アクション状態監視パラメーターを記述した場合，定義内容は無効になります。

また，自動アクション定義ファイルバージョンおよび自動アクション状態監視パラメーターを，複数回定義した場合，最初の定義を有効，2回目以降の定義を無効とします。

定義の記述

  • パラメーターの各単語は，半角スペースまたはタブで区切ります。

  • 各行の先頭のパラメーター名の前の半角スペース，タブは無視されます。

  • 「#」で始まる行は，コメントになります。ただし「#」の前に文字列が入っている場合は，コメント行として扱いません。

  • アクション定義で設定できるパラメーター名は，小文字で指定してください。大文字を含むパラメーター名を指定した場合，無効なパラメーターとして定義エラーとなります。

アクションの優先度

受信したJP1イベントが，複数の自動アクション定義の実行条件と一致する場合，（後述するパラメーターグループごとに）最も優先順位の高い自動アクションが一つだけ実行されます。自動アクションの優先順位は，次の規則によって決まります。

  • 自動アクション定義ファイルで前に記述されている（GUIでは［アクション設定］の画面で上に表示されている）自動アクションが優先されます。

アクションの優先度は，共通定義で変更できます。自動アクションの優先順位については，マニュアル「JP1/Integrated Management 2 - Manager 導入・設計ガイド」の「6.3.2　実行条件の優先度」を参照してください。

パラメーターグループとAND条件

それぞれの自動アクション定義パラメーターは，パラメーターグループに属します。パラメーターグループとは，自動アクション実行の条件を判定する単位です。パラメーターグループによって，一つのJP1イベントで複数のアクションを実行する場合や，複数の条件を満たすときにアクションを実行する場合など，複雑な条件を指定できます。

一つのJP1イベントがJP1/IMのマネージャーホストに届くと，パラメーターグループごとに，優先順位の順に自動アクション定義パラメーターと実行条件を比較します。実行条件が一致する場合は，パラメーターグループごとに優先順位の最も高い自動アクション定義パラメーターが一つだけ実行されます。

パラメーターグループに「&」を指定すると，前の行に定義した自動アクション定義パラメーターとのAND条件となります。自動アクション定義パラメーターをAND条件として指定すると，すべての条件が満たされたときにアクションが実行されます。

指定内容の確認

作成した定義ファイルは，jcamakeaコマンドを使って定義ファイルの定義内容を確認してください。

ページの先頭へ

定義の反映時期

自動アクションの定義は，JP1/IM - Managerの起動時，JP1/IM - Viewの［アクション設定］画面の［適用］ボタンをクリックして定義を有効にしたとき，またはjcachangeコマンドを実行して定義を再読み込みしたときに有効になります。

jcachangeコマンドを実行して定義を再読み込みする場合は，jcachangeコマンドを実行する前にjcamakeaコマンドを実行して定義に誤りがないことを確認してください。

ページの先頭へ

記述内容（自動アクション定義ファイルバージョン）

自動アクション定義ファイルバージョンに記述する項目について説明します。

DESC_VERSION=バージョン情報

自動アクション定義ファイルのフォーマットのバージョンを定義します。この定義は，自動アクション定義ファイルの先頭行（空行，コメント行を除いた行のうちファイルのはじめに記述された行）に記載します。先頭行以外に記載した場合，定義エラーとなります。

表2‒13　自動アクション定義ファイルのフォーマットのバージョン情報

バージョン情報

説明

1

07-11〜07-51の自動アクション定義ファイルのバージョンを示す。

2

08-00〜08-50の自動アクション定義ファイルのバージョンを示す。

3

09-00〜11-10の自動アクション定義ファイルのバージョンを示す。

4

11-50以降の自動アクション定義ファイルのバージョンを示す。

このパラメーターを省略，または「1」を指定した場合は，バージョン情報を「2」と仮定して読み込みます。JP1/IM - Viewで［アクション設定］画面の［適用］ボタンをクリックしたとき，「2」に設定し直します。

このパラメーターに「1」，「2」，「3」，または「4」以外の値を指定した場合，統合トレースログにエラーが出力され，バージョン情報を「3」と仮定して読み込みます。このとき，JP1/IM - Viewで［アクション設定］画面は表示できません。バージョン情報を変更したい場合は，直接定義ファイルを編集してください。

旧バージョンの自動アクション定義ファイルのフォーマットは，08-00以降の自動アクション定義ファイルのフォーマットと互換性があるため，08-00以降のフォーマットとして読み込まれます。

このパラメーターが自動アクション定義パラメーター以降の行に記述されている場合，JP1/IM - Viewで［アクション設定］画面が表示できなくなります。

jcamakeaコマンドを実行して自動アクションの定義ファイルの内容をチェックすることをお勧めします。

ページの先頭へ

記述内容（自動アクション状態監視パラメーター）

自動アクション状態監視パラメーターに記述する項目について説明します。

cmn 〜 end-cmn

すべてのアクション定義に有効なパラメーターを指定するブロックの開始と終了パラメーターです。cmn 〜 end-cmnで定義している部分を共通ブロックと呼びます。このブロックは，「自動アクション定義パラメーター」の前に指定する必要があります。なお，このパラメーターは，自動アクション定義ファイルに一つだけ指定します。なお，このブロックは，省略できます。省略した場合は，staパラメーターはfalseを仮定します。

sta {true|false}

アクションの状態を監視するかどうかを指定します。

「true」または「false」のどちらかを指定します。状態監視する場合は「true」，状態監視しない場合は「false」です。デフォルト値は「false」です。

ページの先頭へ

記述内容（自動アクション定義パラメーター）

自動アクション定義パラメーターに記述する各項目について説明します。

act アクション名 〜 end-act

自動アクション定義の開始と終了パラメーターです。act 〜 end-act間で定義する件数に制限はありません。ただし，一つ以上定義する必要があります。act アクション名 〜 end-actで定義している部分をアクションブロックと呼びます。

actのあとにはアクション名を，1〜50バイトの文字列で指定します。指定できる文字は，制御文字（0x00〜0x1F，0x7F〜0x9F）以外の文字列です。

アクション名は，ほかのアクションブロックで指定したアクション名と重複できません。アクションブロックで指定できるパラメーターを次に示します。

prm，cmt，eid，cnd 〜 end-cnd，usr，hst，cmd，rul，var，det，ret，aid，valid

prm パラメーターグループ

パラメーターグループを指定します。このパラメーターを省略した場合，「0」を仮定します。

パラメーターグループは，1けたの数字（0〜9）および「&」で指定できます。1けたの数字（0〜9）を指定した場合，アクション名は省略できません。「&」を指定すると，直前のアクションブロックとのAND条件の指定になります。この場合，このアクションブロックの自動アクション定義パラメーターが属するパラメーターグループは，直前のアクションブロックと同じになります。「&」を指定している場合は，アクション名を指定できません。

「&」を指定していないアクションブロックのあとに，AND条件のアクションブロックを最大9件（最初のアクションブロックを含めて10件）指定できます。

同一のパラメーターグループでは，アクションブロックで前に記述されている（GUIでは［アクション設定］の画面で上に表示されている）アクションブロックが優先します。一つのJP1イベントがマネージャーに届くと，パラメーターグループごとに，優先順位の順にアクションブロックのイベント条件とマッチングします。イベント条件が一致する場合は，パラメーターグループごとに優先順位の最も高いアクションブロックのアクションを実行し，実行したアクションブロック以降のアクションブロックはマッチングしません。また，パラメーターグループの小さいものから大きいものの順番にイベントとマッチングを実施します。自動アクションの優先順位については，マニュアル「JP1/Integrated Management 2 - Manager 導入・設計ガイド」の「6.3.2　実行条件の優先度」を参照してください。

cmt コメント

アクションブロックの説明を記述します。このパラメーターは省略できます。コメントは1,040バイト以内で指定してください。指定できる文字は，すべての文字です。1,040バイトを超えた分は削除されます。

aid アクションID

アクションIDを指定します。このパラメーターは省略できません。アクションIDに指定できる範囲は0〜2,147,483,647です。ただし，パラメーターグループに&を指定する場合は，指定できません。

バージョン情報が4の場合だけ，このパラメーターを指定できます。

valid true|false

自動アクション定義を有効（true）または無効（false）に設定します。このパラメーターは省略できます。省略した場合，有効（true）を仮定します。ただし，パラメーターグループに&を指定する場合は，指定できません。パラメーターグループに&を指定する場合の有効，無効は，一つ前のアクション実行条件に従います。

バージョン情報が4の場合だけ，このパラメーターを指定できます。

eid イベントID

アクション条件のイベントIDを指定します。このパラメーターは省略できません。また，複数指定はできません。

イベントIDは，基本部および拡張部から構成されます。イベントIDは，1〜8桁の16進数で指定し，基本部および拡張部は「:」（半角コロン）で区切って指定します。英大文字・英小文字を区別しません。なお，拡張部は省略できます。任意のイベントIDを指定する場合は，「*」で指定します。「*」を指定するとすべてのイベントをアクションの対象にするため，JP1イベントの発生頻度が大きい場合にアクションが大量に発生し，実行が遅延することがあります。「*」を指定する場合は，その他の条件（メッセージ，イベント基本情報，イベント詳細情報，イベント拡張情報）でイベントを絞り込んでください。

指定例を次に示します。

例）イベントID Aを指定する場合，次のように指定します。

eid a

eid A

eid 0000000a

eid 0000000A

eid 0000000A:0

eid 0000000A:00000000

例）任意のイベントIDを指定する場合，次のように指定します。

eid *

cnd イベント条件 〜 end-cnd

アクションを実行するイベント条件を指定するブロックの開始と終了パラメーターです。イベント条件ブロックは省略できません。イベント条件ブロックは，アクションブロック内に一つだけ指定します。イベント条件ブロックには，0〜256件のイベント条件を指定できます。それぞれのイベント条件は，AND条件となります。

イベント条件

イベント条件は，次の形式で指定します（△は半角スペースを表す）。

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

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

属性名

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

比較キーワード

比較キーワードには，「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

%のあとに指定する文字コードは，英大文字・英小文字を区別しません。JP1正規表現を使用する場合，「%0d」は指定できません。複数選択した場合の定義例「IDが100と200に一致する」を示します。

B.ID△IN△100△200

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

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

イベント基本情報

属性名にB.BASICを指定すると，自動アクション定義ファイル（互換用）のイベント基本情報と同じ条件を設定できます。

属性名にB.BASICを指定した場合は，比較キーワードにはREGEXを指定してください。

オペランドは，自動アクション定義ファイル（互換用）のイベント基本情報と同じ形式で指定できます。ただし，半角スペース，タブ，改行（CR，LF），%は，%を使って記述してください。また，「/」は，「/」と記述してください。「\/」と記述する必要はありません。

イベント詳細情報

属性名にB.DETAILを指定すると，自動アクション定義ファイル（互換用）のイベント詳細情報と同じ条件を設定できます。

属性名にB.DETAILを指定した場合は，比較キーワードにはREGEXを指定してください。

オペランドは，自動アクション定義ファイル（互換用）のイベント詳細情報と同じ形式で指定できます。ただし，半角スペース，タブ，改行(CR，LF)，%は，%を使って記述してください。また，「/」は，「/」と記述してください。「\/」と記述する必要はありません。

イベント条件で指定できる属性名，比較キーワードおよびオペランドについて次の表に示します。

表2‒14　イベント条件で指定できる属性名，比較キーワードおよびオペランド

項番

項目

属性名

比較キーワード

オペランド

1

イベントID

B.ID

  • 一致する

  • 一致しない

  • 正規表現

イベントIDを指定する。

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

  • 一致する，一致しないの場合は，イベントIDの大文字，小文字は区別しない。

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

  • 正規表現の場合は，比較するイベントのイベントIDを，次の形式と見なして比較する。

    ・イベントID拡張部が0の場合：

    イベントID基本部（16進数8桁の英大文字または数字の文字列）

    ・イベントID拡張部が0でない場合：

    イベントID基本部（16進数8桁の英大文字または数字の文字列）:イベントID拡張部（16進数8桁の英大文字または数字の文字列）

イベントID基本部またはイベントID拡張部は，8桁未満の値であった場合は先頭を0で埋め，8桁の文字列とする。

2

発行元プロセスID

B.PROCESSID

  • 一致する

  • 一致しない

  • 正規表現

発行元APのプロセスIDを指定する。

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

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

3

登録時刻

B.TIME

正規表現

JP1イベントが発行元ホストのイベントDBに登録された時刻を指定する。

  • 設定方法はYYYYMMDDhhmmssの形式で正規表現で指定する。

4

到着時刻

B.ARRIVEDTIME

正規表現

JP1イベントが発行元ホストのイベントDBに到着した時刻を指定する。

  • 設定方法はYYYYMMDDhhmmssの形式で正規表現で指定する。

5

発行元ユーザーID

B.USERID

  • 一致する

  • 一致しない

  • 正規表現

発行元プロセスのユーザーID（数値）を設定する。

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

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

6

発行元グループID

B.GROUPID

  • 一致する

  • 一致しない

  • 正規表現

発行元プロセスのグループID（数値）を設定する。

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

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

7

発行元ユーザー名

B.USERNAME

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

発行元プロセスのユーザー名を指定する。

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

8

発行元グループ名

B.GROUPNAME

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

発行元プロセスのグループ名を指定する。

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

9

発行元IPアドレス

B.SOURCEIPADDR

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

発行元イベントサーバに対応するIPアドレスを指定する。

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

  • IPv6アドレスを指定する場合は，次に示すとおり，0〜9およびa〜fの4桁の16進数で指定する。英字部分は，英小文字で指定する。

    （例）0011:2233:4455:6677:8899:aabb:ccdd:eeff

    英字部分を英大文字にしたり，IPv4射影アドレス，IPv4互換アドレス，およびIPv6アドレスの省略形式を指定したりはできない。

10

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

B.SOURCESERVER

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

JP1イベントが発生したホストのホスト名（イベントサーバ名）を指定する。

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

11

メッセージ

B.MESSAGE

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

イベント基本属性のメッセージを設定する。

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

12

イベント詳細情報

B.DETAIL

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

イベント基本属性の詳細情報を設定する。

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

  • JP1イベントの詳細情報にバイナリー形式のデータが設定されている場合，JP1イベントの詳細情報を空文字""（0バイト）として比較する。

  • 互換用として使用できる。

13

登録要因

B.REASON

  • 一致する

  • 一致しない

登録要因を設定する。

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

14

開始時刻

E.START_TIME

正規表現

実行開始または再実行開始の時刻を設定する。

  • 複数指定はできない。

  • 通算秒の正規表現指定で設定する。

15

終了時刻

E.END_TIME

正規表現

実行終了の時刻を設定する。

  • 複数指定はできない。

  • 通算秒の正規表現指定で設定する。

16

プロダクト名

E.PRODUCT_NAME

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

JP1イベントを発行したプロダクトの名称を指定する。

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

17

オブジェクトタイプ

E.OBJECT_TYPE

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

オブジェクトの種類を設定する。

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

18

オブジェクト名

E.OBJECT_NAME

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

JP1イベントのオブジェクト名を指定する。

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

19

登録名タイプ

E.ROOT_OBJECT_TYPE

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

JP1イベントの登録名タイプを指定する。

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

20

登録名

E.ROOT_OBJECT_NAME

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

JP1イベントの登録名を指定する。

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

21

オブジェクトID

E.OBJECT_ID

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

JP1イベントのオブジェクトIDを指定する。

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

22

事象種別

E.OCCURRENCE

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

JP1イベントの事象種別を指定する。

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

23

ユーザー名

E.USER_NAME

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

JP1イベントを発行したユーザー名を指定する。

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

24

終了コード

E.RESULT_CODE

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

終了コードを設定する。

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

25

重大度

E.SEVERITY

  • 一致する

  • 正規表現

JP1イベントの重大度を指定する。

  • "Emergency"（緊急），"Alert"（警戒），"Critical"（致命的），"Error"（エラー），"Warning"（警告），"Notice"（通知），"Information"（情報），"Debug"（デバッグ）の中から指定する。

  • 複数指定できる。ただし，正規表現では複数指定はできない。

26

発生元ホスト名※

E.JP1_SOURCEHOST

  • から始まる

  • と一致する

  • と一致しない

  • を含む

  • を含まない

  • 正規表現

JP1イベントの発生元ホスト名を指定する。

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

27

イベント基本情報

B.BASIC

正規表現

バージョン8以前の互換用のイベント基本情報を設定できる。

28

固有の拡張属性

−

  • 一致する

  • 一致しない

  • 含む

  • 含まない

  • から始まる

  • 正規表現

固有の拡張属性の属性名を指定する。

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

  • 複数指定できる。複数指定では最大100件指定できる。ただし，正規表現では複数指定はできない。
（凡例）

−：なし

注※

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

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

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

usr ユーザー名

アクションを実行するJP1ユーザー名を指定します。usrパラメーターは省略できます。省略した場合，自動アクションの実行環境の定義で，アクション実行標準ユーザーとして指定したJP1ユーザー名を仮定します。アクション実行標準ユーザーも指定されていない場合は，jp1adminを使用します。

ユーザー名に指定できる文字数は，1〜31バイトです。半角英数字だけを使用できます。英字は大文字・小文字を区別しません。また，ユーザー名には，変数を指定できます。受信したJP1イベントに含まれる情報をユーザー名に設定したい場合は，変数を指定します。

ユーザー名にはイベントの情報を設定できます。

アクションを実行するとき，実行先ホストで，ここで指定したJP1ユーザーをJP1/Baseの定義に従ってOSユーザーにユーザーマッピングしてコマンドを実行します。UNIXの場合は，ユーザーマッピングしたOSユーザーのシェル環境を使用して実行します。なお，rulパラメーターと同時に指定できません。

hst {実行ホスト名|グループ名|業務グループ名|監視グループ名}

アクションを実行するホスト名，ホストグループ名，業務グループ名，および監視グループ名を指定します。ホスト名にはシステム構成の定義で管理対象ホストに設定したホスト名を指定します。hstパラメーターは省略できます。省略した場合，自ホストを仮定します。

実行ホスト名，ホストグループ名は，255バイト以内の文字列で指定します。実行ホスト名，ホストグループ名に半角スペースを含むものは指定できません。また，実行ホスト名，またはホストグループ名には，変数を指定できます。受信したJP1イベントに含まれる情報を実行ホスト名，またはホストグループ名に設定したい場合は，変数を指定します。例えば，イベント発行元のホストでアクションを実行したい場合は，「$EVHOST」と指定します。

実行ホスト名，ホストグループ名にはイベントの情報を設定できます。

業務グループ名，監視グループ名には，最大2,048バイトの文字列を指定できます。指定された文字列が「/」で始まる場合は，業務グループ名，監視グループ名と見なします。ただし，統合監視DBおよびIM構成管理DBが無効な場合は，ホスト名またはホストグループ名と見なします。

なお，rulパラメーターと同時に指定できません。

cmd アクション

アクションとして実行するコマンドを指定します。 指定できるコマンドについては，マニュアル「JP1/Integrated Management 2 - Manager 導入・設計ガイド」の「6.　自動アクションによるコマンド実行」を参照してください。

cmdパラメーターは省略できます。省略した場合，アクションを実行する条件が成立しても，何も実行しません。

ただし，次のパラメーターのどれかを指定した場合，cmdパラメーターを省略すると定義エラーとなります。

usr，var，hst，det，ret

また，cmdパラメーターは，複数指定できません。アクションは，4,096バイト以内の文字列で指定します。アクションの前のタブ・スペースは削除し，アクションの後ろのスペースは削除しません。

このパラメーターは，rulパラメーターと同時に指定できません。

アクションにはイベントの情報を設定できます。

なお，変数を使うことで受信したJP1イベントに含まれる情報を指定できます。例えば，実行ホストがUNIXの場合，次のように記述すると，JP1イベントのイベント発行元ホスト名を環境変数HOSTNAMEに指定できます。

HOSTNAME="$EVHOST" アクション

　xxx_BASIC="$EVBASE" xxx_MESSAGE="$EVMSG" アクション

アクションのコマンド長に関する注意事項

アクションとして実行できるコマンドの長さは，アクション定義で使用できる変数（$EVMSGなど）の変換後の情報を含めて，4,096バイトまでです。コマンドの長さが4,096バイトを超えた場合は実行状態が「実行不可」になり，コマンドは実行されません。［アクション結果詳細］画面の［メッセージ］欄には，KAVB4421-Wのメッセージが表示されます。

アクションとして実行できるコマンドの長さは，JP1/IM - Manager，JP1/Baseを運用しているシステムによって変わります。

自動アクションの実行経路上のホスト（実行元マネージャーホスト，実行先ホストを含む）にバージョン6，バージョン7のJP1/IM - Manager，JP1/Baseがある場合には，コマンドの長さは，最大1,024バイトに抑える必要があります。コマンド長に関する注意事項の詳細については，マニュアル「JP1/Integrated Management 2 - Manager 導入・設計ガイド」の「12.4.1　自動アクションを検討するときの注意事項」を参照してください。

アクション中の文字として認識できないコードについての注意事項

アクション中に，文字として認識できないコード（ASCIIコードおよび環境設定で指定したマルチバイト文字コードの文字集合に含まれない部分）が含まれた場合，実行先ホストのシェルなどの仕様で実行されない，または実行されても結果が不正になることがあります。この場合，アクションは実行失敗にならず，終了状態になります。定義ファイル中に上記の不正なコードを指定していなくても，アクション定義で使用できる変数から実行時に置き換えることでアクションに含まれる場合があります。アクション対象イベントを発行する各製品のマニュアルなどで確認し，アクション定義で使用できる変数を指定してください。

rul

JP1/IM - RLへのルール起動要求を設定したい場合に指定します。なお，このパラメーターは，var，cmd，usr，hstパラメーターとは同時に指定できません。

var 環境変数ファイル名

アクションとして実行するコマンドの環境変数を指定した環境変数ファイルのファイル名をフルパスで指定します。このパラメーターは省略できます。省略した場合，環境変数ファイルは仮定されません。環境変数ファイルの形式については，マニュアル「JP1/Base 運用ガイド」を参照してください。

環境変数ファイル名は，255バイト以内の文字列で指定します。環境変数ファイル名にはイベントの情報を設定できます。また，環境変数ファイル名には，変数を指定できます。受信したJP1イベントに含まれる情報を環境変数ファイル名に設定したい場合は，変数を指定します。例えば，ENVFILEという名称のJP1イベント拡張属性を環境変数ファイル名として設定したい場合は，「$EV"ENVFILE"」と指定します。

なお，このパラメーターは，rulパラメーターと同時に指定できません。環境変数ファイル名の前後のスペースは削除しません。varの後ろにある1文字のタブ・スペースだけ削除します。

det 抑止時間

アクションを抑止する時間を指定します。このパラメーターで指定した時間内に発生した同一のアクション条件に対するアクションは抑止されます。このパラメーターは省略できます。省略した場合，アクションは抑止されません。抑止時間に指定できる範囲は1〜3,600（秒）です。パラメーターグループに「&」を指定している場合はこのパラメーターは指定できません。AND条件を使用する場合は，AND条件の最初に定義する自動アクション定義パラメーターに指定してください。

ret 遅延監視時間

アクションの実行時間を監視する時間を指定します。このパラメーターで指定した時間が，マネージャー上のJP1/BaseにJP1イベントが到着してから，実行先ホストのコマンド制御アクション実行終了メッセージを受信するまでの時間を超過した場合，JP1イベントの発行やコマンドの実行などの方法で，アクションに遅延が発生していることを通知します。このパラメーターは省略できます。省略した場合，アクションの遅延監視をしません。遅延監視時間に指定できる範囲は1〜86,400（秒）です。

#コメント行

#で始まる行は，コメント扱いとなります。なお，JP1/IM - Viewからアクション定義を設定した場合，#のコメント行は削除されます。

ページの先頭へ

アクション定義で使用できる変数

自動アクション定義パラメーターの定義のうち，usr，var，hst，cmdパラメーターには，変数を使って，JP1イベントに含まれる情報を指定できます。

アクション実行時に，変数がJP1イベント中の情報に変換されて実行されます。

変数を自動アクション定義パラメーターに記述する場合は，「$EVID」のような形式で指定します。なお，「$」を文字列として扱いたい場合は，エスケープ文字「\」を「$」の前に指定してください。

使用できる変数を次に示します。

表2‒15　アクション定義で使用できる変数

情報の種類

変数名

内容

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

EV"@JP1IM_DISPLAY_MESSAGE"

メッセージ(変更後)

EV"@JP1IM_CHANGE_MESSAGE"

表示メッセージ変更フラグ

  • メッセージを変更していない：0

  • メッセージを変更した：1

ACTHOST

アクション実行要求元マネージャーホスト名※3

EVENV1〜EVENV9

アクションの実行条件の指定で，正規表現中に"( )"を指定して切り出したデータ※5

（マネージャーホストで拡張正規表現を使用している場合だけ使用できる）
注※1　JP1イベントの基本情報が次の形式に変換されてアクションに渡されます（△は半角スペース）。

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

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

注※2　JP1/IM - Managerのタイムゾーンで変換してアクションに渡されます。

注※3　該当する属性が存在しない場合，アクション実行時に変数が空文字に変換されてアクションに渡されます。

注※4　JP1イベントの詳細属性の情報がバイナリー形式の場合は，変数が空文字に変換されてアクションに渡されます。

注※5　該当する属性が存在しない場合，変数の文字列がそのままアクションに渡されます。

また，JP1イベントの種類によっては，変数自体のないものや，各属性に含まれる情報に文字として認識できないコード（ASCIIコードおよび環境設定で指定したマルチバイト文字コードの文字集合に含まれない部分）が含まれていることで，アクションが実行できない，または実行されても結果が不正になる場合があります。また，JP1イベント発行元の制限によってJP1イベント中の情報が途中で切れ，アクションが実行できない，または実行されても結果が不正になる場合があります。JP1イベント発行元製品のマニュアルなどを事前に参照し，属性値の情報を確認してから置き換え文字を設定してください。

イベント引き継ぎ情報のエンコーディング

アクションの実行内容に関する項目のうち「アクション」については，イベント引き継ぎ情報の値をURLエンコーディングしたり，Base64エンコーディングしたりできます。指定形式は，「$変数名$エンコーディングの種類」です。エンコーディングの種類の直後に半角英数字，または_（アンダーバー）を指定する場合は，「${変数名$エンコーディング種類}」の形式で指定してください。「$」を文字列として扱いたい場合は，エスケープ文字「\」を「$」の前に指定してください。

次の場合，「$変数名$エンコーディングの種類」または「${変数名$エンコーディング種類}」は，文字列と見なされて変換されません。

イベント引き継ぎ情報のエンコーディングの種類と指定形式を次に示します。

表2‒16　イベント引き継ぎ情報のエンコーディングの種類と指定形式

項番

エンコーディングの種類

指定形式

説明

1

URLエンコーディング

$変数名$URLENC

イベント引き継ぎ情報の値をUTF-8の文字列としてURLエンコーディングします。

${変数名$URLENC}

2

Base64エンコーディング

$変数名$ENC

イベント引き継ぎ情報の値をBase64エンコーディングします。

${変数名$ENC}

3

Base64コーディングとURLコーディングの両方

$変数名$ENC$URLENC

イベント引き継ぎ情報の値をBase64エンコーディングし，さらにURLエンコーディングします。

${変数名$ENC$URLENC}

4

エンコーディングしない

$変数名

URLエンコーディングもBase64エンコーディングもしない。

${変数名}

変数の記述での注意点

ページの先頭へ

アクション定義での正規表現

自動アクションの定義で，イベント監視条件にJP1イベントの属性（メッセージテキスト・基本属性・詳細情報）を正規表現で指定する場合の指定方法について説明します。

使用できる正規表現は，OSによって異なります。Windowsの場合とUNIXの場合に分けて，使用できる正規表現を説明します。

複数のOSでアクション定義を共用する場合，正規表現の解釈が異なるので，どのOSでも使用できる表現で条件を記述するように注意してください。なお，マニュアル「JP1/Integrated Management 2 - Manager 導入・設計ガイド」の「付録G　正規表現」に各OS共通で使用できる正規表現を記載しています。これを参考にして使用する正規表現を決めてください。

Windows版の正規表現

Windows版では，使用できる正規表現をJP1独自の正規表現，拡張正規表現のどちらかにできます。デフォルトは拡張正規表現です。JP1独自の正規表現にする場合は，「自動アクション環境定義ファイル（action.conf.update）」（2.　定義ファイル）を参照して設定してください。

UNIX版の正規表現

UNIX版では「拡張正規表現」を使用します。使用できる正規表現の詳細については，OS提供の「regexp（5）」を参照してください。

正規表現に関する注意事項

ページの先頭へ

定義例

自動アクション定義ファイルの定義例を次に示します。なお，定義例は，正規表現の種別に拡張正規表現を指定しています。

定義例1：変数を使用した例1

変数を使用して受信したJP1イベントの情報を，アクションとして実行するコマンドの引数に指定する場合の定義例を次に示します。

  • イベント条件

    イベントID（B.ID）が「00000001」

    メッセージの形式が「メッセージID※△:△メッセージ本文」

    注※　メッセージIDは，英字1文字と3けたの数字。

  • アクションとして実行するコマンド

    alarm.bat△引数1△引数2

  • コマンドの引数に指定するJP1イベントの情報

    引数1：メッセージの値（変数には，${EVMSG}を指定）

    引数2：拡張属性AAAの値（変数には，${EV"AAA"}を指定）

    [図データ]

受信したJP1イベントのメッセージ（B.MESSAGE）の値が「A001△:△WEBサーバーがダウンしました。」，拡張属性AAAの値が「kanshi」の場合，「alarm.bat△"kanshi"△"A001△:△WEBサーバーがダウンしました。"」というアクションを実行します。

定義例2：変数を使用した例2

変数「EVENV1」〜「EVENV9」を使用して受信したJP1イベントの情報の一部を，アクションとして実行するコマンドの引数に指定する場合の定義例を次に示します。

  • イベント条件

    イベントID（B.ID）が「00000001」

    メッセージの形式が「メッセージID※△:△メッセージ本文」

    注※　メッセージIDは，英字1文字と3けたの数字。

  • アクションとして実行するコマンド

    alarm.bat△引数1△引数2

  • コマンドの引数に指定するJP1イベントの情報

    引数1：メッセージのメッセージIDの値（変数には，${EVENV1}を指定）

    引数2：メッセージのメッセージ本文の値（変数には，${EVENV2}を指定）

    [図データ]

受信したJP1イベントのメッセージ（B.MESSAGE）の値が「A001△:△WEBサーバーがダウンしました。」の場合，「alarm.bat△"A001"△"WEBサーバーがダウンしました。"」というアクションを実行します。

定義例3：イベントIDを正規表現で指定した例1

イベント条件の属性名に「B.ID」，比較キーワードに「REGEX」を指定する場合の定義例を次に示します。

  • イベント条件

    イベントIDが00000001〜00000200（16進数のA〜Fの文字は含めない）

    発行元イベントサーバ名（B.SOURCESERVER）が「kanshi」

  • アクションとして実行するコマンド

    alarm.bat

    [図データ]

イベント条件でイベントIDを指定する場合は，イベント条件で指定しているイベントIDが対象となるように，eidに「*」を指定してください。

定義例4：イベントIDを正規表現で指定した例2

イベント条件の属性名に「B.BASIC」を指定すると，自動アクション定義ファイル（互換用）のイベント基本情報と同じ形式で条件を設定できます。

イベント条件の属性名に「B.BASIC」，比較キーワードに「REGEX」を指定する場合の定義例を次に示します。

  • イベント条件

    イベントIDが00000001〜00000200（16進数のA〜Fの文字は含めない）

    発行元イベントサーバ名（B.SOURCESERVER）が「kanshi」

  • アクションとして実行するコマンド

    alarm.bat

    [図データ]

タブ，半角スペース，%，および改行コードの指定方法が自動アクション定義ファイル（互換用）と異なります。詳細については，「自動アクション定義ファイル（actdef.conf）（互換用）」（2.　定義ファイル）を参照してください。

定義例5：AND条件を使用した例

イベントAおよびイベントBを受信した場合にアクションを実行するように指定するときの定義例を次に示します。

  • イベントAの条件

    イベントID（B.ID）が「00000201」

    メッセージ（B.MESSAGE）が「WEBサーバーAがダウンしました。」

  • イベントBの条件

    イベントID（B.ID）が「00000202」

    メッセージ（B.MESSAGE）が「WEBサーバーBがダウンしました。」

  • アクションとして実行するコマンド

    alarm.bat

    [図データ]

AND条件を使用する場合は，相関イベント発行機能を使った自動アクションをお勧めします。相関イベント発行機能は，AND条件では考慮できない，JP1イベントの順序や件数を指定できます。相関イベントについては，マニュアル「JP1/Integrated Management 2 - Manager 導入・設計ガイド」の「4.3　相関イベントの発行」を参照してください。

ページの先頭へ

Copyright (C) 2019, 2021, Hitachi, Ltd.

Copyright (C) 2019, 2021, Hitachi Solutions, Ltd.