形式
jpcrpt -o <出力ファイル>
[-mx <最大ヒープサイズ>]
[-y]
[-rc <更新回数>]
[-ri <更新間隔>]
[-dateformat <日付フォーマットのパターン名>]
[-dateseparator <日付フォーマットのセパレーター名>]
[-exportseparator <レポート出力時の日付フォーマットのセパレーター名>]
<入力ファイル>
機能
jpcrptコマンドは,レポートをCSV形式またはHTML形式でファイルに出力するコマンドです。出力定義は,コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。パラメーターファイルには,出力対象となるレポートおよびShow options画面相当の項目が指定できます。HTML形式で出力する場合は,入力ファイルでhtml-outputタグの設定が必要です。
1パラメーターファイルに1レポートを指定できます。出力するレポートがリアルタイムレポートの場合,CSV形式によるレポート出力のときは,rcオプションで指定した更新回数分のデータを,riオプションで指定した更新間隔に従って,出力ファイルの末尾に追記します。HTML形式によるレポート出力のときは,コマンド実行時の最新のデータでHTMLファイルを出力します。HTMLファイルを出力したあと,データは更新されません。また,HTML形式によるレポート出力では,rcオプションとriオプションを指定しても無効になります。
また,大量データのレポートをHTML形式で出力する場合,メモリー不足が発生してレポートが表示できないときがあります。その場合には,HTML形式で出力するときに必要なメモリー量を算出し,必要であればJavaのヒープサイズを拡張して,再度レポートを表示してください。jpcrptコマンドを使用してHTML形式で出力する場合に必要なメモリー量の見積もり方法については,マニュアル「Hitachi Command Suite Tuning Manager Software 運用管理ガイド」を参照してください。
シングルエージェントレポートに対して,複数エージェントを指定した場合は,エラーになります。
なお,jpcrptコマンドを使って出力したCSV形式のファイルは,htm-csv-convertコマンドを使って一般的な表計算ソフトでグラフ化しやすい形式に変換できます。htm-csv-convertコマンドを使って形式を変換する方法については,「5.5 CSVレポートの形式変換」を参照してください。
実行権限
格納先ディレクトリ
オプション
jpcrptコマンド引数のオプションを次の表に示します。
表12-54 jpcrptコマンド引数のオプション
オプション | 必須 任意 | 目的 | 備考 |
---|---|---|---|
-o <出力ファイル> | 必須 | レポートを出力するファイル名称を指定します。指定しないとエラーになります。また,出力ファイル名には,次に示す文字以外のASCII文字を含めないでください。 # % < > & ¥ ただし,出力先のファイルシステムによっては,これら以外にも使用できない文字がある場合があります。 絶対ファイルパス名,相対ファイルパス名,ファイル名を指定できます。絶対ファイルパス名以外の場合,カレントディレクトリを基点とします。指定されたディレクトリが存在しない場合,エラーになります。指定されたファイルが重複した場合,-yオプションの指定に従います。 出力ファイル名は,レポートの出力形式と指定するファイル名によって「表12-55 出力形式,指定するファイル名による出力ファイル名の違い」のように異なります。CSV形式の場合,指定するファイル名に拡張子がないときは,出力するファイル名も拡張子を持ちません。HTML形式の場合は,指定するファイル名に拡張子があるないに関係なく,htmとpng(グラフ画像)の拡張子を持つファイルが出力されます。 | なし |
-mx <最大ヒープサイズ> | 任意 | Javaの最大ヒープサイズをMB単位で指定します。指定する最大ヒープサイズは,1~1,024の範囲の整数で指定します。省略した場合,64MBとなります。範囲外の値を指定すると,エラーになります。実際に取得できる最大サイズは,システムに依存します。 なお,このオプションは,メモリー不足が原因でKAVJK0401-Eメッセージが出力され,コマンドが異常終了した場合に,最大ヒープサイズをデフォルトの64MBより大きいサイズに拡張するときに指定してください。 | なし |
-y | 任意 | -oオプションで指定した出力先のファイルが重複した場合,確認メッセージを出力するかどうかを指定します。 このオプションを指定した場合は,上書き確認メッセージを出力しないで,既存のファイルに上書きします。このオプションを省略した場合は,上書き確認メッセージを出力します。上書き確認メッセージに対して,「y」または「Y」で応答すると,既存のファイルに上書きします。それ以外の値で応答すると,処理を中断します。 | なし |
-rc <更新回数> | 任意 | リアルタイムレポートの更新間隔に従い,複数回にわたって出力する場合の更新回数を指定します。指定する更新回数は,1~2,147,483,647までの範囲で指定します。省略した場合,1となります。範囲外の値を指定すると,エラーになります。履歴レポートに対して指定した場合およびHTML出力の場合は,無視されます。 | なし |
-ri <更新間隔> | 任意 | リアルタイムレポートのレポート定義に指定してある更新間隔を変更する場合に指定します。指定する更新間隔は,レポート定義時の更新間隔の最小値~3,600秒までの範囲で指定します。省略した場合,レポート定義時の更新間隔の初期値となります。範囲外の値を指定すると,エラーになります。履歴レポートに対して指定した場合およびHTML出力の場合は,無視されます。 | なし |
-dateformat <日付フォーマットのパターン名> | 任意 | 指定したパターン名に対応する日付フォーマットで,入力ファイルの<expression-value>,<start-time>,<end-time>,<baseline-start-time>タグに記述した日付の形式を判定します。また,出力ファイルの日付の形式を決定します。指定できる日付フォーマットのパターン名を次に示します。
| なし |
-dateseparator <日付フォーマットのセパレーター名> | 任意 | 指定したセパレーター名に対応するセパレーター文字列で,入力ファイルの<expression-value>,<start-time>,<end-time>タグに記述したセパレーターの形式を判定します。また,出力ファイルのセパレーターの形式を決定します。指定できる日付フォーマットのセパレーター名を次に示します。
| なし |
-exportseparator <レポート出力時の日付フォーマットのセパレーター名> | 任意 | レポート出力時の日付フォーマットセパレーター名に対応するセパレーター文字列を指定します。このオプションの指定は,-dateseparatorの指定よりも優先されます。指定できる日付フォーマットのセパレーター名を次に示します。省略した場合,config.xmlの設定値になります。
| なし |
<入力ファイル> | 必須 | レポート出力するためのXML形式のパラメーターファイルを指定します。このパラメーターファイルは,後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名,相対ファイルパス名,ファイル名が指定でき,絶対ファイルパス名以外の場合,カレントディレクトリを基点とします。 | なし |
表12-55 出力形式,指定するファイル名による出力ファイル名の違い
出力形式 | 指定するファイル名 | 出力ファイル名 |
---|---|---|
CSV | output | output |
output.csv (推奨) | output.csv | |
HTML | output (推奨) | output.htm |
output.png | ||
output.htm | output.htm.htm | |
output.htm.png |
パラメーターファイルの形式
XMLタグ仕様
表12-56 launch-report
種別 | 説明 |
---|---|
意味 | レポートを出力する場合に,レポート定義とエージェントの組み合わせを指定します。 |
指定可能値 | なし |
省略 | 可(launch-report,launch-registration-reportまたはlaunch-combination-bookmarkのどれか1つだけを指定する必要があります) |
属性 | なし |
親要素 | pr-cli-parameters |
子要素 | agent(複数指定できます) |
report-definition |
表12-57 agent
種別 | 説明 |
---|---|
意味 | レポート出力対象となるエージェントを1つ指定します。 |
指定可能値 | Agent CollectorサービスのサービスIDを指定します。1桁目はエージェントのプロダクトIDを指定します。プロダクトIDについては,各PFM-Agentマニュアルを参照してください。2桁目は「A」(Agent Collector)を指定します。 存在しないサービスIDおよびプロダクトが混在したサービスIDを指定するとエラーになります。サービスIDを重複して指定した場合,先に指定したサービスIDが有効になります。「report-definition」に指定したレポートのレポート種別が複数のエージェント以外のときにサービスIDを複数指定すると,エラーになります。 |
省略 | 不可 |
属性 | なし |
親要素 | launch-report |
子要素 | なし |
表12-58 report-definition
種別 | 説明 | |
---|---|---|
意味 | レポート出力対象となるレポート定義を1つ指定します。エラーになる条件を次に示します。
| |
指定可能値 | なし | |
省略 | 不可 | |
属性 | name | 1~64文字(バイトではない)の全角文字または半角文字でファイル出力するレポート定義名を指定します。レポート定義名に「¥」または「/」を含む場合,それぞれ「¥¥」「¥/」と記述します。 存在しないレポート名を指定すると,エラーになります。省略するとエラーになります。 |
parent-folder | name属性で指定したレポート定義の親ディレクトリをディレクトリパスで指定します。ディレクトリパスは「/」で始まり,上位レベルのディレクトリ名から順に半角「/」で区切って指定します。ルートディレクトリを指定する場合は,「/」だけを指定します。ディレクトリ名に「¥」または「/」を含む場合,それぞれ「¥¥」「¥/」と記述します。存在しないディレクトリを指定すると,エラーになります。また,省略するとエラーになります。 | |
親要素 | launch-report | |
子要素 | launch-options(1report-definitionに1回だけ指定できます。省略できます) | |
html-output(1report-definitionに1回だけ指定できます。省略できます) |
表12-59 launch-options
種別 | 説明 |
---|---|
意味 | レポートの取得条件を指定します。 |
指定可能値 | なし |
省略 | 可(省略時は設定しません) |
属性 | なし |
親要素 | report-definition,registration-report-definition |
子要素 | indication-settings(1launch-optionsに1回だけ指定できます。省略できます) |
realtime-indication-settings(1launch-optionsに1回だけ指定できます。省略できます) | |
expression-values(1launch-optionsに1回だけ指定できます。省略できます) |
表12-60 indication-settings
種別 | 説明 | |
---|---|---|
意味 | 次の値を指定します。
| |
指定可能値 | なし | |
省略 | 可(子要素を含め,レポート定義の値を適用します) | |
属性 | maximum-number-of-records | 1~2,147,483,647の整数でレポートを取得する最大レコード数の上限値を指定します。指定できる上限は,config.xmlの<command>タグのmaxFetchCountで指定される値となります。それよりも大きい値を指定すると,maxFetchCountの値を適用します。また,config.xmlの<command>タグのmaxFetchCountの値がレポート定義で指定される値よりも小さい場合は,maxFetchCountの値を適用します。 省略時は,レポート定義の値となります。 |
親要素 | launch-options | |
子要素 | date-range(1indication-settingsに1回だけ指定できます。省略できます) | |
start-time(1indication-settingsに1回だけ指定できます。省略できます) | ||
end-time(1indication-settingsに1回だけ指定できます。省略できます) | ||
report-interval(1indication-settingsに1回だけ指定できます。省略できます) | ||
peak-time(1indication-settingsに1回だけ指定できます。省略できます) |
表12-61 date-range
種別 | 説明 |
---|---|
意味 | レポートの取得期間を指定します。 |
指定可能値 | 次の値を指定できます。大文字と小文字は区別しません。
|
省略 | 可(レポート定義の値を適用します) |
属性 | なし |
親要素 | indication-settings,combination-indication-settings |
子要素 | なし |
表12-62 report-interval
種別 | 説明 |
---|---|
意味 | レポート間隔を指定します。 |
指定可能値 | 次の値を指定できます。大文字と小文字は区別しません。
|
省略 | 可(レポート定義の値を適用します) |
属性 | なし |
親要素 | indication-settings,combination-indication-settings |
子要素 | なし |
表12-63 start-time
種別 | 説明 |
---|---|
意味 | 開始日時を指定します。 |
指定可能値 | report-intervalで指定したフォーマットで指定します。report-intervalが指定できないレポートは,「MINUTE」が指定された場合のフォーマットで指定します。フォーマットについては「表12-88 start-time,end-time,およびbaseline-start-timeの入力フォーマット」を参照してください。
|
省略 | date-rangeおよびend-time指定値との組み合わせに依存します。詳細については,後述の注意事項を参照してください。 |
属性 | なし |
親要素 | indication-settings,combination-indication-settings |
子要素 | なし |
表12-64 end-time
種別 | 説明 |
---|---|
意味 | 終了日時を指定します。 |
指定可能値 | report-intervalで指定したフォーマットで指定します。report-intervalが指定できないレポートは,「MINUTE」が指定された場合のフォーマットで指定します。フォーマットについては「表12-88 start-time,end-time,およびbaseline-start-timeの入力フォーマット」を参照してください。
|
省略 | date-rangeおよびstart-time指定値との組み合わせに依存します。詳細については,後述の注意事項を参照してください。 |
属性 | なし |
親要素 | indication-settings,combination-indication-settings |
子要素 | なし |
表12-65 peak-time
種別 | 説明 |
---|---|
意味 | ピーク時間を指定します。 |
指定可能値 | ピーク時間を指定したいフィールドIDを指定します。「NONE」を指定すると,レポート定義で指定したフィールドIDは無効になります。 レポート定義が次の条件のどれかに該当するときに指定した場合,エラーになります。
|
省略 | 可(レポート定義の値を適用します) |
属性 | なし |
親要素 | indication-settings |
子要素 | なし |
表12-66 realtime-indication-settings
種別 | 説明 | |
---|---|---|
意味 | リアルタイムレポートのランキング表示を指定します。 レポート定義のレポート種別が「リアルタイム(1つのエージェント)」の場合に指定できます。それ以外の場合は,エラーになります。 | |
指定可能値 | なし | |
省略 | 可(子要素を含め,レポート定義の値を適用します) | |
属性 | indicate-delta-value | デルタ値で取得する場合は「TRUE」,それ以外は「FALSE」と指定します。省略時は,レポート定義の値を適用します。 |
親要素 | launch-options | |
子要素 | display-by-ranking(1realtime-indication-settingsに1回だけ指定できます。省略できます) |
表12-67 display-by-ranking
種別 | 説明 | |
---|---|---|
意味 | ランキング取得フィールド,取得数,降順かどうかを指定できます。 レポート定義のレコードが単数インスタンスの場合,エラーになります。 | |
指定可能値 | なし | |
省略 | 可(子要素を含め,レポート定義の値を適用します) | |
属性 | field | ランキング取得するフィールドIDを指定します。指定可能値については,「7.7.2 レポートの表示時または表示中に設定する表示条件」を参照してください。 ランキング取得をしない場合は,「NONE」を指定します。「NONE」の指定は,大文字と小文字は区別しません。省略するとエラーになります。 |
display-number | ランキング取得する件数を1~100の整数で指定します。範囲外を指定するとエラーになります。field属性が「NONE」の場合にdisplay-numberを指定すると,エラーになります。 field属性指定時に省略した場合,レポート定義でfield属性が指定されていれば,レポート定義の値,それ以外の場合は10となります。 | |
in-descending-order | ランキング取得の判定基準となるフィールドIDを降順または昇順でソートし,先頭からdisplay-number属性で指定した件数分を取得します。 昇順でソートする場合は「TRUE」,降順でソートする場合は「FALSE」を指定します。 field属性が「NONE」の場合にin-descending-orderを指定すると,エラーになります。 field属性指定時に省略した場合,レポート定義でfield属性が指定されていれば,レポート定義の値,それ以外の場合は「NONE」となります。field属性が指定されていなければ,「FALSE」となります。 | |
親要素 | realtime-indication-settings | |
子要素 | なし |
表12-68 expression-values
種別 | 説明 |
---|---|
意味 | 条件式を1つ以上指定します。 「specify when displayed」で設定された条件式を含まないレポートに指定すると,エラーになります。 |
指定可能値 | なし |
省略 | 可(省略時は設定しません) |
属性 | なし |
親要素 | launch-options |
子要素 | expression-value(複数指定できます) |
表12-69 expression-value
種別 | 説明 | |
---|---|---|
意味 | 条件式の値を1つ指定します。 | |
指定可能値 | pos属性で指定された行の式の値を指定します。 指定可能値およびエラーの条件については,「7.7.2 レポートの表示時または表示中に設定する表示条件」を参照してください。 | |
省略 | 可(expression-valuesを指定した場合は省略できません) | |
属性 | pos | 条件式に「specify when displayed」が設定されている単純式の出現順を0から始まる整数で指定します。出現順は,Show options画面で表示される条件式の表示順と一致します。Show options画面で1番目に表示される条件式のposの値は0となり,3番目に表示される条件式のposの値は2となります。 指定できる範囲は,0~「specify when displayed」が設定されている単純式の個数-1となります。 最初のexpression-valueタグでposを省略すると,0となります。2番目以降のexpression-valueタグでposを省略すると,1つ前のposの値+1となります。 posに同じ値を複数指定できます。この場合,最後に指定された値が有効になります。 範囲外の値を指定すると,エラーになります。 |
親要素 | expression-values | |
子要素 | なし |
表12-70 html-output
種別 | 説明 |
---|---|
意味 | HTML形式でレポートを出力します。出力するレポートのフォーマットについては,後述の出力ファイルを参照してください。 HTML形式のレポートは,次の形式でデータを表示できます。表示形式は,子要素で指定します。
|
指定可能値 | なし |
省略 | CSV形式でレポート出力します。 |
属性 | なし |
親要素 | report-definition,registration-report-definition |
子要素 ※ | show-graph(1html-outputに1回だけ指定できます。省略できます) |
show-table(1html-outputに1回だけ指定できます。省略できます) |
注意:このタグを指定する場合は,pr-cli-parametersのver属性を「0110」以降にしてください。
表12-71 show-graph
種別 | 説明 |
---|---|
意味 | 出力するレポートにグラフを表示します。グラフを表示する場合は,レポート定義でグラフ表示する設定をし,かつこのタグを指定します。レポート定義またはこのタグのどちらかの指定が無効の場合エラーにはなりませんが,レポートにグラフは表示されません。レポートに表示するグラフオプションは,子要素で指定します。子要素を指定しない場合は,デフォルト設定のグラフが表示されます。 |
指定可能値 | なし |
省略 | レポートにはグラフを表示しません。 |
属性 | なし |
親要素 | html-output |
子要素 | graph-options(1show-graphに1回だけ指定できます。省略できます) |
表12-72 graph-options
種別 | 説明 | |
---|---|---|
意味 | グラフオプションの設定を変更します。子要素の指定によって,次の項目の設定を変更できます。
| |
指定可能値 | なし | |
省略 | 3D表示オフ,グリッド表示オフ,縦軸は自動設定となります。 | |
属性 | zoom-scale | グラフの拡大率を指定します。選択できる値は,100,200,400,600,800のどれかです。省略するまたは,不正な値を指定した場合は,エラーになります。 |
親要素 | show-graph | |
子要素 ※ | show-3d(1graph-optionsに1回だけ指定できます。省略できます) | |
show-grid(1graph-optionsに1回だけ指定できます。省略できます) | ||
vertical-axis(1graph-optionsに1回だけ指定できます。省略できます) |
表12-73 show-3d
種別 | 説明 |
---|---|
意味 | グラフを3Dで表示します。ただし,グラフ種別が線,面(積み上げ面)グラフの場合はエラーになります。 |
指定可能値 | なし |
省略 | グラフを2Dで表示します。 |
属性 | なし |
親要素 | graph-options |
子要素 | なし |
表12-74 show-grid
種別 | 説明 |
---|---|
意味 | グラフ上にグリッドを表示します。ただし,グラフ種別が円グラフの場合はエラーになります。 |
指定可能値 | なし |
省略 | グリッドを表示しません。 |
属性 | なし |
親要素 | graph-options |
子要素 | なし |
表12-75 vertical-axis
種別 | 説明 | |
---|---|---|
意味 | レポートで表示するグラフの縦軸の範囲を指定します。ただし,グラフ種別が円グラフの場合はエラーになります。 | |
指定可能値 | なし | |
省略 | 縦軸がグラフのデータに応じて自動で設定されます。 | |
属性 | minvalue | 縦軸の最小値を実数値で指定します。指定できる範囲は,-1.797E308~1.797E308です。省略時およびminvalue>maxvalueの場合は,エラーになります。 |
maxvalue | 縦軸の最大値を実数値で指定します。指定できる範囲は,-1.797E308~1.797E308です。省略時およびminvalue>maxvalueの場合は,エラーになります。 | |
親要素 | graph-options | |
子要素 | なし |
表12-76 show-table
種別 | 説明 |
---|---|
意味 | 出力するレポートでテーブル(表)を表示します。テーブルを表示する場合は,レポート定義でテーブル表示を設定し,かつこのタグを指定します。レポート定義およびこのタグのどちらかの指定が無効の場合エラーにはなりませんが,レポートにテーブルは表示されません。 |
指定可能値 | なし |
省略 | レポートにはテーブルを表示しません。 |
属性 | なし |
親要素 | html-output |
子要素 | なし |
表12-77 launch-registration-report
種別 | 説明 |
---|---|
意味 | ブックマーク階層のブックマーク(複合ブックマークを含む)の配下にある登録レポートを指定します。 |
指定可能値 | なし |
省略 | 可(launch-report,launch-registration-reportまたはlaunch-combination-bookmarkのどれか1つだけを指定する必要があります) |
属性 | なし |
親要素 | pr-cli-parameters |
子要素 | registration-report-definition |
注意:このタグを指定する場合は,pr-cli-parametersのver属性を「0200」にしてください。
表12-78 registration-report-definition
種別 | 説明 | |
---|---|---|
意味 | レポート出力対象となる登録レポートを1つ指定します。 | |
指定可能値 | なし | |
省略 | 可(launch-registration-reportを指定した場合は省略不可) | |
属性 | bookmark-name | ファイル出力する登録レポートが格納されているブックマーク(複合ブックマークを含む)の名前を指定します。ブックマーク名に「¥」または「/」を含む場合は,それぞれ「¥¥」または「¥/」と記述します。存在しないブックマークを指定した場合はエラーになります。省略した場合はエラーになります。 |
report-name | ファイル出力する登録レポートの名前を指定します。「¥」または「/」を含める場合は,それぞれ「¥¥」または「¥/」と記述します。bookmark-name属性で指定したブックマーク配下に存在しない登録レポートを指定するとエラーになります。省略した場合はエラーになります。 注意:同一ブックマーク配下に同じ名称の登録レポートが複数定義されている場合,コマンドによって1つ目に情報取得された登録レポートが出力されます。 | |
bookmark-parent-folder | bookmark-name属性で指定したブックマークの親ディレクトリをディレクトリパスで指定します。ディレクトリパスは「/」で始まり,上位レベルのディレクトリ名から順に半角「/」で区切って指定します。ルートディレクトリを指定する場合は,「/」だけを指定します。ディレクトリ名に「¥」または「/」を含む場合,それぞれ「¥¥」「¥/」と記述します。存在しないディレクトリを指定すると,エラーになります。また,省略するとエラーになります。 | |
親要素 | launch-registration-report | |
子要素 ※ | launch-options(1registration-report-definitionに1回だけ指定できます。省略できます) | |
html-output(1registration-report-definitionに1回だけ指定できます。省略できます) |
表12-79 launch-combination-bookmark
種別 | 説明 |
---|---|
意味 | ブックマーク階層の複合ブックマークを指定します。 |
指定可能値 | なし |
省略 | 可(launch-report,launch-registration-reportまたはlaunch-combination-bookmarkのどれか1つだけを指定する必要があります) |
属性 | なし |
親要素 | pr-cli-parameters |
子要素 | combination-definition |
注意:このタグを指定する場合は,pr-cli-parametersのver属性を「0200」にしてください。
表12-80 combination-definition
種別 | 説明 | |
---|---|---|
意味 | レポート出力対象となる複合ブックマークを1つ指定します。 | |
指定可能値 | なし | |
省略 | 可(launch-combination-bookmarkを指定した場合は省略不可) | |
属性 | bookmark-name | ファイル出力する複合ブックマークの名前を指定します。ブックマーク名に「¥」または「/」を含む場合は,それぞれ「¥¥」または「¥/」と記述します。存在しないブックマーク,複合ブックマークではないブックマークを指定した場合はエラーになります。省略した場合はエラーになります。 |
bookmark-parent-folder | bookmark-name属性で指定したブックマークの親ディレクトリをディレクトリパスで指定します。ディレクトリパスは「/」で始まり,上位レベルのディレクトリ名から順に半角「/」で区切って指定します。ルートディレクトリを指定する場合は,「/」だけを指定します。ディレクトリ名に「¥」または「/」を含む場合,それぞれ「¥¥」「¥/」と記述します。存在しないディレクトリを指定すると,エラーになります。また,省略するとエラーになります。 | |
親要素 | launch-combination-bookmark | |
子要素 ※ | combination-options(1combination-definitionに1回だけ指定できます。省略できます) | |
combination-graph-options(1combination-definitionに1回だけ指定できます。省略できます) |
表12-81 combination-options
種別 | 説明 |
---|---|
意味 | 複合レポートを出力する場合のオプションを指定します。なお,ベースラインの表示設定は,子要素で指定します。 |
指定可能値 | なし |
省略 | 複合レポートの表示オプションは設定されません。 |
属性 | なし |
親要素 | combination-definition |
子要素 ※ | combination-indication-settings(1combination-optionsに1回だけ指定できます。省略できます) |
baseline-indication-settings(1combination-optionsに1回だけ指定できます。省略できます) |
表12-82 combination-graph-options
種別 | 説明 | |
---|---|---|
意味 | 複合レポートを出力する場合のグラフオプションの設定を変更します。 | |
指定可能値 | なし | |
省略 | グラフの拡大率は100%となります。 | |
属性 | zoom-scale | グラフの拡大率を値で指定します。選択できる値は100,200,400,600,800のどれかで,元のグラフの何%で拡大表示するかを選択します。省略するまたは,不正な値を指定した場合はエラーとなります。 |
親要素 | combination-definition | |
子要素 | なし |
表12-83 combination-indication-settings
種別 | 説明 |
---|---|
意味 | 複合レポートに対して,レポート取得期間,レポート間隔,開始日時,終了日時を指定します。 |
指定可能値 | なし |
省略 | 子要素で指定する値を含め,レポート定義の値が適用されます。 |
属性 | なし |
親要素 | combination-options |
子要素 | date-range(1combination-indication-settingsに1回だけ指定できます。省略できます) |
start-time(1combination-indication-settingsに1回だけ指定できます。省略できます) | |
end-time(1combination-indication-settingsに1回だけ指定できます。省略できます) | |
report-interval(1combination-indication-settingsに1回だけ指定できます。省略できます) |
表12-84 baseline-indication-settings
種別 | 説明 |
---|---|
意味 | 複合レポートのベースラインの表示開始位置を指定します。なお,ベースラインの表示開始位置は,子要素で指定します。 |
指定可能値 | なし |
省略 | ベースラインの開始位置として,デフォルト(レポートの開始日時)が使用されます。 |
属性 | なし |
親要素 | combination-options |
子要素 | baseline-start-time |
表12-85 baseline-start-time
種別 | 説明 |
---|---|
意味 | 複合レポートのベースラインの表示開始位置を指定します。 |
指定可能値 | report-intervalで指定したフォーマットで指定します。report-intervalが指定できないレポートは,「MINUTE」が指定された場合のフォーマットで指定します。フォーマットについては「表12-88 start-time,end-time,およびbaseline-start-timeの入力フォーマット」を参照してください。
|
省略 | 可(省略時は,デフォルト(レポートの開始日時)となります) |
属性 | なし |
親要素 | baseline-indication-settings |
子要素 | なし |
パラメーターファイル記述例を次に示します。なお,パラメーターファイルのサンプルを次に示すディレクトリに格納しています。パラメーターファイルを記述する際のひな形として利用してください。
パラメーターファイル記述例(登録レポート,複合レポート以外のレポートを出力する場合)
サンプルのパラメーターファイル名:jpcrpt-parameters.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0200">
<launch-report>
<agent>TA1htmprsvr</agent>
<agent>TA1admin</agent>
<report-definition name=" Memory Paging Status (Multi-Agent)" parent-folder=" /Windows/Operating System/Status Reporting/Daily Trend">
<launch-options>
<indication-settings maximum-number-of-records="1440">
<report-interval>HOUR</report-interval>
<start-time>2007 08 10 12:00</start-time>
<end-time>2007 08 11 12:00</end-time>
</indication-settings>
</launch-options>
<html-output>
<show-graph>
<graph-options zoom-scale = "100">
<show-grid/>
<vertical-axis minvalue="0" maxvalue="100"/>
</graph-options>
</show-graph>
<show-table/>
</html-output>
</report-definition>
</launch-report>
</pr-cli-parameters>
パラメーターファイル記述例(登録レポートを出力する場合)
サンプルのパラメーターファイル名:jpcrpt-parameters-for-registration-report.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0200">
<launch-registration-report>
<registration-report-definition report-name="CPU Usage@TA1host01"
bookmark-name="CPU Usage"
bookmark-parent-folder="/">
<launch-options>
<indication-settings maximum-number-of-records="1440">
<date-range>WITHIN_THE_PAST_24_HOURS</date-range>
<report-interval>HOUR</report-interval>
</indication-settings>
</launch-options>
<html-output>
<show-graph>
<graph-options zoom-scale = "100">
<show-grid/>
<vertical-axis minvalue="0" maxvalue="100"/>
</graph-options>
</show-graph>
<show-table/>
</html-output>
</registration-report-definition>
</launch-registration-report>
</pr-cli-parameters>
パラメーターファイル記述例(複合レポートを出力する場合)
サンプルのパラメーターファイル名:jpcrpt-parameters-for-combination-report.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0200">
<launch-combination-bookmark>
<combination-definition bookmark-name="CPU Usage with Baseline" bookmark-parent-folder="/">
<combination-options><combination-indication-settings>
<date-range>WITHIN_THE_PAST_24_HOURS</date-range>
<report-interval>HOUR</report-interval>
</combination-indication-settings>
</combination-options>
<combination-graph-options zoom-scale="100" />
</combination-definition>
</launch-combination-bookmark>
</pr-cli-parameters>
パラメーターの記述を定義するDTDファイル(rpt_params.dtd)を次に示します。
パラメーターの記述を定義するDTDファイル(rpt_params.dtd)
<!ENTITY % BOOL_VALUE "(true|false|TRUE|FALSE)">
<!ENTITY % ZOOM_VALUE "(100|200|400|600|800)">
<!ELEMENT pr-cli-parameters (launch-report | launch-registration-report |
launch-combination-bookmark)>
<!ATTLIST pr-cli-parameters
ver (0100 | 0110 | 0200) #REQUIRED>
<!ELEMENT launch-report (agent+, report-definition)>
<!ELEMENT agent (#PCDATA)>
<!ELEMENT report-definition (launch-options?, html-output?)>
<!ATTLIST report-definition
name CDATA #REQUIRED
parent-folder CDATA #REQUIRED>
<!ELEMENT launch-options ((indication-settings? | realtime-indication-settings?),
expression-values?)>
<!ELEMENT indication-settings (date-range?,
report-interval?,
start-time?,
end-time?,
peak-time?)>
<!ATTLIST indication-settings
maximum-number-of-records NMTOKEN #IMPLIED>
<!ELEMENT date-range (#PCDATA)>
<!ELEMENT report-interval (#PCDATA)>
<!ELEMENT start-time (#PCDATA)>
<!ELEMENT end-time (#PCDATA)>
<!ELEMENT peak-time (#PCDATA)>
<!ELEMENT realtime-indication-settings (display-by-ranking?)>
<!ATTLIST realtime-indication-settings
indicate-delta-value %BOOL_VALUE; #IMPLIED>
<!ELEMENT display-by-ranking EMPTY>
<!ATTLIST display-by-ranking
field CDATA #REQUIRED
display-number NMTOKEN #IMPLIED
in-descending-order %BOOL_VALUE; #IMPLIED>
<!ELEMENT expression-values (expression-value+)>
<!ELEMENT expression-value (#PCDATA)>
<!ATTLIST expression-value
pos NMTOKEN #IMPLIED>
<!ELEMENT html-output (show-graph? , show-table?)>
<!ELEMENT show-graph ( graph-options?)>
<!ELEMENT show-table EMPTY>
<!ELEMENT graph-options (show-3d?, show-grid?, vertical-axis?)>
<!ATTLIST graph-options
zoom-scale %ZOOM_VALUE; #IMPLIED>
<!ELEMENT show-3d EMPTY>
<!ELEMENT show-grid EMPTY>
<!ELEMENT vertical-axis EMPTY>
<!ATTLIST vertical-axis
minvalue NMTOKEN #REQUIRED
maxvalue NMTOKEN #REQUIRED>
<!ELEMENT launch-registration-report (registration-report-definition)>
<!ELEMENT registration-report-definition (launch-options?, html-output?)>
<!ATTLIST registration-report-definition
bookmark-name CDATA #REQUIRED
report-name CDATA #REQUIRED
bookmark-parent-folder CDATA #REQUIRED>
<!ELEMENT launch-combination-bookmark (combination-definition)>
<!ELEMENT combination-definition (combination-options?,
combination-graph-options?)>
<!ATTLIST combination-definition
bookmark-name CDATA #REQUIRED
bookmark-parent-folder CDATA #REQUIRED>
<!ELEMENT combination-options (combination-indication-settings?,
baseline-indication-settings?)>
<!ELEMENT combination-graph-options EMPTY>
<!ATTLIST combination-graph-options
zoom-scale %ZOOM_VALUE; #IMPLIED>
<!ELEMENT combination-indication-settings (date-range?,
report-interval?,
start-time?,
end-time?)>
<!ELEMENT baseline-indication-settings (baseline-start-time?)>
<!ELEMENT baseline-start-time (#PCDATA)>
注意事項
表12-86 date-range,start-time,end-time指定の組み合わせ
パラメーターファイルでの 指定の有無 | レポート実行時の設定値 | ||||
---|---|---|---|---|---|
date-range | start-time | end-time | date-range | start-time | end-time |
× | × | × | レポート定義の値 | end-timeから計算した値※1 | レポート実行時のサーバ時間 |
× | ○ | × | SPECIFY_WHEN_DISPLAYED | パラメーターファイルの指定値 | 「表12-87 start-time,end-timeの計算式」を参照※2 |
× | × | ○ | SPECIFY_WHEN_DISPLAYED | 「表12-87 start-time,end-timeの計算式」を参照※1 | パラメーターファイルの指定値 |
× | ○ | ○ | SPECIFY_WHEN_DISPLAYED | パラメーターファイルの指定値 | パラメーターファイルの指定値 |
○ | × | × | パラメーターファイルの指定値 | 「表12-87 start-time,end-timeの計算式」を参照※1 | レポート実行時のサーバ時間 |
○ | ○ | × | SPECIFY_WHEN_DISPLAYED | パラメーターファイルの指定位置 | 「表12-87 start-time,end-timeの計算式」を参照※2 |
○ | × | ○ | SPECIFY_WHEN_DISPLAYED | 「表12-87 start-time,end-timeの計算式」を参照※1 | パラメーターファイルの指定値 |
○ | ○ | ○ | エラー |
表12-87 start-time,end-timeの計算式
date-range | report-interval | start-timeの値 | end-timeの値 |
---|---|---|---|
WITHIN_THE_PAST_HOUR | Minute | end-timeから1時間分引いた日時 | start-timeに1時間分足した日時 |
WITHIN_THE_PAST_24_HOURS | Hour | end-timeから1日分引いた日時 | start-timeに1日分足した日時 |
WITHIN_THE_PAST_7_DAYS | Day | end-timeから7日分引いた日時 | start-timeに7日分足した日時 |
WITHIN_THE_PAST_MONTH | Week | end-timeから1か月分引いた日時 ただし,計算結果が存在しない日付になる場合は,その前日の日付になります。その前日の日付も存在しない場合は,存在する日付までさかのぼります。なお,計算時にうるう年も考慮します。 | start-timeに1か月分足した日時 ただし,計算結果が存在しない日付になる場合は,その前日の日付になります。その前日の日付も存在しない場合は,存在する日付までさかのぼります。なお,計算時にうるう年も考慮します。 |
WITHIN_THE_PAST_YEAR | Month | end-timeから1年分引いた日時 なお,end-timeにうるう年の2月29日が指定された場合は,前年の2月28日を設定します。 | start-timeに1年分足した日時 なお,start-timeにうるう年の2月29日が指定された場合は,翌年の2月28日を設定します。 |
Year |
表12-88 start-time,end-time,およびbaseline-start-timeの入力フォーマット
report-interval | 日付フォーマット※ | ||
---|---|---|---|
[dd△MM△yyyy] | [MM△dd△yyyy] | [yyyy△MM△dd] | |
MINUTE | [dd△MM△yyyy△HH:mm] | [MM△dd△yyyy△HH:mm] | [yyyy△MM△dd△HH:mm] |
HOUR | [dd△MM△yyyy△HH:00] | [MM△dd△yyyy△HH:00] | [yyyy△MM△dd△HH:00] |
DAY | [dd△MM△yyyy] | [MM△dd△yyyy] | [yyyy△MM△dd] |
WEEK | [dd△MM△yyyy] | [MM△dd△yyyy] | [yyyy△MM△dd] |
MONTH | [MM△yyyy] | [MM△yyyy] | [yyyy△MM] |
YEAR | [yyyy] | [yyyy] | [yyyy] |
戻り値
0 | 正常終了しました。 |
1 | コマンドライン書式不正,および不正オプション,オプション値のフォーマット不正です。 |
2 | コマンドを実行したOSユーザーに実行権限がありません。 |
4 | コマンドラインのオプションエラーが発生しました。 -rc,-riオプションの範囲が不正です。 |
5 | DTDと不整合のため,パラメーターを解析できません。 |
6 | DTDの指定値が不正です。 |
10 | 入力ファイル中の指定値が不正です。 |
21 | 出力ファイルのアクセスエラーが発生しました。 |
80 | ユーザーによる上書き拒否されています。 |
100 | 環境不正による初期化エラーが発生しました。 |
200 | メモリー不足です。 |
202 | 入力ファイルのアクセスエラーが発生しました。 |
220 | Managerアクセスエラーが発生しました。 |
222 | Managerの接続が失敗しました。 |
223 | 通信処理エラーが発生しました。 |
224 | エージェント接続エラーが発生しました。 |
255 | 予期しないエラーが発生しました。 |
使用例
レポート出力の定義内容を記述したパラメーターファイル(param.xml)をファイル(output.csv)に出力する場合のコマンド実行例を次に示します。
jpcrpt -o output.csv -y param.xml
出力例
コマンド処理の詳細情報を標準出力,標準エラー出力,トレースログファイルに出力します。ログ仕様については,マニュアル「Hitachi Command Suite Tuning Manager Software 運用管理ガイド」を参照してください。
標準出力形式を次に示します。引数で指定したレポート出力の実行結果を表示します(OKまたはERR)。
標準出力の出力例(成功時)
jpcrpt connected to hostname at dd MM yyyy HH:MM:SS.mmm
result OK : <レポート定義ディレクトリパス>/<レポート定義名@Agent CollectorサービスのサービスID>
jpcrpt disconnected at dd MM yyyy HH:MM:SS.mmm
出力ファイル
レポート結果をCSV形式で出力する場合
このコマンドの出力ファイルのデータヘッダーに出力する情報を次の表に示します。
表12-89 データヘッダーに出力する情報
データヘッダー情報 | 出力する情報 |
---|---|
Report: | レポート名のフルパスを出力します。 |
Agents: | エージェント名を出力します。 |
Date Format: | 日付フォーマットおよびセパレーターを出力します。 |
Command: | オプションで指定した順に出力します。 |
空行 | なし |
列見出し | フィールドの列見出しを出力します。 フィールドの列見出しに出力されるのは,フィールドのスキーマ名です。ただし,定義時にフィールドに対して,[表示名]が設定されている場合は,設定された[表示名]が出力されます。 詳細は,「6.4.1 CSV出力の例」を参照してください。 |
このコマンドの出力ファイル例を次に示します。なお,結果が0件の場合またはエージェントが停止していた場合,データ部は出力されません。データヘッダー部だけが出力されます。
レポート結果をCSV形式で出力したときの出力ファイル例
Report: /Windows/Troubleshooting/RecentPast/System Overview
Agents: TA1htmprsvr
Date Format: pattern-yyyyMMdd,slash
Command:jpcrpt -input C:¥ProgramFiles¥Hitachi¥jp1pcwebopt¥
param.xml,-o C:¥ProgramFiles¥Hitachi¥jp1pcwebopt¥
output.csv,-y
Agent Host,Agent Instance,Date and Time,CPU %,User CPU %,
Privileged CPU %,Processor Queue Length,Context Switches/sec,
% Total Interrupt Time,System Calls/sec
htmprsvr,htmprsvr,2004/08/10 09:00:00,10.910626,8.917643,
1.9929985,4,825.3214,0.040342055,3351.263
htmprsvr,htmprsvr,2004/08/10 10:00:00,10.646775,9.116808,
1.5356027,5,778.178,0.009959743,3238.7776
htmprsvr,htmprsvr,2004/08/10 11:00:00,11.603203,9.505386,
2.0978165,3,809.5369,0.036344547,3257.031
htmprsvr,htmprsvr,2004/08/10 12:00:00,2.2210534,0.8610586,
1.3599948,2,744.3879,0.0121342335,3597.5398
htmprsvr,htmprsvr,2004/08/10 13:00:00,2.2657635,1.1398388,
1.1259354,3,675.37067,0.024730453,2883.5593
htmprsvr,htmprsvr,2004/08/10 14:00:00,10.394524,8.527414,
1.8726714,4,817.1143,0.009072154,3453.1233
HTML形式のレポートはレポートヘッダー部,グラフ表示部,テーブル表示部の3つのパートで構成されます。各パートに表示される内容と表示条件を出力対象ごとに「表12-90 各パートに表示される内容と表示条件(コマンドで出力した場合)」に示します。
表12-90 各パートに表示される内容と表示条件(コマンドで出力した場合)
パート | 出力対象 | ||
---|---|---|---|
レポート出力 | 登録レポート出力 | 複合ブックマーク出力 | |
レポートヘッダー部 | レポート名,エージェント名※1,日付フォーマット,コマンドラインがコロンで区切って表示される。 | レポート名,エージェント名※1,日付フォーマット,コマンドラインがコロンで区切って表示される。 | ブックマーク名,日付フォーマット,コマンドラインがコロンで区切って出力される。 |
グラフ表示部 | レポート出力画面で使用されるものと同様のグラフ画像が表示される。 レポート定義でグラフ表示が有効かつ入力ファイルでshow-graphタグを指定した場合に表示される。 | レポート出力画面で使用されるものと同様のグラフ画像が表示される。 登録レポートのレポート定義でグラフ表示が有効かつ入力ファイルでshow-graphタグを指定した場合に表示される。 | 複合レポートのレポート出力画面で使用されるものと同様のグラフ画像が表示される。 |
テーブル表示部 | 表形式のデータすべてが1つの画面に表示される。※2 レポート定義でテーブル表示が有効かつ入力ファイルでshow-tableタグを指定した場合に表示される。 | 表形式のデータすべてが1つの画面に表示される。※2 登録レポートのレポート定義でテーブル表示が有効かつ入力ファイルでshow-tableタグを指定した場合に表示される。 | 表示されない(複合レポートでは表形式の出力はない)。 |
なお,データが0件の場合またはエージェントが停止していた場合は,レポートヘッダー部だけが出力されます。
HTMLはUTF-8コードで出力され,config.xmlファイルのExport形式での文字コード,改行の設定には従いません。