Hitachi

JP1 Version 12 JP1/Performance Management リファレンス


jpcrdef output

〈このページの構成〉

形式

jpcrdef output     -o 出力ファイル名
                   [-mx 最大ヒープサイズ]
                   [-ms 初期ヒープサイズ]
                   [-dateformat 日付フォーマットのパターン名]
                   [-dateseparator 日付フォーマットのセパレーター名]
                   {入力ファイル名 | -parent レポート定義ディレクトリ [-name レポート定義名]}

機能

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

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

PFM - Web Console

実行権限

Windowsの場合

Administrators権限を持つユーザー

UNIXの場合

rootユーザー権限を持つユーザー

また,コマンドを実行するためには,事前にPerformance Managementに対する管理ユーザー権限または一般ユーザー権限のユーザーアカウントで認証用のキーファイルを作成する必要があります。詳細については,「jpcmkkey」コマンドを参照してください。

注※

Performance ManagementユーザーまたはJP1ユーザーが必要とする,Performance Managementに対する実行権限です。

格納先ディレクトリ

Windowsの場合

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

UNIXの場合

/opt/jp1pcwebcon/tools/

引数

-o 出力ファイル名

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

-mx 最大ヒープサイズ

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

  • 1〜2,048の整数

  • 「-mxの指定値 >= -msの指定値」

-ms 初期ヒープサイズ

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

  • 1〜2,048の整数

  • 「-mxの指定値 >= -msの指定値」

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

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

  • pattern-ddMMyyyy

  • pattern-MMddyyyy

  • pattern-yyyyMMdd

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

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

  • space

  • slash

  • hyphen

  • period

入力ファイル名

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

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

-parent レポート定義ディレクトリ

出力対象のレポート定義が存在するディレクトリを,次の記述規則に従って指定します。

  • 1〜64文字(バイトではない)の全角文字または半角文字のディレクトリパスを,ルートディレクトリから「/」で区切って指定する。

  • 空白文字を含む場合は,「"」(ダブルクォーテーション)で囲む。

  • ディレクトリ名に半角の「\」または「/」を含む場合,それぞれ「\\」,「\/」と記述する。

  • 全角と半角文字とは混在できる。

  • ディレクトリパスを区切る「/」の前後に半角空白を指定するとエラーになる。

  • 入力ファイル名オプションと同時に指定するとエラーになる。

-name レポート定義名

出力対象のレポートの定義名を,次の記述規則に従って指定します。

  • 1〜64文字(バイトではない)の全角文字または半角文字のレポート定義名を指定する。

  • 空白文字を含む場合は,「"」(ダブルクォーテーション)で囲む。

  • レポート定義名に半角の「\」または「/」を含む場合,それぞれ「\¥」,「\/」と記述する。

  • 全角と半角文字とは混在できる。

  • レポート定義名の前後に指定した半角空白は削除する。

  • 入力ファイル名オプションと同時に指定するとエラーになる。

  • -parentオプションと同時に指定する必要がある。

  • -nameオプションを省略すると,-parentオプションに指定したレポート定義ディレクトリに含まれるすべてのレポート定義を,下位層含めて1つのファイルに出力する。

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

XMLタグ仕様

パラメーターファイルの記述例を次に示します。なお,パラメーターファイルのサンプルを下記ディレクトリに格納しています。パラメーターファイルを記述するときのひな形として利用してください。

Windowsの場合:

インストール先のディレクトリ\sample\conf\

UNIXの場合:

/opt/jp1pcwebcon/sample/conf/

  • report-definitions

    種別

    説明

    意味

    レポート定義情報のルートタグ

    指定可能値

    なし

    省略

    不可

    属性

    なし

    親要素

    pr-cli-parameters

    子要素

    report-definition

  • report-definition

    種別

    説明

    意味

    1つのレポート定義を指定する。

    指定可能値

    なし

    省略

    不可

    属性

    name

    1〜64文字(バイトではない)の全角文字または半角文字でレポート定義名を指定する。レポート定義名に「\」か「/」を含む場合,それぞれ「\\」「\/」と記述する。全角と半角文字が混在できる。省略するとparent-folder属性に指定したレポート定義ディレクトリに含まれるすべてのレポート定義を下位層含めて1つのファイルに出力する。レポート定義名の前後に半角空白を指定すると,前後の半角空白を除いた名称で登録される。

    parent-folder

    name属性のレポート定義があるディレクトリ名を指定する。1〜64文字(バイトではない)の全角文字または半角文字のディレクトリ名をルートディレクトリから「/」で区切って指定する。parent-folder属性を指定した場合,name属性を省略するとレポート定義ディレクトリに含まれるすべてのレポート定義を下位層含めて1つのファイルに出力する。全角と半角文字が混在できる。パスの場合,上位レベルのディレクトリから順に半角「/」で区切って指定する。ディレクトリ名に「\」か「/」を含む場合,それぞれ「\\」「\/」と記述する。ディレクトリ名の前後に半角空白を指定するとエラーになります。省略できない。

    例えば,ルートディレクトリ「User Reports」の配下にあるレポート定義名「PD define」のレポート定義をファイルに出力する場合,次のように指定する。

    <report-definition name="PD define" parent-folder="/"/>

    また,ルートディレクトリ「User Reports」配下のディレクトリ「Dir1」内のディレクトリ「Dir2」にある,すべてのレポート定義をファイルに出力する場合,次のように指定する。

    <report-definition parent-folder="/Dir1/Dir2"/>

    id

    入力ファイルに指定しても無視される。レポート定義(ディレクトリ出力の場合は,ディレクトリ)の識別子を出力する。

    read-only

    入力ファイルに指定しても無視される。システム定義の場合は,「true」を出力する。それ以外の場合は,「false」を出力する。

    親要素

    report-definitions

    子要素

    product

    指定しても無視される。

    report-type

    record

    indication-settings

    view-type

    drilldown

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

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

<?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>

注意事項

戻り値

0

正常終了した。

1

コマンドラインの形式が不正である。

2

コマンドの実行権限がない。

3

出力ファイルの作成に失敗した。

5

DTDファイルと不整合のためパラメーターが解析できない。

10

1件以上のレポート定義作成に失敗した。

11

PFM - Managerへの認証処理に失敗した。

100

環境が不正である。

200

メモリーエラーが発生した。

202

ファイルアクセスエラーが発生した。

222

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

255

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

使用例1

レポートの定義内容を記述したパラメーターファイル(rdef_input.xml)を入力ファイル名オプションで指定して,XML形式でファイル(rdef_output.xml)に出力する場合のコマンド実行例を次に示します。

jpcrdef  output  -o rdef_output.xml  rdef_input.xml

使用例2

レポートの定義内容を-parentオプションと-nameオプションで指定して,XML形式でファイル(rdef_output.xml)に出力する場合のコマンド実行例を次に示します。

jpcrdef  output  -o rdef_output.xml  -parent "/Windows/Operating System" -name "CPU Usage Top 10 Processes"

出力例

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

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

標準出力の出力例

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コマンドの「パラメーターファイル記述例(履歴レポートの場合)」,および「パラメーターファイル記述例(リアルタイムレポートの場合)」を参照してください。