jpctool alarm export
形式
jpctool alarm export -f エクスポート先のファイル名 {-key サービスキー [-table アラームテーブル名[-alarm アラーム名]] [-only]| -template} [-y|-n] [-wait 秒数]
機能
jpctool alarm exportコマンドは,アラームの定義情報を,指定されたファイルにエクスポートするコマンドです。
アラーム定義情報は,アラーム定義ファイルの構文に従ってエクスポートされます。アラーム定義ファイルの構文については,マニュアル「JP1/Performance Management 運用ガイド」の,アラームによる稼働監視について説明している章を参照してください。
-keyオプション,-tableオプション,-alarmオプションの指定の組み合わせと,エクスポートされるアラーム定義情報の範囲の関係を,次の表に示します。
オプションの指定 |
エクスポートされる情報 |
||
---|---|---|---|
-key |
-table |
-alarm |
|
○ |
× |
× |
-keyオプションで指定したPFM - AgentまたはPFM - RMに対して定義されているアラームテーブルのアラーム定義情報すべてがエクスポートされる。 |
○ |
○ |
× |
-tableオプションで指定したアラームテーブル内のアラームの定義情報すべてがエクスポートされる。 |
○ |
○ |
○ |
-alarmオプションで指定したアラームの定義情報だけがエクスポートされる。 |
- (凡例)
-
○:指定あり
×:指定なし
また,-templateオプションを指定することで,アラーム定義ファイルに定義するラベルがすべて入力されている,テンプレートファイルを出力することもできます。
コマンドを実行できるホスト
PFM - Manager
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー
- UNIXの場合
-
rootユーザー権限を持つユーザー
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pc/tools/
引数
-f エクスポート先のファイル名
アラーム定義情報のエクスポート先のファイル名を指定します。ファイル名は,相対パスでも絶対パスでも指定できます。
全角文字,半角英数字,半角空白文字,または次に示す半角記号を指定できます。
% - ( ) _ . @ [ ]
ただし,半角空白文字を含む場合は「"」(ダブルクォーテーション)で囲んでください。また,半角記号を指定する場合は,必要に応じてエスケープ表記をしてください。
-key サービスキー
アラーム定義情報をエクスポートしたいPFM - AgentまたはPFM - RMのサービスキーを指定します。プロダクト名表示機能が有効な場合はプロダクト名でも指定できます。ここで指定できるサービスキーは,PFM - AgentまたはPFM - RMのサービスキーだけです。PFM - AgentまたはPFM - RMのサービスキーについては,マニュアル「JP1/Performance Management 設計・構築ガイド」の付録の,命名規則について説明している個所を参照してください。
-templateオプションと同時に指定できません。
-table アラームテーブル名
エクスポートするアラーム定義情報を持つアラームテーブル名を指定します。
1〜64バイトの全角文字,半角英数字,半角空白文字,または次に示す半角記号を指定できます。
% - ( ) _ . / @ [ ]
ただし,半角空白文字を含む場合は「"」(ダブルクォーテーション)で囲んでください。また,半角記号を指定する場合は,必要に応じてエスケープ表記をしてください。
ワイルドカード文字は使用できません。
-templateオプションと同時に指定できません。
-alarm アラーム名
エクスポートするアラーム定義情報のアラーム名を指定します。
1〜20バイトの全角文字,半角英数字,半角空白文字,または次に示す半角記号を指定できます。
% - ( ) _ . / @ [ ]
ただし,半角空白文字を含む場合は「"」(ダブルクォーテーション)で囲んでください。また,半角記号を指定する場合は,必要に応じてエスケープ表記をしてください。
ワイルドカード文字は使用できません。
-templateオプションと同時に指定できません。
-only
ユーザー定義のアラームテーブルだけ出力することを指定します※。このオプションを指定して出力したファイルは,jpctool alarm importコマンドでインポートするアラーム定義ファイルとして使用できます。
- 注※
-
監視テンプレート(名称が「PFM」で始まるアラームテーブル)は出力されません。
-templateオプションと同時に指定できません。
-template
アラーム定義ファイルのテンプレートを出力することを指定します。
-keyオプション,-tableオプション,-alarmオプション,-onlyオプションと同時に指定できません。
-y|-n
-fオプションで指定したアラーム定義ファイルがすでにある場合,強制的に上書きするかどうかを指定します。
「-y」を指定すると,アラーム定義ファイルが強制的に上書きされます。
「-n」を指定すると,上書き処理がスキップされます。
指定を省略した場合,アラーム定義ファイルを上書きしてもよいかを確認するメッセージが出力されます。
-wait 秒数
同時に実行できないコマンドが実行中の場合の,最大待機秒数を指定します。この引数は,起動情報ファイル(jpccomm.ini)でアラームコマンドの実行を待機する設定(Alarm Command Wait Mode)を有効にしている場合で,jpccomm.iniファイルでの設定とは異なる秒数を指定したいときに使用します。1〜3600の数字で指定します。
指定を省略した場合,jpccomm.iniファイルでの設定秒数で動作します。
同時に実行できないコマンドについては,「アラームコマンドが同時に実行できないコマンド」を,jpccomm.iniファイルおよびAlarm Command Wait Modeについては,「起動情報ファイル(jpccomm.ini)」を参照してください。
アラーム定義ファイルの形式
コマンド「jpctool alarm import」の「アラーム定義ファイルの形式」の記載個所を参照してください。
注意事項
-
このコマンドは多重実行できません。
-
-key,-table,または-alarmオプションを指定して,既存のアラーム定義情報をエクスポートする場合は,あらかじめPFM - Manager(Name Serverサービス,Master Managerサービス,およびView Serverサービス)を起動しておく必要があります。なお,-templateオプションを指定してテンプレートを出力する場合は,PFM - Managerを起動しておく必要はありません。
-
PFM - AgentまたはPFM - RMの監視テンプレートには,異常値と警告値の条件が異なるアラームが含まれていることがあります。この場合,監視テンプレートをエクスポートすると,条件は警告値の条件が優先してエクスポートされます。
例えば,異常値の条件式が「BBB >= 90」,警告値の条件式が「BBB > 80」と定義されているとします。このアラーム定義をエクスポートすると,アラーム定義ファイルには,次のように警告値の条件である「>」が出力されます。
[[Alarm Condition Expressions]] Condition=BBB>90,80
監視テンプレートの異常値と警告値の条件の設定については,各PFM - AgentまたはPFM - RMマニュアルの,監視テンプレートについて説明している章を参照してください。
-
251個以上のアラーム定義でも,一度にエクスポートできます。ただし,1つのアラーム定義ファイルに定義できるアラームは最大250個のため,このファイルはそのままインポートできません。251個以上のアラーム定義をエクスポートした場合は,アラーム定義ファイルを分割するなどして,アラーム定義を250個以内にしてからインポートしてください。
例えば,-keyオプションを指定して,PFM - AgentまたはPFM - RMにバインドされたアラームテーブル「AlarmTable1(アラーム数200個)」および「AlarmTable2(アラーム数100個)」のアラームの定義情報をエクスポートした場合,アラーム定義ファイルには,アラームテーブル「AlarmTable1」および「AlarmTable2」の合計300個のアラームの定義情報がエクスポートされます。しかし,アラーム定義ファイルに記載できるアラームの定義情報は最大250個であるため,このファイルをインポートする場合は,アラーム定義ファイル内のアラーム定義の数を250個以内にする必要があります。
-
エクスポートするアラーム定義情報に全角文字が含まれる場合,jpctool alarmコマンドを実行するシェルの文字環境が日本語(Shift JIS コード,EUC コードまたはUTF-8)または中国語簡体字(GB18030コードまたはUTF-8)であり,PFM - Manager起動時の文字環境と一致している必要があります。このコマンドを実行する前に,シェルの文字環境と,PFM - Manager起動時の文字環境を確認してください。
-
ファイル名に全角文字を指定する場合,コマンドを実行するシェルの文字環境が日本語(Shift JIS コード,EUC コードまたはUTF-8)または中国語簡体字(GB18030コードまたはUTF-8)である必要があります。このコマンドを実行する前に,シェルの文字環境を確認してください。
-
PFM - Managerを論理ホスト運用している場合は,実行系ノードで実行してください。
-
インスタンスごとの状態変化の通知が設定されていないアラームを含むアラームテーブルを指定した場合,エクスポートされるアラーム定義ファイルのNotify Stateラベルには「Alarm」が設定されます。
-
[新規アラーム > アクション定義]画面または[編集 > アクション定義]画面の[コマンドの定義]エリアでJP1イベントの発行を正しく設定している場合でも,このコマンドでエクスポートしたJP1 Eventラベルの値が「N」と出力されることがあります(例えば-rオプションの値を「"」で囲んでいないときなど)。このとき,実際は,アラームのアクションはJP1イベントを発行するように設定されており,また,「N」と出力されているファイルをインポートしても,アラームのアクションにJP1イベントの発行が設定されるため,問題ありません。
-
アラーム定義ファイルの文字コードおよびアラーム定義ファイル内のAlarm Definition File Codeラベルの値は,コマンドを実行したシェルのLANG環境変数の値に合わせて決定されます。エクスポートするアラームの定義内容にASCIIコード以外の文字が含まれる場合,このコマンドを実行する前にシェルのLANG環境変数の値を確認してください。
LANG 環境変数の値と,文字コードおよびAlarm Definition File Codeラベルの値の対応をOSごとの表に示します。
なお,表に示されていない値がLANG環境変数に指定されている場合,LANG=Cとして処理されます。
表3‒45 LANG環境変数の値と文字コードおよびAlarm Definition File Codeラベルの値の対応(Windowsの場合) 言語
LANG環境変数の値
文字コード
Alarm Definition File Codeラベルの値
日本語
−
Shift_JIS(SJIS)
Shift_JIS
英語
−
ASCII
C
中国語(簡体字)
−
GB18030
GB18030
(凡例)
−:該当しない
表3‒46 LANG環境変数の値と文字コードおよびAlarm Definition File Codeラベルの値の対応(Linuxの場合) 言語
LANG環境変数の値
文字コード
Alarm Definition File Codeラベルの値
日本語
-
ja_JP.SJIS※
-
ja_JP.sjis※
Shift_JIS(SJIS)
Shift_JIS
-
ja_JP.UTF-8
-
ja_JP.utf8
UTF-8
UTF-8
英語
-
C
ASCII
C
中国語(簡体字)
-
zh_CN.gb18030
GB18030
GB18030
-
zh_CN.UTF-8
-
zh.CN.utf8
UTF-8
UTF-8
注※ SUSE Linuxだけ使用できます。
-
戻り値
0 |
正常終了した。 |
1 |
引数の指定に誤りがある。 |
2 |
コマンドの実行権限がない。 |
3 |
Name Serverサービス,Master Managerサービス,View Serverサービスのうち,1つ以上のサービスが起動していない。 |
4 |
同一マシン上で起動停止コマンドまたはほかのセットアップコマンドが実行されている。 |
5 |
PFM - Managerホスト以外で実行された。または,エクスポートするアラームの対象となるエージェントがセットアップされていない。 |
6 |
指定されたアラームテーブルまたはアラームがない。または,指定されたサービスキーのエージェントにアラーム定義がない。 |
11 |
ユーザーによって処理が中止された。 |
100 |
Performance Managementの環境が不正である。 |
200 |
メモリーが不足している。 |
210 |
ディスク容量が不足している。 |
211 |
エクスポート先のファイルにアクセスできない。 |
222 |
通信処理でエラーが発生した。 |
223 |
通信処理でタイムアウトが発生した。 |
255 |
予期しないエラーが発生した。 |
使用例1
PFM - Agent for Platform(UNIX)で,監視テンプレート以外のアラームテーブルalarmtable1が定義されていると仮定します。また,アラームテーブルalarmtable1には,アラームalarm1が定義されていると仮定します。
このとき,PFM - Agent for Platform(UNIX)で定義されているアラーム定義すべてを,/tmpディレクトリの下のファイルalarmtable1.cfgにエクスポートする場合のコマンド実行例を次に示します。
jpctool alarm export -f /tmp/alarmtable1.cfg -key UNIX
出力結果1(alarmtable1.cfg)
Alarm Definition File Version=0002 Alarm Definition File Code=EUC-JP [Alarm Data] [[General]] Product=U3.0 Alarm Table Name="PFM UNIX Solution Alarms 8.00" Alarm Name="Disk Service Time" Message Text="Average disk service time is %CVS secs" Check Value Exist=N : [Alarm Data] [[General]] Product=U4.0 Alarm Table Name=alarmtable1 Alarm Name=alarm1 Message Text= Check Value Exist=N :
使用例2
PFM - Agent for Platform(UNIX)で,監視テンプレートPFM UNIX Solution Alarms 8.00に定義されているアラームのうち,Disk Service Timeアラームの定義を,/tmpディレクトリの下のファイルalarm2.cfgにエクスポートする場合のコマンド実行例を次に示します。
jpctool alarm export -f /tmp/alarm2.cfg -key UNIX -table "PFM UNIX Solution Alarms 8.00" -alarm "Disk Service Time"
出力結果2(alarm2.cfg)
Alarm Definition File Version=0002 Alarm Definition File Code=EUC-JP [Alarm Data] [[General]] Product=U3.0 Alarm Table Name="PFM UNIX Solution Alarms 8.00" Alarm Name="Disk Service Time" Message Text="Average disk service time is %CVS secs" Check Value Exist=N :
使用例3
アラーム定義ファイルのテンプレートを,/tmpディレクトリの下のファイルtemplate3.cfgに出力する場合のコマンド実行例を次に示します。
jpctool alarm export -f /tmp/template3.cfg -template
出力結果3(template3.cfg)
Alarm Definition File Version=0002 Alarm Definition File Code= [Alarm Data] [[General]] Product= Alarm Table Name= Alarm Name= Message Text= Check Value Exist=N [[Advanced Setting]] Active Alarm=Y Regular Alarm=Y Evaluate All Data=N Notify State=Alarm Monitoring Regularly=N Monitoring Time= Damping=N Damping Count= [[Check Value Exist]] Record= Field= Value= [[Alarm Condition Expressions]] Condition= [[Actions]] Report= E-mail=Abnormal,Warning,Normal Command=Abnormal,Warning,Normal SNMP=Abnormal,Warning,Normal JP1 Event=N [[Action Definition E-mail]] E-mail Address= Action Handler= [[[Message Text]]] Date: %SCT Host: %HNS Product: %PTS Agent: %ANS Alarm: %AIS (%ATS) State: %SCS Message: %MTS [[Action Definition Command]] Command Name= Action Handler= [[[Message Text]]] [[Action Definition JP1 Event]] Event ID= Action Handler= Message=%MTS Switch Alarm Level=Y Exec Logical Host=