jpcalarm export

形式

jpcalarm export    -f エクスポート先のファイル名
                 {-key サービスキー
                [-table アラームテーブル名[-alarm アラーム名]]|
                 -template}
                [-y|-n]

機能

jpcalarm exportコマンドは,アラームの定義情報を,指定されたファイルにエクスポートするコマンドです。

アラーム定義情報は,アラーム定義ファイルの構文に従ってエクスポートされます。アラーム定義ファイルの構文については,マニュアル「JP1/Performance Management システム構築・運用ガイド」の,アラームによる稼働監視について説明している章を参照してください。

-keyオプション,-tableオプション,-alarmオプションの指定の組み合わせと,エクスポートされるアラーム定義情報の範囲の関係を,次の表に示します。

表2-11 オプション指定の組み合わせと,エクスポートされる情報の関係

オプションの指定エクスポートされる情報
-key-table-alarm
××-keyオプションで指定したPFM - Agentに対して定義されているアラームテーブルのアラーム定義情報すべてがエクスポートされる。
×-tableオプションで指定したアラームテーブル内のアラームの定義情報すべてがエクスポートされる。
-alarmオプションで指定したアラームの定義情報だけがエクスポートされる。
(凡例)
○:指定あり
×:指定なし

また,-templateオプションを指定することで,アラーム定義ファイルに定義するラベルがすべて入力されている,テンプレートファイルを出力することもできます。

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

PFM - Manager

実行権限

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

格納先ディレクトリ

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

引数

-f エクスポート先のファイル名

アラーム定義情報のエクスポート先のファイル名を指定します。ファイル名は,相対パスでも絶対パスでも指定できます。

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

 % - ( ) _ . @ [ ]

ただし,半角空白文字を含む場合は「"」(半角引用符)で囲んでください。また,半角記号を指定する場合は,必要に応じてエスケープ表記をしてください。

-key サービスキー

アラーム定義情報をエクスポートしたいPFM - Agentのサービスキーを指定します。ここで指定できるサービスキーは,PFM - Agentのサービスキーだけです。PFM - Agentのサービスキーについては,各PFM - Agentマニュアルの,付録に記載されている識別子一覧を参照してください。

-templateオプションと同時に指定できません。

-table アラームテーブル名

エクスポートするアラーム定義情報を持つアラームテーブル名を指定します。

1~64バイトの全角文字,半角英数字,半角空白文字,または次に示す半角記号を指定できます。

 % - ( ) _ . / @ [ ]

ただし,半角空白文字を含む場合は「"」(半角引用符)で囲んでください。また,半角記号を指定する場合は,必要に応じてエスケープ表記をしてください。

ワイルドカード文字は使用できません。

-templateオプションと同時に指定できません。

-alarm アラーム名

エクスポートするアラーム定義情報のアラーム名を指定します。

1~20バイトの全角文字,半角英数字,半角空白文字,または次に示す半角記号を指定できます。

 % - ( ) _ . / @ [ ]

ただし,半角空白文字を含む場合は「"」(半角引用符)で囲んでください。また,半角記号を指定する場合は,必要に応じてエスケープ表記をしてください。

ワイルドカード文字は使用できません。

-templateオプションと同時に指定できません。

-template

アラーム定義ファイルのテンプレートを出力することを指定します。

-keyオプション,-tableオプション,-alarmオプションと同時に指定できません。

-y|-n

-fオプションで指定したアラーム定義ファイルがすでにある場合,強制的に上書きするかどうかを指定します。

「-y」を指定すると,アラーム定義ファイルが強制的に上書きされます。

「-n」を指定すると,上書き処理がスキップされます。

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

注意事項

戻り値

0正常終了した。
1引数の指定に誤りがある。
2コマンドの実行権限がない。
3Name Serverサービス,Master Managerサービス,View Serverサービスのうち,一つ以上のサービスが起動していない。
4同一マシン上で起動停止コマンドまたはほかのセットアップコマンドが実行されている。
5指定されたPFM - Agentがセットアップされていない。
6指定されたアラームテーブルまたはアラームがない。または,指定されたサービスキーのエージェントにアラーム定義がない。
11ユーザーによって処理が中止された。
100Performance Managementの環境が不正である。
200メモリーが不足している。
211エクスポート先のファイルにアクセスできない。
222通信処理でエラーが発生した。
223通信処理でタイムアウトが発生した。
255予期しないエラーが発生した。

使用例1

PFM - Agent for Platform(UNIX)で,ソリューションセット以外のアラームテーブルalarmtable1が定義されていると仮定します。また,アラームテーブルalarmtable1には,アラームalarm1が定義されていると仮定します。

このとき,PFM - Agent for Platform(UNIX)で定義されているアラーム定義すべてを,/tmpディレクトリの下のファイルalarmtable1.cfgにエクスポートする場合のコマンド実行例を次に示します。

jpcalarm export -f /tmp/alarmtable1.cfg -key agtu

出力結果1(alarmtable1.cfg)

Alarm Definition File Version=0001
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にエクスポートする場合のコマンド実行例を次に示します。

jpcalarm export -f /tmp/alarm2.cfg -key agtu -table "PFM UNIX Solution Alarms 8.00" -alarm "Disk Service Time"

出力結果2(alarm2.cfg)

Alarm Definition File Version=0001
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に出力する場合のコマンド実行例を次に示します。

jpcalarm export -f /tmp/template3.cfg -template

出力結果3(template3.cfg)

#Alarm Definition File Version=0001
#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
#Monitoring Regulary=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=