jpcaspsv output
形式
jpcaspsv output [-mx 最大ヒープサイズ] [-ms 初期ヒープサイズ] -o 出力ファイル サービスID
機能
jpcaspsv outputコマンドは,エージェントに接続してStoreデータベースの保存条件に関する定義情報を取得し,XML形式で出力するコマンドです。出力ファイルは,jpcaspsv updateコマンドの入力ファイルとして指定できます。
コマンドを実行できるホスト
PFM - Web Console
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー
- UNIXの場合
-
rootユーザー権限を持つユーザー
また,コマンドを実行するためには,事前にPerformance Managementに対する管理ユーザー権限※のユーザーアカウントで認証用のキーファイルを作成する必要があります。詳細については,「jpcmkkey」コマンドを参照してください。
- 注※
-
Performance ManagementユーザーまたはJP1ユーザーが必要とする,Performance Managementに対する実行権限です。
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pcwebcon/tools/
引数
-mx 最大ヒープサイズ
java.exeの最大ヒープサイズをメガバイト単位で指定します。デフォルトは,128MBです。実際に取得できる最大サイズは,システムに依存します。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
-
1〜2,048の整数
-
「-mxの指定値 >= -msの指定値」
-ms 初期ヒープサイズ
java.exeの初期ヒープサイズをメガバイト単位で指定します。デフォルトは,32メガバイトです。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
-
1〜2,048の整数
-
「-mxの指定値 >= -msの指定値」
-o 出力ファイル
表示結果を出力するXML形式ファイルの名称を指定します。絶対ファイルパス名,相対ファイルパス名,ファイル名が指定できます。絶対ファイルパス名以外の場合,カレントディレクトリを基点とします。指定されたディレクトリがない場合,エラーになります。
サービスID
表示対象エージェントを示すサービスIDを指定します。ワイルドカード文字は使用できません。指定値の条件を次に示します。
-
4〜258文字
-
1桁目はエージェントのプロダクトIDを指定します。プロダクトIDについては,各PFM - AgentまたはPFM - RMマニュアルを参照してください。
-
2桁目は「S」(Agent StoreまたはRemote Monitor Store)を指定します。
注意事項
-
コマンドは,実行時にPFM - Managerに対する認証が必要です。認証用のキーファイルを作成していない場合は,コマンドを実行する前に,jpcmkkeyコマンドで認証用のキーファイルを作成してください。指定できるサービスIDについては,各PFM - AgentまたはPFM - RMマニュアルを参照してください。
-
指定したサービスIDが,エージェントのプロダクト以外の場合はエラーとします。
-
更新できない定義情報は,出力ファイルにコメントとして出力されます。
-
通常,-mxオプションおよび-msオプションを設定する必要はありません。コマンド実行時に,メモリー不足を示すKAVJK0401-Eメッセージが出力された場合は,-mxオプションの最大ヒープサイズに64以上を指定して,再度実行してください。
戻り値
0 |
正常終了した。 |
1 |
コマンドラインの形式が不正である。 |
2 |
コマンドの実行権限がない。 |
3 |
出力ファイルの作成に失敗した。 |
5 |
DTDファイルと不整合のためパラメーターが解析できない。 |
10 |
1件以上のStoreデータベース定義の更新に失敗した。 |
11 |
PFM - Managerへの認証処理に失敗した。または,認証時に指定したユーザーに実行権限がない。 |
100 |
環境が不正である。 |
200 |
メモリーエラーが発生した。 |
202 |
ファイルアクセスエラーが発生した。 |
222 |
通信処理でエラーが発生した。 |
255 |
予期しないエラーが発生した。 |
使用例
サービスID「TS1host1」のPFM - AgentのStoreデータベースの記録方法に関する定義情報をパラメーターファイル(aspsv_output.xml)に出力する場合のコマンド実行例を次に示します。
jpcaspsv output -o aspsv_output.xml TS1host1
出力例
コマンド処理の詳細情報を標準出力,標準エラー出力,トレースログファイルに出力します。ログ仕様については「4. Performance Managementで出力するログ情報」を参照してください。
標準出力の出力例を次に示します。引数で指定したサービスIDの実行結果を表示します(OKまたはERR)。
標準出力の出力例
jpcaspsv output connected to hostname at yyyy MM dd HH:MM:SS.mmm output result OK : TS1host1 jpcaspsv output disconnected at yyyy MM dd HH:MM:SS.mmm
出力ファイル
このコマンドの出力ファイル例を次に示します。
出力ファイル例
-
出力ファイル例(Storeバージョンが1.0の場合)
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "aspsv_params.dtd"> <pr-cli-parameters ver="0110"> <agent-store-db-preserve-definition> <service id="TS1host1"> <product-interval> <minute-drawer>month</minute-drawer> <hour-drawer>month</hour-drawer> <day-drawer>month</day-drawer> <week-drawer>month</week-drawer> <month-drawer>month</month-drawer> <!-- year-drawer : Year --> </product-interval> <product-detail> <detail-record id="PD" max-rec="20000"/> <detail-record id="PD_THRD" max-rec="20000"/> <detail-record id="PD_ADRS" max-rec="20000"/> <detail-record id="PD_PDI" max-rec="20000"/> <detail-record id="PD_PEND" max-rec="20000"/> <detail-record id="PD_THD" max-rec="20000"/> <detail-record id="PD_IMAG" max-rec="20000"/> <detail-record id="PD_PAGF" max-rec="20000"/> <detail-record id="PD_CINF" max-rec="20000"/> <detail-record id="PD_CIND" max-rec="20000"/> <detail-record id="PD_GEND" max-rec="20000"/> <detail-record id="PD_SVC" max-rec="20000"/> <detail-record id="PD_DEV" max-rec="20000"/> <detail-record id="PD_ELOG" max-rec="20000"/> </product-detail> <product-log> <log-record id="PL" max-rec="20000"/> <log-record id="RM" max-rec="20000"/> </product-log> </service> </agent-store-db-preserve-definition> </pr-cli-parameters>
-
出力ファイル例(Storeバージョンが2.0の場合)
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "aspsv_params.dtd"> <pr-cli-parameters ver="0110"> <agent-store-db-preserve-definition> <service id="TS1host1"> <ex-product-interval> <ex-interval-record id="PI"> <minute-drawer-days period="10"/> <hour-drawer-days period="10"/> <day-drawer-weeks period="10"/> <week-drawer-weeks period="10"/> <month-drawer-months period="10"/> <!-- year-drawer-years period="10" --> </ex-interval-record> <ex-interval-record id="PI_LOGD"> <minute-drawer-days period="10"/> <hour-drawer-days period="10"/> <day-drawer-weeks period="10"/> <week-drawer-weeks period="10"/> <month-drawer-months period="10"/> <!-- year-drawer-years period="10" --> </ex-interval-record> </ex-product-interval> <ex-product-detail> <ex-detail-record id="PD" period="10"/> <ex-detail-record id="PD_THRD" period="10"/> <ex-detail-record id="PD_ADRS" period="10"/> <ex-detail-record id="PD_PDI" period="10"/> <ex-detail-record id="PD_PEND" period="10"/> </ex-product-detail> <ex-product-log> <ex-log-record id="PL" period="10"/> <ex-log-record id="RM" period="10"/> </ex-product-log> </service> </agent-store-db-preserve-definition> </pr-cli-parameters>