jpctool alarm import

〈このページの構成〉

形式
機能
コマンドを実行できるホスト
実行権限
格納先ディレクトリ
引数
アラーム定義ファイルの形式
注意事項
戻り値
使用例

形式

jpctool alarm import    -f アラーム定義ファイル名
                        [-y|-n]
                        [-wait 秒数]

ページの先頭へ

機能

jpctool alarm importコマンドは，指定されたファイルからアラームの定義情報をインポートし，アラームテーブルおよびアラームの定義・更新をするコマンドです。

定義情報のインポートは，アラーム単位で実施されます。アラーム定義ファイルに複数のアラームが定義されている場合，あるアラーム定義でインポート処理が異常終了しても，その後のインポート処理は継続して実施されます。また，複数のアラーム定義のインポート処理でエラーが発生した場合，最後に発生したエラーに対応した戻り値が返されます。

このコマンドでは，定義情報をインポートする前に，アラーム定義ファイルの構文や定義内容の妥当性を検証します。アラーム定義ファイルの構文や定義内容に誤りがある場合，最初に出現した誤りの個所についてだけ，ファイル内の行番号と誤りの内容を示すエラーメッセージが出力されます。

誤りの内容を示すエラーメッセージ中に示されるエラー要因とエラーの内容の関係を以下に示します。

表2‒47　エラーメッセージ中に示されるエラー要因とエラーの内容の関係
エラー要因	エラーの内容
The specified entry is invalid	指定したラベル名またはセクション名が不正である。
The specified value is invalid	指定した値が不正である。
The syntax is invalid	アラーム定義ファイルの構文が不正である。
The entry（ラベル名またはセクション名） is not specified	必要なラベルまたはセクションが指定されていない。
The specified product is invalid	指定したプロダクトIDまたはデータモデルバージョンが不正である。
The specified field is not defined	指定したプロダクトIDのPFM - AgentまたはPFM - RMで使用できないレコード名またはフィールド名が指定されている。
The specified report is not defined	指定したプロダクトIDのPFM - AgentまたはPFM - RMで定義されていないレポートが指定されている。
The specified Action Handler is not defined	指定したアクションハンドラがない。
The specified Action Handler does not have capability	指定したアクションハンドラが指定したアクションを実行するように設定されていない。
A Character-code is invalid	指定した文字コードが不正である。
The specified definition is too many	アラーム定義の数が定義可能な数を超えている。
Total length of Abnormal condition definition is too long	アラーム定義の異常条件文が定義可能な長さを超えた。
Total length of Warning condition definition is too long	アラーム定義の警告条件文が定義可能な長さを超えた。

ページの先頭へ

コマンドを実行できるホスト

PFM - Manager

ページの先頭へ

実行権限

Windowsの場合: Administrators権限を持つユーザー
UNIXの場合: rootユーザー権限を持つユーザー

ページの先頭へ

格納先ディレクトリ

Windowsの場合: インストール先フォルダ\tools\
UNIXの場合: /opt/jp1pc/tools/

ページの先頭へ

引数

- f アラーム定義ファイル名

インポートするアラーム定義ファイルのファイル名を指定します。ファイル名は，相対パスでも絶対パスでも指定できます。

全角文字，半角英数字，半角空白文字，または次に示す半角記号を指定できます。

　% - ( ) _ . @ [ ]

ただし，半角空白文字を含む場合は「"」（ダブルクォーテーション）で囲んでください。また，半角記号を指定する場合は，必要に応じてエスケープ表記をしてください。

-y`|`-n

インポートするアラーム定義がすでに定義されていた場合でも，強制的に定義内容を更新するかどうかを指定します。

「-y」を指定すると，アラーム定義が強制的に更新されます。

「-n」を指定すると，更新処理がスキップされます。

指定を省略した場合，アラーム定義を上書きしてもよいかを確認するメッセージが出力されます。

-wait 秒数

同時に実行できないコマンドが実行中の場合の，最大待機秒数を指定します。この引数は，起動情報ファイル（jpccomm.ini）でアラームコマンドの実行を待機する設定（Alarm Command Wait Mode）を有効にしている場合で，jpccomm.iniファイルでの設定とは異なる秒数を指定したいときに使用します。1〜3600の数字で指定します。

指定を省略した場合，jpccomm.iniファイルでの設定秒数で動作します。

同時に実行できないコマンドについては，「アラームコマンドが同時に実行できないコマンド」を，jpccomm.iniファイルおよびAlarm Command Wait Modeについては，「起動情報ファイル（jpccomm.ini）」を参照してください。

ページの先頭へ

アラーム定義ファイルの形式

設定値の一覧

Alarm Definition File Versionラベル

アラーム定義ファイルの構文のバージョンを指定します。指定場所はファイルの先頭です。

表2‒48　Alarm Definition File Versionラベル
種別	説明
意味	アラーム定義ファイルの構文のバージョンを示します。
指定可能値	0001または0002 0001 すべてのバージョンのPFM - Managerでインポートできる。 0002 PFM - Manager 10-10以降でインポートできる。また，インスタンスごとの状態変化を通知するアラームを定義できる。
省略	不可

Alarm Definition File Codeラベル

アラーム定義ファイルを記述している文字コードをAlarm Definition File Versionラベルの直後に指定します。

表2‒49　Alarm Definition File Codeラベル
種別	説明
意味	アラーム定義ファイルを記述している文字コードを示す。
指定可能値	Shift_JIS 全角文字（SJIS）か半角文字（7ビット ASCII文字）で作成されている場合に指定する。 EUC-JP 全角文字（EUC）か半角文字（7ビット ASCII文字）で作成されている場合に指定する。 UTF-8 全角文字（UTF-8）か半角文字（7ビット ASCII文字）で作成されている場合に指定する。 C 半角文字（7ビット ASCII文字）だけで作成されている場合に指定する。 GB18030 全角文字（GB18030）か半角文字（7ビット ASCII文字）で作成されている場合に指定する。
省略	不可

Alarm Dataセクション

1つのアラームの定義を指定します。複数のアラームを定義する際は，アラーム定義ごとにAlarm Dataセクションを作成し，定義を記載します。Alarm Dataセクションは省略できません。

Alarm Dataセクション内で指定できるサブセクションは次のとおりです。

表2‒50　Alarm Dataセクション
サブセクション名	説明	省略可否
General	アラーム名などの基本情報を設定する。	×
Advanced Setting	アラームの種別やオプションを設定する。	○
Check Value Exist	値の存在を監視するアラームで監視する値を設定する。	○（アラーム定義による）
Alarm Condition Expressions	値の存在を監視するアラーム以外のアラームの条件式を設定する。	○（アラーム定義による）
Actions	アラームで実行するアクションや表示するレポートを設定する。	○
Action Definition E-mail	アラームでE-mailを実行する際の設定を指定する。	○（アラーム定義による）
Action Definition Command	アラームでCommandを実行する際の設定を指定する。	○（アラーム定義による）
Action Definition JP1 Event	アラームでJP1イベントを実行する際の設定を指定する。	○（アラーム定義による）

（凡例）

○：省略できます

×：省略できません

Generalサブセクション

アラームの基本情報（アラーム名やメッセージテキストなど）を指定します。このサブセクションは省略できません。

このサブセクションで指定できるラベルは次のとおりです。

表2‒51　Productラベル
種別	説明
意味	アラームのプロダクトとデータモデルバージョンを示す。
指定可能値	<プロダクトID><データモデルバージョン> プロダクトID アラームを定義したいエージェントのプロダクトIDを大文字で指定する。データモデルバージョンバージョンとリビジョンの10進数表記を「.（ピリオド）」でつないだものを指定する。
省略	不可

表2‒52　Alarm Table Nameラベル
種別	説明
意味	アラームテーブル名を示す。
指定可能値	1〜64（単位：バイト）以内の全角文字および半角文字で指定する。「=」の後ろと改行の前の半角空白は無視される。「PFM（大文字・小文字を含む）」で始まる名称は指定できない。
省略	不可

表2‒53　**Alarm Nameラベル**
種別	説明
意味	アラーム名を示す。
指定可能値	1〜20（単位：バイト）以内の全角文字および半角文字で指定する。「=」の後ろと改行の前の半角空白は無視される。
省略	不可

表2‒54　Message Textラベル
種別	説明
意味	アラームイベント発生時に出力するメッセージテキストを示す。
指定可能値	0〜255（単位：バイト）以内の全角文字および半角文字で指定する。「=」の後ろと改行の前の半角空白は無視される。「=」の後ろが半角空白だけの場合は，指定されていないものと見なされる。ユーザー操作によるアラーム正常回復時のリモートアクション実行抑止機能が有効な場合，アラーム定義のアラームメッセージテキストに次の文字列と完全一致の文字列を設定してはならない。設定すると，アラーム正常回復時にアクションが実行されない。 "Alarm deactivated" "Alarm cleared" "Alarm updated/deleted"
省略	可

表2‒55　Check Value Existラベル
種別	説明
意味	アラームの設定を値の存在を監視するアラームとするかを示す。
指定可能値	「Y」または「N」で指定する。「Y」を指定した場合値の存在を監視するアラームとして定義される。省略または「N」を指定した場合通常のアラームとして定義される。
省略	可

Advanced Settingサブセクション

アラームの拡張情報（アラームの種別や監視時刻など）を指定するサブセクションです。このサブセクションは省略できます。

このサブセクションで指定できるラベルは次のとおりです。

なお，Notify Stateラベルについては，Alarm Definition File Versionラベルの値が「0002」の場合に指定できます。

表2‒56　Active Alarmラベル
種別	説明
意味	アラームの状態を示す。
指定可能値	「Y」または「N」で指定する。省略または「Y」を指定した場合アラームが有効となる。「N」を指定した場合アラームが無効となる。
省略	可

表2‒57　**Regular Alarmラベル**
種別	説明
意味	アラームの設定［常にアラーム通知する］を有効にするかを示す。
指定可能値	「Y」または「N」で指定する。「Y」を指定した場合［常にアラーム通知する］が有効となる。省略または「N」を指定した場合［常にアラーム通知する］が無効となる。
省略	可

表2‒58　Evaluate All Dataラベル
種別	説明
意味	アラームの設定［すべてのデータを評価する］を有効にするかを示す。
指定可能値	「Y」または「N」で指定する。「Y」を指定した場合［すべてのデータを評価する］が有効となる。省略または「N」を指定した場合［すべてのデータを評価する］が無効となる。
省略	可

表2‒59　Notify Stateラベル
種別	説明
意味	状態が変化したときの通知を有効にするかを示す。
指定形式	Notify State=Alarm`\|`Instance
指定可能値	「Alarm」または「Instance」で指定する。「Alarm」を指定した場合アラームの状態変化を通知する「Instance」を指定した場合インスタンスごとの状態変化を通知する。
省略	可：省略した場合は「Alarm」の指定と同義となる。
補足	「Instance」を指定した場合に，Regular AlarmラベルおよびEvaluate All Dataラベルで「Y」が指定されているとき，構文エラーとなる。

表2‒60　Monitoring Regularlyラベル
種別	説明
意味	アラームの設定で［常に監視する］を有効にするかを示す。
指定可能値	「Y」または「N」で指定する。省略または「Y」を指定した場合［常に監視する］が有効となる。「N」を指定した場合［常に監視する］が無効となる。
省略	可

表2‒61　Monitoring Timeラベル
種別	説明
意味	アラームの設定で［常に監視する］が無効な場合に監視時刻の時刻を示す。
指定可能値	<開始時刻>-<終了時刻> 時刻はHH:MMの形式で，ローカルタイムで指定する。<開始時刻>と<終了時刻>は「-（ハイフン）」でつなぐ。 HH：開始時刻の時間を00〜23で指定する。 MM：開始時刻の分を00〜59の間で指定する。
省略	可（Monitoring Regularlyラベルの値が「N」の場合は省略できない）

表2‒62　**Dampingラベル**
種別	説明
意味	アラームの設定［発生頻度を満たした時にアラーム通知する］を有効にするかを示す。
指定可能値	「Y」または「N」で指定する。「Y」を指定した場合［発生頻度を満たした時にアラーム通知する］が有効となる。省略または「N」を指定した場合［発生頻度を満たした時にアラーム通知する］が無効となる。
省略	可

表2‒63　Damping Countラベル
種別	説明
意味	アラームの設定で［発生頻度を満たした時にアラーム通知する］が有効の場合に，しきい値超過回数と計測するインターバルを示す。
指定可能値	<しきい値超え回数>/<インターバル値> 値はそれぞれ1〜32767の整数を指定。<しきい値超え回数>と<インターバル値>の間は「/（スラッシュ）」でつなぐ。 <インターバル値>が<しきい値超え回数>より小さい場合，<インターバル値>を<しきい値超え回数>と同じ値として処理する。 Dampingラベルの値が「Y」の場合は省略できない。Dampingラベルの値が「N」またはラベルが省略された場合は，指定しても無視される。
省略	可（Dampingラベルの値が「Y」の場合は省略できない）

Check Value Existサブセクション

アラームの設定で［値の存在を監視するアラームとする］が有効になっている場合に，その監視するレコードと値を指定するサブセクションです。このサブセクションは省略できますが，GeneralサブセクションでCheck Value Existラベルに「Y」を指定した場合は省略できません。

このサブセクションで指定できるラベルは次のとおりです。

表2‒64　Recordラベル
種別	説明
意味	［値の存在を監視するアラームとする］が有効になっている場合に，監視する対象のレコードを示す。
指定可能値	1〜7（単位：バイト）の半角文字で，監視するレコードのレコードIDを指定する。複数行のレコード（複数インスタンスレコード）のレコードIDだけが指定できる。レコードIDについては，各PFM - AgentまたはPFM - RMマニュアルの，レコードについて説明している章を参照。
省略	不可

表2‒65　Fieldラベル
種別	説明
意味	［値の存在を監視するアラームとする］が有効になっている場合に，監視する対象のレコードのフィールドを示す。
指定可能値	1〜50（単位：バイト）までの半角文字で，監視するフィールドのPFM - Manager名を指定する。
省略	不可

表2‒66　Valueラベル
種別	説明
意味	［値の存在を監視するアラームとする］が有効になっている場合に，存在を監視する値を示す。
指定可能値	指定できる値はフィールドの値によって異なり，整数値や小数値または1〜127（単位：バイト）の全角文字または半角文字とする。半角文字を指定した場合は，制御文字および( ) [ ] < > ="は指定できない。これらの文字を指定したい場合は，ワイルドカード文字を用いて値を指定する。存在を監視する値に「`#`」を使用したい場合は，「`\#`」と指定することで使用できる。存在を監視する値で，指定したワイルドカード文字の直前に「`\`」を指定したい場合は，「`\\`」と指定することで使用できる。
省略	不可

Alarm Condition Expressionsサブセクション

アラームで監視するレコードと値を指定するサブセクションです。このサブセクションは省略できますが，GeneralサブセクションでCheck Value Existラベルがない，または「N」を指定した場合は，省略できません。

このサブセクションで指定できるラベルは次のとおりです。

表2‒67　**Conditionラベル**
種別	説明
意味	アラームで監視する際の条件式を示す。
指定可能値	アラームで監視する際の条件式を次の形式で指定する。 <監視するフィールド><条件><異常値>,<警告値> <監視するフィールド> 監視するレコードIDとフィールドのPFM - Manager名を「_（アンダーバー）」で接続した文字列を1〜50（単位：バイト）までの半角文字で指定する。 <条件> 次のどれかを指定する。「=」：フィールドの値と指定した値が等しい「<」：フィールドの値が指定した値より小さい「<=」：フィールドの値が指定した値より小さいかまたは等しい「>」：フィールドの値が指定した値より大きい「>=」：フィールドの値が指定した値より大きいかまたは等しい「<>」：フィールドの値が指定した値と異なる <異常値>,<警告値> それぞれ異常または警告アラームの判断基準となるしきい値を指定する（値は「,（半角コンマ）」で区切る）。小数点記号には，「.（ピリオド）」を指定する。整数値，小数値または文字列（全角文字または半角文字）を指定する。指定できる値は，監視するフィールドによって異なる。半角文字を指定した場合，制御文字および( ) [ ] < > =は指定できない。文字列を指定する場合は文字列の前後を「"（ダブルクォーテーション）」で囲む。文字列中にタブ記号（`\`t）が含まれている場合，すべて半角スペースに置換される。複数の条件を設定する場合は，上記の式をANDで接続する。同時に指定できる（連結できる）条件式は，最大で5つ。複数の条件式を指定する場合は，評価順に記載する（前に記載したものから順に評価されます）。また，変数%CVSで測定値を表示する場合，フィールドの位置は前に記載したものから順に決定される。3つ以上の条件式を指定したアラーム定義をPFM - Web Consoleで表示すると優先度が低い条件式から順に"()"で囲んで表示される。例 `jpctool alarm import`コマンドでの定義時：A AND B AND C PFM - Web Consoleで表示される定義：A AND ( B AND C ) 異常値と警告値の条件が異なるアラーム（例えば，異常値 < 50，警告値 <= 60となっている）をエクスポートする場合，警告値（警告値がない場合は，異常値）の条件が優先してエクスポートされる。異常値または警告値が存在しないアラームをエクスポートする場合，<異常値>または<警告値>を空欄にしてエクスポートする。条件式は，異常条件と警告条件に分割してPFM - Managerに登録する。それぞれの条件式の長さが749（単位：バイト）を超える場合は登録できないため，エラーとする。PFM - Managerに登録される条件式の長さは，ANDで連結して指定した条件式の数をn（1≦n≦5），1≦i≦nとして，次の式で計算できる。次の式で算出される値が749（単位：バイト）を超える場合はエラーとなる。異常値の条件式の長さ＝警告値の条件式の長さ＝ ai：i番目の<監視するフィールド>の長さ（単位：バイト） bi：i番目の<条件>の長さ（単位：バイト） ci：i番目の<異常値>の長さ（単位：バイト）（文字列を指定した場合，""を除いた長さ） di：i番目の<警告値>の長さ（単位：バイト）（文字列を指定した場合，""を除いた長さ）
省略	不可

Actionsサブセクション

アラームイベントが発生時に実行するアクションや表示するレポートを指定するサブセクションです。このサブセクションは省略できます。

このサブセクションで指定できるラベルは次のとおりです。

表2‒68　Reportラベル
種別	説明
意味	アラームイベント発生時に表示するレポート名を示す。
指定可能値	0〜1,024（単位：バイト）の全角文字または半角文字でフォルダ階層の絶対パス（Reports/から始まる形式）を指定する。名称（フォルダの区切り文字を除く）に「`\`」または「`/`」が含まれる場合，それぞれ「`\\`」，「`\/`」と記述する。ラベルの値またはラベル自体が省略された場合は，指定されていないものと見なす。
省略	可

表2‒69　**E-mailラベル**
種別	説明
意味	アラームで実行するアクションでE-mailの実行対象となるアラームイベントを示す。
指定可能値	次の値を指定する。異常時に実行する場合：「Abnormal」警告値に実行する場合：「Warning」正常値に実行する場合：「Normal」複数のアラームイベントで実行したい場合は，状態を示す文字列を「,（半角コンマ）」で区切って指定する。状態の示す文字列は順不同であるが，同じ文字列を指定した場合はエラーとなる。 GeneralサブセクションのCheck Value Existラベルの値を「Y」と指定した場合，「Warning」は指定できない。Advanced SettingサブセクションのRegular Alarmラベルの値を「Y」に指定した場合，「Normal」は指定できない。
省略	可

表2‒70　Commandラベル
種別	説明
意味	アラームで実行するアクションでCommandの実行対象となるアラームイベントを示す。
指定可能値	次の値を指定する。異常時に実行する場合：「Abnormal」警告値に実行する場合：「Warning」正常値に実行する場合：「Normal」複数のアラームイベントで実行したい場合は，状態を示す文字列を「,（半角コンマ）」で区切って指定する。状態の示す文字列は順不同だが，同じ文字列を指定した場合はエラーとなる。 GeneralサブセクションのCheck Value Existラベルの値を「Y」に指定した場合，「Warning」は指定できない。 Advanced SettingサブセクションのRegular Alarmラベルの値を「Y」に指定した場合，「Normal」は指定できない。
省略	可

表2‒71　SNMPラベル
種別	説明
意味	アラームがどのような状態のときにSNMPトラップを通知するかを示す。
指定可能値	次の値を指定する。異常時に実行する場合：「Abnormal」警告値に実行する場合：「Warning」正常値に実行する場合：「Normal」複数のアラームイベントで実行したい場合は，状態を示す文字列を「,（半角コンマ）」で区切って指定する。状態の示す文字列は順不同だが，同じ文字列を指定した場合はエラーとなる。 GeneralサブセクションのCheck Value Existラベルの値を「Y」に指定した場合，「Warning」は指定できない。 Advanced SettingサブセクションのRegular Alarmラベルの値を「Y」に指定した場合，「Normal」は指定できない。
省略	可

表2‒72　JP1 Eventラベル
種別	説明
意味	アクションの実行でJP1イベントを実行する場合の設定を示す。
指定可能値	「Y」または「N」で指定する。「Y」を指定した場合アクションでJP1イベントを実行する。省略または「N」を指定した場合無効となる。 Commandラベルに値が指定されていない場合は，指定しても無視される。
省略	可

Action Definition E-mailサブセクション

アラームイベントが発生時に実行するアクション（E-mail）の設定を指定するサブセクションです。このサブセクションは省略できますが，ActionsサブセクションでE-mailの実行を指定した場合は省略できません。

このサブセクションで指定できるラベルまたはサブサブセクションは次のとおりです。

表2‒73　E-mail Addressラベル
種別	説明
意味	E-mailの送信先を示す。
指定可能値	指定する値は1〜127（単位：バイト）の半角文字。複数の送信先がある場合は「,（半角コンマ）」で区切って指定できる。この場合，全長を127バイトまでにする必要がある。
省略	不可

表2‒74　Action Handlerラベル
種別	説明
意味	E-mailを送信するアクションハンドラのサービスIDを示す。
指定可能値	指定する値は1〜258（単位：バイト）の半角文字。プロダクト名表示機能が有効な場合も，プロダクト名では指定できない。なお，ローカルアクションを指定する場合は「LOCAL」と指定する。
省略	不可

表2‒75　Message Textサブサブセクション
種別	説明
意味	E-mailを送信するメッセージの内容を示す。
指定可能値	指定する値は0〜1000（単位：バイト）の全角文字または半角文字。このサブサブセクションでは，次のセクションまたはサブセクションの始まる行，またはファイルの終端（EOF）の直前までが，定義する値として設定される。ただし，サブサブセクション内にコメントがある場合，コメント部分は除かれる。その上で，サブサブセクションとして有効な最終行にある改行文字は除かれる。
省略	可

Action Definition Commandサブセクション

アラームイベントが発生時に実行するアクション（Command）の設定を指定するサブセクションです。このサブセクションは省略できますが，ActionsサブセクションでCommandの実行を指定し，かつJP1 Eventラベルの値が「N」である場合は，省略できません（JP1 Eventラベルが「Y」の場合に指定すると無視されます）。

このサブセクションで指定できるラベルまたはサブサブセクションは次のとおりです。

表2‒76　Command Nameラベル
種別	説明
意味	アクションで実行するコマンド（スクリプト）名を示す。
指定可能値	指定できる値は，1〜511（単位：バイト）の半角文字。指定する際は，次のディレクトリにあるコマンド（スクリプト）以外は，絶対パスまたはサービスのカレントディレクトリ相対パスで指定する。 Action Handlerサービスのインストール先ディレクトリ環境変数のPATH変数に設定されているパスコマンドのパスやコマンド名に半角空白文字を含む場合は，コマンドのパスやコマンド名までを「"」（ダブルクォーテーション）で囲む。
省略	不可

表2‒77　Action Handlerラベル
種別	説明
意味	コマンドを実行するアクションハンドラのサービスIDを示す。
指定可能値	指定する値は1〜258（単位：バイト）の半角文字。プロダクト名表示機能が有効な場合も，プロダクト名では指定できない。なお，ローカルアクションを指定する場合は「LOCAL」と指定する。
省略	不可

注: アラームのアクションを設定する際，PFM - Web Consoleの［新規アラーム > アクション定義］または［編集 > アクション定義］画面の［コマンド］フィールドの［アクションハンドラ］に「LOCAL」以外を選択すると，PFM - Managerに負荷が集中します。大規模システムで，アラームを契機としてアクションを実行させる場合は，PFM - Managerホストへの負荷集中を防止するために，［新規アラーム > アクション定義］または［編集 > アクション定義］画面の［コマンド］フィールドの［アクションハンドラ］に「LOCAL」を選択するようにしてください。

表2‒78　Message Textサブサブセクション
種別	説明
意味	実行するコマンドに渡すパラメーターを示す。
指定可能値	指定する値は0〜2047（単位：バイト）の全角文字または半角文字。このサブサブセクションでは，次のセクションまたはサブセクションの始まる行の前の行，またはファイルの終端（EOF）の直前までが，定義する値として設定される。ただし，サブサブセクション内にコメントがある場合，コメント部分は除かれる。その上で，サブサブセクションとして有効な最終行にある改行文字は除かれる。
省略	可

Action Definition JP1 Eventサブセクション

アラームイベントが発生時に実行するアクション（JP1イベント）の設定を指定するサブセクションです。このサブセクションは省略できますが，ActionsサブセクションでCommandの実行を指定した場合でかつJP1 Eventラベルに「Y」が指定された場合は，省略できません。

このサブセクションで指定できるラベルは次のとおりです。

表2‒79　Event IDラベル
種別	説明
意味	JP1イベントで送信するイベントIDを示す。
指定可能値	イベントIDは16進数で指定する。指定できる値は0〜1fff，7fff8000〜7fffffff。
省略	不可

表2‒80　Action Handlerラベル
種別	説明
意味	JP1イベントを実行するアクションハンドラを示す。
指定可能値	指定する値は1〜258（単位：バイト）の半角文字。プロダクト名表示機能が有効な場合も，プロダクト名では指定できない。なお，ローカルアクションを指定する場合は「LOCAL」と指定する。
省略	不可

表2‒81　Messageラベル
種別	説明
意味	JP1イベントで送信するメッセージを示す。
指定可能値	0〜1023（単位：バイト）の全角または半角文字を指定する。なお，09-00以前のAction HandlerサービスでJP1イベントを発行する場合は，0〜128（単位：バイト）の全角または半角文字を指定する。
省略	可

表2‒82　Switch Alarm Levelラベル
種別	説明
意味	アラームレベルをJP1イベントの重要度に変換するかを示す。
指定可能値	「Y」または「N」で指定する。省略または「Y」を指定した場合 JP1イベントでアクションのアラームレベルを重要度に変換する。「N」を指定した場合無効となる。
省略	可

表2‒83　Exec Logical Hostラベル
種別	説明
意味	JP1イベントを登録するイベントサーバ名を示す。イベントサーバが論理ホスト起動している場合に指定する。
指定可能値	指定できる値は0〜255（単位：バイト）の半角文字。値を指定しない場合は，省略されたものとする。
省略	可

アラーム定義ファイル記述例

アラーム定義ファイルの記述例を次に示します。

Alarm Definition File Version=0002
Alarm Definition File Code=Shift_JIS
 
[Alarm Data]
[[General]]
Product=T3.0
Alarm Table Name=Example
Alarm Name="CPU Usage"
Message Text="CPU is at %CVS% utilization"
Check Value Exist=N
 
[[Advanced Setting]]
Active Alarm=Y
Regular Alarm=N
Evaluate All Data=N
Notify State=Alarm
Monitoring Regularly=Y
#Monitoring Time=
Damping=Y
Damping Count=2/3
 
#[[Check Value Exist]]
#Record=
#Field=
#Value=
 
[[Alarm Condition Expressions]]
Condition=PI_PCT_TOTAL_PROCESSOR_TIME>90.000000,80.000000
 
[[Actions]]
Report="Reports/Windows/Operating System/Troubleshooting/Real-Time/CPU Usage - Top 10 Processes"
E-mail=Abnormal,Warning
Command=Abnormal
SNMP=Abnormal,Warning,Normal
JP1 Event=N
 
[[Action Definition E-mail]]
E-mail Address=administrator@example.com
Action Handler=PH1host01
[[[Message Text]]]
Date: %SCT
Host: %HNS
 
Product: %PTS
Agent: %ANS
 
Alarm: %AIS (%ATS)
State: %SCS
 
Message: %MTS
[[Action Definition Command]]
Command Name=userprogram.exe
Action Handler=LOCAL
[[[Message Text]]]
%CVS
#[[Action Definition JP1 Event]]
#Event ID=
#Action Handler=
#Message=%MTS
#Switch Alarm Level=Y
#Exec Logical Host=

ページの先頭へ

注意事項

このコマンドは多重実行できません。
Name Serverサービス，Master Managerサービス，View Serverサービスのうち，1つ以上のサービスが停止している場合，このコマンドは実行できません。
１つのアラーム定義ファイルに定義できるアラームの数は最大250個です。
1つのアラームテーブルに定義できるアラームは，すでに定義されているアラームを含めて，最大250個です。1つのアラーム定義ファイル内に定義されているアラームが250個以内でも，すでに定義されているアラームとの合計が250個を超えた時点でエラーになります。
アラーム定義ファイル内に，読み込み専用のアラームテーブル（名称が「PFMで始まるアラームテーブル」）が定義されていた場合，-yオプションが指定されていても，アラーム定義は上書きされないで，エラーになります。
インポートするアラーム定義情報に全角文字が含まれる場合，jpctool alarmコマンドを実行するシェルの文字環境が日本語（Shift JIS コード，EUC コードまたはUTF-8）または中国語簡体字（GB18030コードまたはUTF-8）であり，PFM - Manager起動時の文字環境と一致している必要があります。このコマンドを実行する前に，シェルの文字環境と，PFM - Manager起動時の文字環境を確認してください。
ファイル名に全角文字を指定する場合，コマンドを実行するシェルの文字環境が日本語（Shift JIS コード，EUC コードまたはUTF-8）または中国語簡体字（GB18030コードまたはUTF-8）である必要があります。このコマンドを実行する前に，シェルの文字環境を確認してください。
PFM - Managerを論理ホスト運用している場合は，実行系ノードで実行してください。
jpctool alarmコマンドを使用してアラーム定義ファイルを作成すると，最大250個のアラームを一度に定義できます。

大規模システムで複数のサーバに一括してアラームを設定するときなどに使用します。

なお，インポートできるインポートファイルのアラームテーブルが混在した場合でも，最大250個のアラームとなります。

次の場合はインポートできます。

インポートファイル1

アラームテーブルA 定義されているアラーム数：100

アラームテーブルB 定義されているアラーム数：150

次の場合はインポートできません。

インポートファイル2

アラームテーブルA 定義されているアラーム数：200

アラームテーブルB 定義されているアラーム数：150
監視二重化の場合，セカンダリーのPFM - Managerからの実行はできません。
インスタンスごとの状態変化を通知する機能に対応していないエージェントにバインドされているアラームテーブルを指定した場合に，インスタンスごとに状態変化を通知しているアラームがあるときには，アラームごとにKAVE05970-Eメッセージが出力されます。
インポートするアラーム定義ファイルのAlarm Definition File Versionラベルには，「0001」または「0002」が設定されている必要があります。それ以外のバージョンのアラーム定義ファイルが指定されている場合は，エラーメッセージが出力されます。
インポートするアラーム定義ファイルに，インスタンスごとに状態変化を通知するアラームが定義されている場合は，アラーム定義ファイルのAlarm Definition File Versionラベルに「0002」が設定されている必要があります。

PFM - Manager 10-10以降でエクスポートしたアラーム定義ファイルをPFM - Manager 10-00以前でインポートする場合には，アラーム定義ファイルを修正する必要があります。アラーム定義ファイルの修正内容を次の表に示します。

修正個所	修正前の設定値	修正内容
Alarm Definition File Version	0002	「0001」に変更してください。
Notify State	Alarm`\|`Instance	PFM - Manager 10-00以前では，インスタンスごとの状態変化の通知は定義できないため，削除してください。

アラームによる監視の停止と監視対象システムの停止を続けて実行する場合の注意事項については，「jpctool alarmコマンド実行時の注意事項」を参照してください。

ページの先頭へ

戻り値

0	正常終了した。
1	引数の指定に誤りがある。
2	コマンドの実行権限がない。
3	Name Serverサービス，Master Managerサービス，View Serverサービスのうち，1つ以上のサービスが起動していない。
4	同一マシン上で起動停止コマンドまたはほかのセットアップコマンドが実行されている。
5	PFM - Managerホスト以外で実行された。または，監視二重化の場合に，セカンダリーのPFM - Managerから実行しようとした。
6	アラーム定義ファイルの内容に誤りがある。
11	ユーザーによって処理が中止された。
13	インスタンスごとの状態変化を通知する機能に対応していないエージェントにバインドされているため，インスタンスごとの状態変化の通知機能は設定できない。
100	Performance Managementの環境が不正である。
200	メモリーが不足している。
210	ディスク容量が不足している。
211	アラーム定義ファイルにアクセスできない。または，アラームが更新中のためアラームの定義，更新に失敗した。
222	通信処理でエラーが発生した。
223	通信処理でタイムアウトが発生した。
255	予期しないエラーが発生した。

ページの先頭へ

使用例

/tmpディレクトリに格納されているアラーム定義ファイルalarmtest1.cfgを，インポートする場合のコマンド実行例を次に示します。

jpctool alarm import -f /tmp/alarmtest1.cfg

ページの先頭へ