JP1/Performance Management リファレンス

[目次][索引][前へ][次へ]

jpcrdef output

形式

jpcrdef output     -o 出力ファイル
                  ［-mx 最大ヒープサイズ］
                  ［-ms 初期ヒープサイズ］
                  ［-dateformat 日付フォーマットのパターン名］
                  ［-dateseparator 日付フォーマットのセパレーター名］
                   入力ファイル

機能

jpcrdef outputコマンドは，PFM - Managerに接続し，指定されたレポート定義をXML形式でファイル出力するコマンドです。ディレクトリを指定した場合，そのディレクトリの下にあるすべてのレポート定義をサブディレクトリ以下も含めて，一つのファイルに出力します。ファイル出力するレポート定義のパスまたはディレクトリは，複数指定できます。出力ファイルは，jpcrdef createコマンドの入力ファイルとして指定できます。

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

PFM - Web Console

実行権限

Windowsの場合
  • OSのユーザー権限：Administrators権限を持つユーザー
  • Performance Managementのユーザー権限：一般ユーザー権限，または管理ユーザー権限を持つユーザー

UNIXの場合
  • OSのユーザー権限：rootユーザー権限を持つユーザー
  • Performance Managementのユーザー権限：一般ユーザー権限，または管理ユーザー権限を持つユーザー

格納先ディレクトリ

Windowsの場合
インストール先フォルダ\tools\

UNIXの場合
/opt/jp1pcwebcon/tools/

引数

-o 出力ファイル

出力先のファイルをオプションのあとに指定します。指定しないと，エラーになります。絶対ファイルパス名，相対ファイルパス名，ファイル名を指定でき，絶対ファイルパス名以外の場合，カレントディレクトリを基点とします。既存のファイルを指定すると上書きします。指定されたディレクトリが存在しない場合は，エラーとなります。

-mx 最大ヒープサイズ

java.exeの最大ヒープサイズをMB単位で指定します。デフォルトは，64MBです。実際に取得できる最大サイズは，システムに依存します。指定する値が次の条件を満たさない場合は，コマンドライン形式不正となります。指定値の条件を次に示します。

-ms 初期ヒープサイズ

java.exeの初期ヒープサイズをMB単位で指定します。デフォルトは，32MBです。指定する値が次の条件を満たさない場合は，コマンドライン形式不正となります。指定値の条件を次に示します。

-dateformat 日付フォーマットのパターン名

指定したパターン名に対応する日付フォーマットで，出力ファイルの<expression>タグに記述した日付の形式を決定します。指定できる日付フォーマットのパターン名を次に示します。

-dateseparator 日付フォーマットのセパレーター名

指定したセパレーター名に対応するセパレーター文字列で，出力ファイルの<expression>タグに記述したセパレーターの形式を決定します。指定できる日付フォーマットのセパレーター名を次に示します。

入力ファイル

出力対象のレポート定義を記述したXML形式のパラメーターファイルを指定します。このパラメーターファイルは，後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名，相対ファイルパス名，ファイル名を指定でき，絶対ファイルパス名以外の場合，カレントディレクトリを基点とします。

パラメーターファイルの形式

XMLタグ仕様

パラメーターファイルの記述例を次に示します。

パラメーターファイル記述例

 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rdef_output_params.dtd">
<pr-cli-parameters ver="0100">
   <report-definitions>
      <report-definition name="Workload Status (Multi-Agent)"
                parent-folder="/"/>
      <report-definition name="CPU Usage Top 10 Processes"
                parent-folder="/" read-only="FALSE"/>
      <report-definition parent-folder="/Windows/Operating System"/>
   </report-definitions>
</pr-cli-parameters>

パラメーターの記述を定義するDTDファイル（rdef_output_params.dtd）を次に示します。

パラメーターの記述を定義するDTDファイル（rdef_output_params.dtd）

 
<!ENTITY  % BOOL_VALUE        "(true|false|TRUE|FALSE)">
<!ELEMENT pr-cli-parameters    (report-definitions)>
<!ATTLIST pr-cli-parameters
          ver                  (0100)                #REQUIRED>
<!ELEMENT report-definitions   (report-definition+)>
<!ELEMENT report-definition    ANY>
<!ATTLIST report-definition
          name                 CDATA                 #IMPLIED
          parent-folder        CDATA                 #REQUIRED
          id                   CDATA                 #IMPLIED
          read-only            %BOOL_VALUE;         "FALSE">

注意事項

戻り値

0 正常終了した。
1 コマンドラインの形式が不正である。
2 コマンドの実行権限がない。
3 出力ファイルの作成に失敗した。
5 DTDファイルと不整合のためパラメーターが解析できない。
10 1件以上のレポート定義作成に失敗した。
11 PFM - Managerへの認証処理に失敗した。
100 環境が不正である。
200 メモリーエラーが発生した。
202 ファイルアクセスエラーが発生した。
222 通信処理でエラーが発生した。
255 予期しないエラーが発生した。

使用例

レポートの定義内容を記述したパラメーターファイル（rdef_input.xml）をファイル（rdef_output.xml）に出力する場合のコマンド実行例を次に示します。

 
jpcrdef  output  -o rdef_output.xml  rdef_input.xml

出力例

コマンド処理の詳細情報を標準出力，標準エラー出力，トレースログファイルに出力します。ログ仕様については「3.　ログ情報」を参照してください。

10のレポート定義と五つのレポート定義ディレクトリを指定し，三つのレポート定義がエラーとなった場合の標準出力形式を次に示します。

標準出力の出力例

 
jpcrdef output connected to vserv01 at 2006 03 20 15:00:55.282
output result OK  : レポート定義ディレクトリパス1/レポート定義名11
output result OK  : レポート定義ディレクトリパス2/レポート定義名21
output result ERR : レポート定義ディレクトリパス3
          Skipped : レポート定義ディレクトリパス3/レポート定義名31
エラー要因
              OK  : レポート定義ディレクトリパス3/レポート定義名32
          Skipped : レポート定義ディレクトリパス3/レポート定義名33
エラー要因
              OK  : レポート定義ディレクトリパス3/レポート定義名34
              OK  : レポート定義ディレクトリパス3/レポート定義名35
output result ERR : レポート定義ディレクトリパス4/レポート定義名41
エラー要因
output result OK  : レポート定義ディレクトリパス5
              OK  : レポート定義ディレクトリパス5/レポート定義名51
              OK  : レポート定義ディレクトリパス5/レポート定義名52
jpcrdef output disconnected at 2006 03 20 15:01:06.2

出力ファイルフォーマット

指定した属性とデフォルトで設定された属性をファイルに出力します。outputコマンドは，report-definitionタグのid属性としてノードIDを出力します。createコマンドおよびdeleteコマンドは，id属性指定を無視します。

出力されたパラメーターファイルは，レポート定義を生成するときの入力ファイルとして指定できます。出力されたパラメーターの記述を定義するDTDファイルの内容は，生成時に指定するDTDファイルと同じです。出力されたパラメーターファイルの例とパラメーターの記述を定義するDTDファイルは，jpcrdef createコマンドの「パラメーターファイル記述例（履歴レポートの場合）」，「パラメーターファイル記述例（リアルタイムレポートの場合）」，および「パラメーターの記述を定義するDTDファイル（rdef_create_params.dtd）」を参照してください。

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

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

All Rights Reserved. Copyright (C) 2006, 2008, Hitachi, Ltd.