jpcimevt
形式
jpcimevt [-i イベントID] [-m メッセージ] [-s アラームの状態] [[-e 拡張属性名=拡張属性値]...] [-r イベントサーバ名]
機能
jpcimevtコマンドは,イベントサーバに任意のJP1イベントを登録し,JP1/IMに登録したイベントを送信するコマンドです。
このコマンドは,アラームのアクションとしてJP1イベントを発行する場合に使用できます。JP1イベントをアラームのアクションとして発行する方法については,マニュアル「JP1/Performance Management 運用ガイド」の,アラームの定義と操作について説明している章を参照してください。
コマンドを実行できるホスト
-
PFM - Manager
-
PFM - Agent
-
PFM - RM
実行権限
- Windowsの場合
-
なし
- UNIXの場合
-
なし
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pc/tools/
引数
-i イベントID
登録するJP1イベントのイベントIDを指定します。0〜1fff,7fff8000〜7fffffffの範囲の数値(16進数)で指定します。指定を省略した場合,イベントIDに0が仮定されます。
-m メッセージ
登録するJP1イベントのメッセージテキストを指定します。1〜1023バイトで指定します。なお,09-00以前のAction HandlerサービスでJP1イベントを発行する場合は,0〜128バイトで指定します。
空白文字を含む場合," "で囲んでください。指定を省略した場合,メッセージテキストは記録されません。[新規アラーム > アクション定義]または[編集 > アクション定義]画面の[コマンドの定義]で「%MTS」を指定すると,アラームで設定したメッセージテキストをJP1/IMに送信できます。
-s アラームの状態
アラームの状態を指定します。アラームの状態を指定すると,JP1イベントの重大度に変換されます。-sオプションの値をJP1イベントに変換するには,[新規アラーム > アクション定義]または[編集 > アクション定義]画面の[コマンドの定義]で「%SCS」を指定してください。-sオプションに指定できる値および変換される値を次の表に示します。
指定できる値 |
説明 |
JP1イベントの重大度 |
---|---|---|
"OK" |
アラームの状態が正常(緑) |
"Information" |
"WARNING" |
アラームの状態が警告(黄) |
"Warning" |
"EXCEPTION" |
アラームの状態が異常(赤) |
"Error" |
-sオプションとともに-eオプションで重大度を定義した場合,-sオプションで指定した値が優先されます。-sオプションと-eオプションを両方省略した場合,JP1イベントの重大度に何も設定されません。
-e 拡張属性名=拡張属性値
JP1イベントに登録する拡張属性を指定します。「-e 拡張属性名=拡張属性値」を1組として複数記述できます。拡張属性名または拡張属性値に空白文字を含む場合," "で囲んでください。「=」の前後に空白文字は指定できません。
同じ拡張属性を複数回指定した場合の動作は保証されません。
-r イベントサーバ名
JP1イベントを登録するイベントサーバ名を指定します。1〜255バイトで指定します。
指定できるイベントサーバは,ローカルホストで稼働しているイベントサーバだけです。このオプションは,JP1/Baseをクラスタシステムで運用している場合に指定してください。
指定を省略した場合,ローカルホスト名と同じイベントサーバ名が仮定されます。
注意事項
-
アラームのアクションとしてJP1イベントを発行するホストにJP1/Baseがインストールされている必要があります。
-
JP1イベントを発行するにはJP1/Baseのイベントサーバを起動しておく必要があります。
-
メッセージテキストの長さが1023バイトを超えた場合は,メッセージテキストが1023バイト以下になるよう切り詰められます。このとき,KAVE05418-Wメッセージが出力されます。なお,09-00以前のAction Handlerサービスでは,メッセージテキストの長さが128バイトを超えた場合は,エラーとなり,JP1イベントが発行されません。このとき,KAVE05223-Eメッセージが出力されます。
戻り値
0 |
正常終了した。 |
1 |
引数の指定に誤りがある。 |
200 |
メモリーが不足している。 |
211 |
ファイルにアクセスできない。 |
250 |
JP1イベントの送信に失敗した。 |
255 |
予期しないエラーが発生した。 |
使用例
イベントIDが「111」,アラームの状態が「OK」,拡張属性名が「EXTATTR」,拡張属性値が「Extend Value」のイベントを登録する場合のコマンド実行例を次に示します。
jpcimevt -i 111 -s OK -e EXTATTR="Extend Value"