JP1/Performance Management リファレンス

jpctool db dump

形式

jpctool db dump     -id サービスID
                    [-host ホスト名]
                    [-lhost 論理ホスト名]
                    -stime 開始日時
                    -etime 終了日時
                    -f エクスポートファイル名
                    -dbid データベースID
                    -rec レコードタイプ
                    [-localtime]
                    [-proxy {y|n}]
                    [-direct]
                    [-alone]

機能

jpctool db dumpコマンドは，Master Storeサービス，Agent Storeサービス，またはRemote Monitor Storeサービスのデータベースに格納されているデータをテキストファイルにエクスポートするコマンドです。エクスポートは，データベースごとに実行します。

このコマンドを実行すると，デフォルトでは，次のダンプディレクトリにエクスポートファイルが作成されます。

Master Storeサービスのデータベースに格納されたデータをエクスポートした場合

Windows：インストール先フォルダ\mgr\store\dump\

UNIX：/opt/jp1pc/mgr/store/dump/

Agent StoreおよびRemote Monitor Storeサービスのデータベースに格納されたデータをエクスポートした場合

Windows：インストール先フォルダ\xxxx^※1\store[\インスタンス名]^※2\dump\

UNIX：/opt/jp1pc/xxxx^※1/store[/インスタンス名]^※2/dump/

注※1

「xxxx」は，各PFM - AgentまたはPFM - RMのサービスキーを示します。サービスキーについては，マニュアル「JP1/Performance Management 設計・構築ガイド」の付録の，命名規則について説明している個所を参照してください。

注※2

一つのホスト上で複数のサービスのセットを起動できるアプリケーションプログラムを監視するPFM - AgentまたはPFM - RMの場合，インスタンス名のディレクトリがあります。

エクスポートファイル名は，エクスポートファイル名オプションで指定したファイル名で作成されます。

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

PFM - Manager

PFM - Agent

PFM - Base

PFM - RM

実行権限

Windowsの場合

なし

UNIXの場合

なし

格納先ディレクトリ

Windowsの場合

インストール先フォルダ\tools\

UNIXの場合

/opt/jp1pc/tools/

引数

-id サービスID

Master Storeサービス，Agent Storeサービス，またはRemote Monitor StoreサービスのサービスID（2文字目が「S」）を指定します。1～258バイトで指定します。

ワイルドカード文字を使用して，複数のサービスIDを指定することもできます。この場合，あるサービスがエラーとなっても，残りのサービスに対して処理が続行されます。また，複数のサービスに対してエラーが発生した場合，最後に発生したエラーに対する戻り値が返されます。

-host ホスト名

Master Storeサービス，Agent Storeサービス，またはRemote Monitor Storeサービスが動作しているホスト名を指定します。特定のホストのデータをエクスポートする場合にこの引数を使用します。1～32バイトの半角英数字で指定します。このオプションで指定したホスト上にエクスポートファイルが作成されます。空白文字は，指定できません。このオプションの指定を省略した場合，ローカルホストが仮定されます。

ワイルドカード文字を使用して，複数のホスト名を指定することもできます。

-lhost 論理ホスト名

このコマンドを実行するホストを，物理ホスト環境ではなく論理ホスト環境とする場合にその論理ホスト名を指定します。1～32バイトの半角英数字で指定します。空白文字は，指定できません。指定を省略した場合，物理ホストが仮定されます。ワイルドカード文字は使用できません。

-stime 開始日時

エクスポートするデータの開始日時を指定します。「YYYY/MM/DD hh:mm」形式で指定します。各値の意味を次に示します。

YYYY
西暦年を指定します。指定できる値は，1970～2035（単位：西暦年）です。

MM
月を指定します。指定できる値は，01～12（単位：月）です。

DD
日を指定します。指定できる値は，01～31（単位：日）です。

hh
時を指定します。指定できる値は，00～23（単位：時）です。

mm
分を指定します。指定できる値は，00～59（単位：分）です。

指定できる日時の範囲は，GMTで「1970/01/01 00:00」から「2035/12/31 23:59」です。-localtimeオプションが指定されていない場合は，指定した値がそのままGMTとして扱われるため，指定できる日時の範囲は「1970/01/01 00:00」から「2035/12/31 23:59」となります。-localtimeオプションを指定している場合は，GMTでの日時が左記の範囲内である必要があります。例えばローカルタイムが日本の標準時（GMT+9）の場合，「1970/01/01 09:00」から「2036/01/01 08:59」となります。

開始日時には，終了日時よりも前の日時を指定してください。

-etime 終了日時

エクスポートするデータの終了日時を指定します。「YYYY/MM/DD hh:mm」形式で指定します。各値の意味を次に示します。

YYYY
西暦年を指定します。指定できる値は，1970～2035（単位：西暦年）です。

MM
月を指定します。指定できる値は，01～12（単位：月）です。

DD
日を指定します。指定できる値は，01～31（単位：日）です。

hh
時を指定します。指定できる値は，00～23（単位：時）です。

mm
分を指定します。指定できる値は，00～59（単位：分）です。

指定できる日時の範囲は，GMTで「1970/01/01 00:00」から「2035/12/31 23:59」です。-localtimeオプションが指定されていない場合は，指定した値がそのままGMTとして扱われるため，指定できる日時の範囲は「1970/01/01 00:00」から「2035/12/31 23:59」となります。-localtimeオプションを指定している場合では，GMT での日時が左記の範囲内である必要があります。例えばローカルタイムが日本の標準時（GMT+9）の場合，「1970/01/01 09:00」から「2036/01/01 08:59」となります。

終了日時には，開始日時よりもあとの日時を指定してください。

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

エクスポートファイル名を指定します。ディレクトリ名を除くファイル名を1～31バイトで指定します。半角英数字または半角記号で指定します。ただし，次の記号および空白文字は，指定できません。
/ \ : ; , * ? ' " < > |
次の記号を指定する場合，シェルまたはコマンドプロンプトで解析されるのを防ぐため，" "で囲んで指定してください。
& ^ ( ) `
すでに同じ名前のファイルがある場合，上書きされます。

-dbid データベースID

データをエクスポートするデータベースのデータベースIDを指定します。指定できるデータベースIDを次に示します。

PI：Agent StoreおよびRemote Monitor StoreサービスのPIレコードタイプのデータベース

PD：Agent StoreおよびRemote Monitor StoreサービスのPDレコードタイプのデータベース

PL：Agent StoreおよびRemote Monitor StoreサービスのPLレコードタイプのデータベース

PA：Master Storeサービスのデータベース

-rec レコードタイプ

エクスポートするレコードタイプを指定します。1～8バイトの半角英数字で指定します。空白文字は，指定できません。ワイルドカード文字を使用して，複数のレコードタイプを指定することもできます。

例えば，PFM - Agent for Platform（Windows）のProcessor Overview（PI_PCSR）レコードのデータをエクスポートする場合，「PCSR」と指定します。レコードタイプについては，各PFM - AgentまたはPFM - RMマニュアルの，レコードについて説明している章（レコード一覧）を参照してください。

指定したレコードタイプがなかった場合，ファイルサイズが0のエクスポートファイルが作成され，コマンドは正常終了します。

-localtime

エクスポート開始日時と終了日時を，コマンドを実行したホストのタイムゾーンの日時に設定します。

指定を省略した場合，エクスポート開始日時と終了日時はGMTに設定されます。

-proxy {y|n}

リモートホストのPFM - AgentまたはPFM - RMと直接通信できない環境で，-hostオプションにリモートホストを指定した場合，PFM - Managerを経由するかどうかを指定します。

「y」を指定すると，PFM - Managerを経由して対象となるStoreサービスのステータスを確認します。ファイアウォール環境など，Storeサービスとの間で直接通信ができない場合に指定してください。

「n」を指定すると，PFM - Managerを経由しないで対象となるStoreサービスのステータスを確認します。

-direct

Master Managerサービスを経由しないで，Master Storeサービス，Agent Storeサービス，またはRemote Monitor Storeサービスのデータベースに対してエクスポート処理を実行します。このオプションを指定した場合，Name ServerサービスおよびMaster Managerサービスが起動している必要があります。また，コマンドを実行するホストと対象となるStoreサービスとの間で直接通信できる必要があります。

-proxyオプションまたは-aloneオプションと同時に指定できません。

-alone

ローカルホスト上のMaster Storeサービス，Agent Storeサービス，またはRemote Monitor Storeサービスのデータベースに対してエクスポート処理を実行します。別ホスト上のMaster Storeサービス，Agent Storeサービス，またはRemote Monitor Storeサービスのデータベースに対してはエクスポート処理を実行できません。このオプションを指定した場合，PFM - Managerが動作していなくてもエクスポート処理が実行できます。

-proxyオプション，-directオプション，または-hostオプションと同時に指定できません。

エクスポートファイルに出力される情報

エクスポートファイルには，次の情報が出力されます。

プロダクト情報

フィールド名

データ

エクスポートファイルに出力されるPAデータベースのフィールドについて，次の表に示します。

フィールド名説明

PA_NODE_NAME イベントを発行したエージェントのサービスIDを示す。

PA_HOST_NAME イベントを発行したエージェントのホスト名を示す。

PA_CURR_STATE イベントの状態を示す。

1：状態が「OK」

2：状態が「Warning」

3：状態が「Exception」

PA_ALARM_NAME アラーム名を示す。アラームイベントではない場合は，「n/a」となる。

PA_ALARM_TABLE_NAME アラームテーブル名を示す。アラームイベントではない場合は，「n/a」となる。

PA_MESSAGE_TEXT イベントのメッセージテキストを示す。

そのほかのフィールドについては，各PFM - AgentまたはPFM - RMマニュアルの，レコードについて説明している章（各レコードのフィールド一覧）を参照してください。PFM - AgentまたはPFM - RMマニュアルでも説明されていないフィールドは，内部処理で使用されるフィールドです。

フィールド名	説明
PA_NODE_NAME	イベントを発行したエージェントのサービスIDを示す。
PA_HOST_NAME	イベントを発行したエージェントのホスト名を示す。
PA_CURR_STATE	イベントの状態を示す。 1：状態が「OK」 2：状態が「Warning」 3：状態が「Exception」
PA_ALARM_NAME	アラーム名を示す。アラームイベントではない場合は，「n/a」となる。
PA_ALARM_TABLE_NAME	アラームテーブル名を示す。アラームイベントではない場合は，「n/a」となる。
PA_MESSAGE_TEXT	イベントのメッセージテキストを示す。

コマンド実行時に必要なディスク占有量

このコマンドは，実行時に一時ファイルを作成します。コマンド実行に必要なディスク占有量については，マニュアル「JP1/Performance Management 設計・構築ガイド」の付録を参照してください。

注意事項

引数は，引数の説明の記載順に指定してください。指定順が異なると，正しく認識されません。

次の場合，このコマンドは実行できません。

Name Serverサービス，Master Managerサービス，指定したいMaster Storeサービス，指定したいAgent Storeサービス，または指定したいRemote Monitor Storeサービスが停止している場合

指定したいMaster Storeサービス，指定したいAgent Storeサービス，または指定したいRemote Monitor Storeサービスのデータベースのデータがバックアップ中の場合

指定したいMaster Storeサービス，指定したいAgent Storeサービス，または指定したいRemote Monitor Storeサービスのデータベースのデータがエクスポート中の場合

jpctool db backupコマンドまたはjpctool db dumpコマンドを同時に実行する場合は，-directオプションまたは-aloneオプションを指定して実行してください。オプションを省略した場合これらのコマンドは同時に実行できないので，バックアップ処理またはエクスポート処理を複数回行う場合は，前のコマンド処理が完了するまで，次の処理を実行しないでください。
-directオプションまたは-aloneオプションを省略してjpctool db backupコマンドまたはjpctool db dumpコマンドを実行する場合は，複数ホストからの実行ではなく，単独ホストから実行してください。

jpctool dbおよびjpctool serviceコマンドでは，サービスIDまたは-hostオプションにワイルドカード文字を指定できます。複数のエージェントに対してバックアップ処理またはエクスポート処理を同時に実行したい場合は，サービスIDまたは-hostオプションにワイルドカード文字を使用して実行してください。

（例1）複数のエージェントに対してjpctool db backupコマンドを実行する場合

PFM - Agent for Platform（Windows）のすべてのエージェントに対してバックアップファイルを作成する場合のコマンド実行例を次に示します。

jpctool db backup -id "TS*" -host "*"

（例2）複数のホストに対してjpctool db dumpコマンドを実行する場合

PFM - Agent for Platform（Windows）の全ホストのProcessor Overview（PI_PCSR）レコードに格納されているデータのうち，2006年7月1日午前0時（GMT）から2006年7月31日午前0時（GMT）までのデータをファイル「PI.out」にエクスポートする場合のコマンド実行例を次に示します。

jpctool db dump -id "TS*" -host "*" -stime 2006/07/01 00:00 -etime 2006/07/31 00:00 -f PI.out -dbid PI -rec PCSR

コマンドを実行したあと，同じMaster Storeサービス，Agent Storeサービス，またはRemote Monitor Storeサービスに対して同じエクスポートファイル名を指定してコマンドを再実行すると，出力結果が上書きされます。

エクスポートするデータの量が多い場合，エクスポート処理に時間が掛かるときがあります。

このコマンド実行時に作成される一時ファイルが2ギガバイトを超えるデータはエクスポートできません。一時ファイルが2ギガバイトを超える場合には，エクスポートする期間やレコードを分割してエクスポートしてください。

メッセージKAVE05234-Eが出力される場合，多量のデータ処理に時間が掛かり，通信時にタイムアウトになったことを示します。このメッセージが頻繁に表示される場合，次の方法で対処をしてください。

jpctool db dumpコマンドのオプションで指定する開始日時および終了日時の間隔を狭め，エクスポートするデータを減らす。

jpctool db dumpコマンドのオプションで指定するレコードタイプに，ワイルドカード文字を使用しないで特定のレコードタイプを指定する。

メッセージKAVE05234-Eが出力された場合で，かつ複数のホストでjpctool db dumpコマンドを実行している場合は，このコマンドを実行する際に，-directオプションまたは-aloneオプションを指定して実行してください。

エクスポート中のAgent StoreおよびRemote Monitor Storeサービスについての履歴レポートは，PFM - Web Consoleで表示できない場合があります。エクスポート完了後，履歴レポートを再表示してください。

データベースIDオプションに「PA」を指定して，jpctool db dumpコマンドを実行すると，エクスポートファイルの一部で文字が不正に表示されますが，内部処理で使用しているコードが出力されたものなので，運用上問題ありません。

エクスポートファイルに出力されるフィールド名などのデータ間は，「|」で区切られます。そのため，出力されるデータに「|」の文字を含むフィールド名やアラーム名などがあると，区切り文字として使用されている「|」と区別がつかなくなります。jpctool db dumpコマンドを実行してデータをエクスポートする場合は，フィールド名やアラーム名などに「|」を使用しないでください。

コマンドの実行をCtrl+Cキーやシグナルで中断した場合，特定の戻り値が返りません。そのため，コマンドをCtrl+Cキーやシグナルで中断した場合は戻り値を無視してください。

-localtimeオプションを指定してjpctool db dumpコマンドを実行しても，エクスポートファイルにはGMTで出力されます。

PFM - ManagerホストでAgentホストリモート操作制限オプションの設定が有効な環境で，このコマンドをPFM - Agent またはPFM - RMホストで実行する場合，ローカルホストのデータ以外はエクスポートできません。-hostオプションでリモートホストを指定して実行すると，エラーになります。

エクスポートファイルの内容は，日付やフィールドの値などでソートされていません。エクスポートファイルをユーザー作成プログラムで処理する場合などは，必要に応じてソート処理してください。

戻り値

0 正常終了した。

1 引数の指定に誤りがある。

3 指定されたサービスのうち，一つ以上が起動していない。

7 指定されたサービスIDがAgent Storeサービス，Remote Monitor Storeサービス，またはMaster Storeサービスのものではない。

100 Performance Managementの環境が不正である。

101 Name Serverサービス，Master Managerサービス，Master Storeサービス，または操作対象サービスのどれかが起動していない。

102 指定された論理ホスト名はセットアップされていない。

104 指定されたMaster Storeサービス，Agent Storeサービス，またはRemote Monitor Storeサービスは，バックアップ中またはエクスポート中である。

200 メモリーが不足している。

210 ディスク容量が不足している。

211 エクスポートファイルまたはディレクトリにアクセスできない。

220 サービス構成情報ファイルに指定しているホスト名が不正である。

222 通信処理でエラーが発生した。

223 通信処理でタイムアウトが発生した。

255 予期しないエラーが発生した。

使用例 1

PFM - Agent for Platform（Windows）のホストhost02のProcessor Overview（PI_PCSR）レコードに格納されているデータのうち，2006年7月25日午前2時（GMT）から2006年7月26日午後2時59分（GMT）までのデータをファイル「pcsr.out」にエクスポートする場合のコマンド実行例を次に示します。
 
jpctool db dump -id TS* -host host02 -stime 2006/07/25 02:00 -etime 2006/07/26 14:59 -f pcsr.out -dbid PI -rec PCSR
 

使用例 2

論理環境を構築しているPFM - Agent for Oracle（Windows）のホストlhost02上でInstance（PD_PDI）レコードに格納されているデータのうち，2006年7月25日午前2時（GMT）から2006年7月26日午後2時59分（GMT）までのデータをファイル「pcsr.out」にエクスポートする場合の-aloneおよび-directコマンド実行例を次に示します。
 
jpctool db dump -id OS* -lhost lhost02 -stime 2006/07/25 02:00 -etime 2006/07/26 14:59 -f pcsr.out -dbid PD -rec PDI -alone
 
jpctool db dump -id OS* -lhost lhost02 -stime 2006/07/25 02:00 -etime 2006/07/26 14:59 -f pcsr.out -dbid PD -rec PDI -direct

出力例

エクスポートファイルには，次のようにプロダクト情報，フィールド名，およびデータが出力されます。

フィールド名およびデータの間は，「|」が区切り文字として挿入されます。

出力例を次に示します。

[目次][前へ][次へ]

[他社商品名称に関する表示]

0	正常終了した。
1	引数の指定に誤りがある。
3	指定されたサービスのうち，一つ以上が起動していない。
7	指定されたサービスIDがAgent Storeサービス，Remote Monitor Storeサービス，またはMaster Storeサービスのものではない。
100	Performance Managementの環境が不正である。
101	Name Serverサービス，Master Managerサービス，Master Storeサービス，または操作対象サービスのどれかが起動していない。
102	指定された論理ホスト名はセットアップされていない。
104	指定されたMaster Storeサービス，Agent Storeサービス，またはRemote Monitor Storeサービスは，バックアップ中またはエクスポート中である。
200	メモリーが不足している。
210	ディスク容量が不足している。
211	エクスポートファイルまたはディレクトリにアクセスできない。
220	サービス構成情報ファイルに指定しているホスト名が不正である。
222	通信処理でエラーが発生した。
223	通信処理でタイムアウトが発生した。
255	予期しないエラーが発生した。