JP1/Performance Management リファレンス
形式
jpcrpt -o 出力ファイル名 [-mx 最大ヒープサイズ] [-ms 初期ヒープサイズ] [-y] [-rc 更新回数] [-ri 更新間隔] [-dateformat 日付フォーマットのパターン名] [-dateseparator 日付フォーマットのセパレーター名] [-exportseparator レポート出力時の日付フォーマットの セパレーター名] [-agent サービスID[,サービスID]・・・] 入力ファイル名
機能
jpcrptコマンドは,レポートをCSV形式またはHTML形式でファイル出力するコマンドです。出力定義は,コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。パラメーターファイルには,レポートの出力形式,出力対象のレポート,およびShow options画面相当の項目が指定できます。
なお,jpcrptコマンドで出力できるレポートの種類はPFM - Web Consoleのバージョンによって異なります。バージョンごとのレポート出力可否を次の表に示します。
表2-25 バージョンごとのレポート出力可否
出力対象 08-00 08-10 08-11 レポート CSV出力 ○ ○ ○ HTML出力 × ○ ○ 登録レポート CSV出力 × × ○ HTML出力 × × ○ 複合レポート HTML出力 × × ○ (凡例)○:出力できる ×:出力できない
1パラメーターファイルに1レポートを指定できます。出力するレポートがリアルタイムレポートの場合,CSV形式によるレポート出力のときは,rcオプションで指定した更新回数分のデータを,riオプションで指定した更新間隔に従って,出力ファイルの末尾に追記します。HTML形式によるレポート出力のときは,コマンド実行時の最新のデータでHTMLファイルを出力します。HTMLファイルを出力したあと,データは更新されません。また,HTML形式によるレポート出力では,rcオプションとriオプションを指定しても無効になります。
シングルエージェントレポートに対して,複数エージェントを指定した場合は,エラーになります。
コマンドを実行できるホスト
PFM - Web Console
実行権限
- Windowsの場合
- OSのユーザー権限:Administrators権限を持つユーザー
- Performance Managementのユーザー権限:一般ユーザー権限,または管理ユーザー権限を持つユーザー
- UNIXの場合
- OSのユーザー権限:rootユーザー権限を持つユーザー
- Performance Managementのユーザー権限:一般ユーザー権限,または管理ユーザー権限を持つユーザー
格納先ディレクトリ
- Windowsの場合
- インストール先フォルダ\tools\
- UNIXの場合
- /opt/jp1pcwebcon/tools/
引数
-o 出力ファイル名
レポートを出力するファイル名称を指定します。出力ファイル名を指定しないと,エラーになります。また,出力ファイル名を指定するとき,次に示す文字は含めないでください。
# % < > & \出力ファイル名は,絶対ファイルパス名,相対ファイルパス名,またはファイル名で指定できます。絶対ファイルパス名以外の場合は,カレントディレクトリを基点とします。指定されたディレクトリが存在しない場合は,エラーになります。指定されたファイルが重複した場合は,-yオプションの指定に従います。
出力ファイル名は,レポートの出力形式と指定するファイル名によって次のように異なります。CSV形式の場合,指定するファイル名に拡張子がないときは,出力するファイル名も拡張子を持ちません。HTML形式の場合は,指定するファイル名に拡張子があるないに関係なく,htmとpng(グラフ画像)の拡張子を持つファイルが出力されます。
出力形式 指定するファイル名 出力ファイル名 CSV output output output.csv (推奨) output.csv HTML output (推奨) output.htm output.png output.htm output.htm.htm output.htm.png なお,HTML形式のレポートを出力する場合は,出力ファイルパスに次の文字を含むパスを指定すると,メッセージ「KAVJK0210-E コマンドライン:出力ファイルの書き込み中に入出力エラーが発生しました。」が表示され,コマンドの実行を中断します。
# % < > & \ "-mx 最大ヒープサイズ
java.exeの最大ヒープサイズをMB単位で指定します。デフォルトは,64MBです。実際に取得できる最大サイズは,システムに依存します。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
- 1〜1,024の整数
- 「-mxの指定値 >= -msの指定値」
-ms 初期ヒープサイズ
java.exeの初期ヒープサイズをMB単位で指定します。デフォルトは,32MBです。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
- 1〜1,024の整数
- 「-mxの指定値 >= -msの指定値」
-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>タグに記述した日付の形式を判定します。また,出力ファイルの日付の形式を決定します。指定できる日付フォーマットのパターン名を次に示します。
- pattern-ddMMyyyy
- pattern-MMddyyyy
- pattern-yyyyMMdd
-dateseparator 日付フォーマットのセパレーター名
指定したセパレーター名に対応するセパレーター文字列で,入力ファイルの<expression-value>,<start-time>,<end-time>,<baseline-start-time>タグに記述したセパレーターの形式を判定します。また,出力ファイルのセパレーターの形式を決定します。指定できる日付フォーマットのセパレーター名を次に示します。
- space
- slash
- hyphen
- period
-exportseparator レポート出力時の日付フォーマットのセパレーター名
レポート出力時の日付フォーマットセパレーター名に対応するセパレーター文字列を指定します。このオプションの指定は,-dateseparatorの指定よりも優先されます。指定できる日付フォーマットのセパレーター名を次に示します。省略した場合,config.xmlの設定値になります。
- space
- slash
- hyphen
- period
-agent サービスID
レポート出力対象のエージェントを,Agent CollectorサービスのサービスIDで指定します。レポート定義のレポート種別が「履歴(複数のエージェント)」で,複数のサービスIDを指定する場合はカンマ区切りで指定します。この場合,左側のサービスIDから順番に処理します。サービスIDを重複して指定した場合,先に指定したサービスIDを有効とします。
このオプションが指定された場合,パラメータファイル内に<agent>タグが指定されていても無視されます。
存在しないサービスIDやレポート定義とプロダクトの異なるサービスIDを指定するとエラーになります。レポート定義のレポート種別が「履歴(複数のエージェント)」以外で,サービスIDを複数指定するとエラーになります。また,登録レポートまたは複合レポートに対して指定された場合は無視されます。
入力ファイル名
レポートを出力するための定義を記述した入力ファイル名を指定します。入力ファイルは,XML形式のパラメーターファイルです。このパラメーターファイルは,後述の「パラメーターファイルの形式」に基づいて作成します。入力ファイル名は,絶対パスでも相対パスでも指定できます。絶対パス以外で指定する場合は,カレントディレクトリを基点とします。
XMLタグ仕様
パラメーターファイルの記述例を次に示します。なお,パラメーターファイルのサンプルを下記ディレクトリに格納しています。パラメーターファイルを記述するときの雛形として利用してください。
- Windowsの場合:
- <インストール先ディレクトリ>\sample\conf
- UNIXの場合:
- /opt/jp1pcwebcon/sample/conf
パラメーターファイル記述例(登録レポート,複合レポート以外のレポートを出力する場合)
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd"> <pr-cli-parameters ver="0210"> <launch-report> <agent>TA1htmprsvr</agent> <agent>TA1admin</agent> <report-definition name="CPU Trend" parent-folder="/Windows/Operating System/Monthly 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-3d/> <show-grid/> <vertical-axis minvalue="0" maxvalue="100"/> </graph-options> </show-graph> <show-table/> </html-output> </report-definition> </launch-report> </pr-cli-parameters>パラメーターファイル記述例(登録レポートを出力する場合)
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd"> <pr-cli-parameters ver="0210"> <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>パラメーターファイル記述例(複合レポートを出力する場合)
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd"> <pr-cli-parameters ver="0210"> <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)を次に示します。
<!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 | 0210) #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 | relative-time)*> <!ELEMENT end-time (#PCDATA | relative-time)*> <!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 | relative-time)*> <!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-indication-settings (date-range?, report-interval?, start-time?, end-time?)> <!ELEMENT baseline-indication-settings (baseline-start-time?)> <!ELEMENT baseline-start-time (#PCDATA | relative-time)*> <!ELEMENT relative-time EMPTY> <!ATTLIST relative-time origin (NOW | now | THIS-HOUR | this-hour | THIS-DAY | this-day | THIS-WEEK | this-week | THIS-MONTH | this-month | THIS-YEAR | this-year) #REQUIRED year NMTOKEN #IMPLIED month NMTOKEN #IMPLIED week NMTOKEN #IMPLIED day NMTOKEN #IMPLIED hour NMTOKEN #IMPLIED minute NMTOKEN #IMPLIED>
- launch-report
種別 説明 意味 レポートを出力する場合に,レポート定義とエージェントの組み合わせを指定します。 指定可能値 なし 省略 可(launch-report,launch-registration-reportまたはlaunch-combination-bookmarkのどれか一つだけを指定する必要があります。) 属性 なし 親要素 pr-cli-parameters 子要素 agent(複数指定できます。) report-definition - agent
種別 説明 意味 レポート出力対象となるエージェントを一つ指定します。 指定可能値 エージェントの,Agent CollectorサービスのサービスIDを指定します。存在しないサービスIDを指定するとエラーになります。プロダクトが混在したサービスIDを指定するとエラーになります。サービスIDを重複して指定した場合,先に指定したサービスIDが有効になります。「report-definition」に指定したレポートのレポート種別がマルチエージェント以外で,サービスIDを複数指定するとエラーになります。
PFM - Web Console 08-50以降で,コマンドの実行時に-agentオプションが指定された場合,このタグの指定値は無視されます。逆に,このタグを省略した場合は,コマンド実行時に-agentオプションを指定する必要があります。省略 不可 属性 なし 親要素 launch-report 子要素 なし - report-definition
種別 説明 意味 レポート出力対象となるレポート定義を一つ指定します。
ただし,次の場合はエラーになります。
- 指定したレポート定義のプロダクトと同じプロダクトのエージェントを指定していない場合
- レポート定義のデータモデルバージョンか,またはそれより新しいエージェントのデータモデルバージョンとなるエージェントを指定していない場合
指定可能値 なし 省略 不可 属性 name 1〜64文字(バイトではない)の全角文字または半角文字でファイル出力するレポート定義名を指定します。レポート定義名に「\」または「/」を含む場合,それぞれ「\\」「\/」と記述します。
存在しないレポート名を指定すると,エラーになります。省略するとエラーになります。parent-folder name属性で指定したレポート定義の親ディレクトリをディレクトリパスで指定します。ディレクトリパスは「/」で始まり,上位レベルのディレクトリ名から順に半角「/」で区切って指定します。ルートディレクトリを指定する場合は,「/」だけを指定します。ディレクトリ名に「\」または「/」を含む場合,それぞれ「\\」「\/」と記述します。存在しないディレクトリを指定すると,エラーになります。また,省略するとエラーになります。ディレクトリパス名の最後に「\」または「/」を記述してもエラーになりません。 親要素 launch-report 子要素 launch-options(1report-definitionに1回だけ指定できます。省略できます。) html-output(1report-definitionに1回だけ指定できます。省略できます。) - launch-options
種別 説明 意味 レポートの取得条件を指定します。 指定可能値 なし 省略 可(省略時は設定しません。) 属性 なし 親要素 report-definition,registration-report-definition 子要素 indication-settings(1launch-optionsに1回だけ指定できます。省略できます。) realtime-indication-settings(1launch-optionsに1回だけ指定できます。省略できます。) expression-values(1launch-optionsに1回だけ指定できます。省略できます。) - 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回だけ指定できます。省略できます。) - date-range
種別 説明 意味 レポートの取得期間を指定します。 指定可能値 次の値を指定できます。大文字と小文字は区別しません。
- 過去1時間以内の場合「WITHIN_THE_PAST_HOUR」
- 過去1日(24時間)以内の場合「WITHIN_THE_PAST_24_HOURS」
- 過去7日以内の場合「WITHIN_THE_PAST_7_DAYS」
- 過去1か月以内の場合「WITHIN_THE_PAST_MONTH」
- 過去1年以内の場合「WITHIN_THE_PAST_YEAR」
- レポート表示時に指定する場合「SPECIFY_WHEN_DISPLAYED」
省略 可(レポート定義の値を適用します。) 属性 なし 親要素 indication-settings,combination-indication-settings 子要素 なし - report-interval
種別 説明 意味 レポート間隔を指定します。 指定可能値 次の値を指定できます。大文字と小文字は区別しません。
レポートまたは登録レポートを出力する場合,レポート定義のレコードがPIレコード以外の場合に指定すると,エラーになります。複合レポートを出力する場合はエラーにならず,出力対象のうちPIレコードの系列だけがこの値を参照します。レポート定義にpeak timeが設定されている場合,「HOUR」以外を指定するとpeak timeは無効となります。
- 分単位の場合「MINUTE」
- 時間単位の場合「HOUR」
- 日単位(24時間)の場合「DAY」
- 週単位の場合「WEEK」
- 月単位の場合「MONTH」
- 年単位の場合「YEAR」
省略 可(レポート定義の値を適用します。) 属性 なし 親要素 indication-settings,combination-indication-settings 子要素 なし - start-time
種別 説明 意味 開始日時を指定します。
絶対時刻で直接指定する方法と,子要素の<relative-time>タグで相対指定する方法があります。指定可能値 report-intervalで指定したフォーマットで指定します。report-intervalが指定できないレポートは,「MINUTE」が指定された場合のフォーマットで指定します。例えば,引数-dateformatに「pattern-yyyyMMdd」を,引数-dateseparatorに「space」を指定し,report-intervalに「MINUTE」を指定した場合,start-timeは「YYYY MM DD hh:mm」のフォーマットで指定します(YYYY=西暦年,MM=月,DD=日,hh=時,mm=分)。
次の場合,エラーになります。
- 指定値不正
- フォーマット不正
- end-timeより大きい値を指定
- 指定した年が1970以下,または2036以上
省略 date-rangeおよびend-time指定値との組み合わせに依存します。詳細については,後述の注意事項を参照してください。 属性 なし 親要素 indication-settings,combination-indication-settings 子要素 relative-time(1start-timeに1回だけ指定できます。省略できます)。 - end-time
種別 説明 意味 終了日時を指定します。
絶対時刻で直接指定する方法と,子要素の<relative-time>タグで相対指定する方法があります。指定可能値 report-intervalで指定したフォーマットで指定します。report-intervalが指定できないレポートは,「MINUTE」が指定された場合のフォーマットで指定します。例えば,引数-dateformatに「pattern-yyyyMMdd」を,引数-dateseparatorに「space」を指定し,report-intervalに「MINUTE」を指定した場合,end-timeは「YYYY MM DD hh:mm」のフォーマットで指定します(YYYY=西暦年,MM=月,DD=日,hh=時,mm=分)。
次の場合,エラーになります。
- 指定値不正
- フォーマット不正
- end-timeより大きい値を指定
- 指定した年が1970以下,または2036以上
省略 date-rangeおよびstart-time指定値との組み合わせに依存します。詳細については,後述の注意事項を参照してください。 属性 なし 親要素 indication-settings,combination-indication-settings 子要素 relative-time(1end-timeに1回だけ指定できます。省略できます)。 - peak-time
種別 説明 意味 ピーク時間を指定します。 指定可能値 ピーク時間を指定したいフィールドIDを指定します。「NONE」を指定すると,レポート定義で指定したフィールドIDは無効になります。
レポート定義が次の条件のどれかに該当するときに指定した場合,エラーになります。
- レコードがPIレコード以外
- レコードが複数インスタンス
- report-intervalがHOUR以外
省略 可(レポート定義の値を適用します。) 属性 なし 親要素 indication-settings 子要素 なし - realtime-indication-settings
種別 説明 意味 リアルタイムレポートのランキング表示を指定します。
レポート定義のレポート種別が「リアルタイム(一つのエージェント)」の場合に指定できます。それ以外の場合はエラーになります。指定可能値 なし 省略 可(子要素を含め,レポート定義の値を適用します。) 属性 indicate-delta-value デルタ値で取得する場合は「TRUE」,それ以外は「FALSE」と指定します。省略時は,レポート定義の値を適用します。 親要素 launch-options 子要素 display-by-ranking(1realtime-indication-settingsに1回だけ指定できます。省略できます。) - display-by-ranking
種別 説明 意味 ランキング取得フィールド,取得数,降順かどうかを指定できます。
レポート定義のレコードが単数インスタンスの場合,エラーになります。指定可能値 なし 省略 レポート定義の値 属性 field ランキング取得するフィールドIDを指定します。
ランキング取得をしない場合は,「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 子要素 なし - expression-values
種別 説明 意味 条件式を一つ以上指定します。
「Specify when displayed」で設定された条件式を含まないレポートに指定すると,エラーになります。指定可能値 なし 省略 可(省略時は設定しません) 属性 なし 親要素 launch-options 子要素 expression-value(複数指定できます。) - expression-value
種別 説明 意味 条件式の値を一つ指定します。 指定可能値 pos属性で指定された行の式の値を指定します。
指定可能値は,整数,小数値,または2,048バイト以内の半角文字列です。省略 可(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を省略すると,一つ前のposの値+1となります。
posに同じ値を複数指定できます。この場合,最後に指定された値が有効になります。
範囲外の値を指定すると,エラーになります。親要素 expression-values 子要素 relative-time(1expression-valueに1回だけ指定できます。省略できます)。 - html-output
種別 説明 意味 HTML形式でレポートを出力します。出力するレポートのフォーマットについては,後述の出力ファイルを参照してください。
HTML形式のレポートは,次の形式でデータを表示できます。表示形式は,子要素で指定します。
子要素を指定しない場合は,ヘッダ部分のレポート定義名だけが出力されます。
- グラフ表示
- テーブル表示
指定可能値 なし 省略 CSV形式でレポート出力します。 属性 なし 親要素 report-definition,registration-report-definition 子要素 ※ show-graph(1html-outputに1回だけ指定できます。省略できます。) show-table(1html-outputに1回だけ指定できます。省略できます。) 注※ 子要素を指定する場合は,記載順に指定します。
- show-graph
種別 説明 意味 出力するレポートにグラフを表示します。グラフを表示する場合は,レポート定義でグラフ表示する設定をし,かつこのタグを指定します。レポート定義またはこのタグのどちらかの指定が無効の場合エラーにはなりませんが,レポートにグラフは表示されません。レポートに表示するグラフオプションは,子要素で指定します。子要素を指定しない場合は,デフォルト設定のグラフが表示されます。 指定可能値 なし 省略 レポートにはグラフを表示しません。 属性 なし 親要素 html-output 子要素 graph-options(1show-graphに1回だけ指定できます。省略できます。) - graph-options
種別 説明 意味 グラフオプションの設定を変更します。子要素の指定によって,次の項目の設定を変更できます。
- 3Dで表示する
- グリッドを表示する
- 縦軸の最大値と最小値を手動で設定する
指定可能値 なし 省略 3D表示オフ,グリッド表示オフ,縦軸は自動設定となります。 属性 zoom-scale グラフの拡大率を指定します。選択できる値は,100,200,400,600,800のどれかです。省略時のデフォルトは100です。不正な値を指定した場合は,エラーになります。 親要素 show-graph 子要素 ※ show-3d(1graph-optionsに1回だけ指定できます。省略できます。) show-grid(1graph-optionsに1回だけ指定できます。省略できます。) vertical-axis(1graph-optionsに1回だけ指定できます。省略できます。) 注※ 子要素を指定する場合は,記載順に指定します。
- show-3d
種別 説明 意味 グラフを3Dで表示します。ただし,グラフ種別が線,面(積み上げ面)グラフの場合はエラーになります。 指定可能値 なし 省略 グラフを2Dで表示します。 属性 なし 親要素 graph-options 子要素 なし - show-grid
種別 説明 意味 グラフ上にグリッドを表示します。ただし,グラフ種別が円グラフの場合はエラーになります。 指定可能値 なし 省略 グリッドを表示しません。 属性 なし 親要素 graph-options 子要素 なし - vertical-axis
種別 説明 意味 レポートで表示するグラフの縦軸の範囲を指定します。ただし,グラフ種別が円グラフの場合はエラーになります。 指定可能値 なし 省略 縦軸がグラフのデータに応じて自動で設定されます。 属性 minvalue 縦軸の最小値を実数値で指定します。指定できる範囲は,-1.797E308〜1.797E308です。省略時およびminvalue>maxvalueの場合は,エラーになります。 maxvalue 縦軸の最大値を実数値で指定します。指定できる範囲は,-1.797E308〜1.797E308です。省略時およびminvalue>maxvalueの場合は,エラーになります。 親要素 graph-options 子要素 なし - show-table
種別 説明 意味 出力するレポートでテーブル(表)を表示します。テーブルを表示する場合は,レポート定義でテーブル表示を設定し,かつこのタグを指定します。レポート定義およびこのタグのどちらかの指定が無効の場合エラーにはなりませんが,レポートにテーブルは表示されません。 指定可能値 なし 省略 レポートにはテーブルを表示しません。 属性 なし 親要素 html-output 子要素 なし - launch-registration-report
種別 説明 意味 ブックマーク階層のブックマーク(複合ブックマークを含む)の配下にある登録レポートを指定します。 指定可能値 なし 省略 可(launch-report,launch-registration-reportまたはlaunch-combination-bookmarkのどれか一つだけを指定する必要があります。) 属性 なし 親要素 pr-cli-parameters 子要素 registration-report-definition - registration-report-definition
種別 説明 意味 レポート出力対象となる登録レポートを一つ指定します。 指定可能値 なし 省略 可(launch-registration-reportを指定した場合は省略不可) 属性 bookmark-name ファイル出力する登録レポートが格納されているブックマーク(複合ブックマークを含む)の名前を指定します。ブックマーク名に「\」または「/」を含む場合は,それぞれ「\\」または「\/」と記述します。存在しないブックマークを指定した場合はエラーになります。省略した場合はエラーになります。 report-name ファイル出力する登録レポートの名前を指定します。「\」または「/」を含める場合は,それぞれ「\\」または「\/」と記述します。bookmark-name属性で指定したブックマーク配下に存在しない登録レポートを指定するとエラーになります。省略した場合はエラーになります。
注意:同一ブックマーク配下に同じ名称の登録レポートが複数定義されている場合,コマンドによって一つ目に情報取得された登録レポートが出力されます。bookmark-parent-folder bookmark-name属性で指定したブックマークの親ディレクトリをディレクトリパスで指定します。ディレクトリパスは「/」で始まり,上位レベルのディレクトリ名から順に半角「/」で区切って指定します。ルートディレクトリを指定する場合は,「/」だけを指定します。ディレクトリ名に「\」または「/」を含む場合,それぞれ「\\」「\/」と記述します。存在しないディレクトリを指定すると,エラーになります。また,省略するとエラーになります。ディレクトリパス名の最後に「\」または「/」を記述するとエラーになります。 親要素 launch-registration-report 子要素 ※ launch-options(1registration-report-definitionに1回だけ指定できます。省略できます。) html-output(1registration-report-definitionに1回だけ指定できます。省略できます)。 注※ 子要素を指定する場合は,記載順に指定します。
- launch-combination-bookmark
種別 説明 意味 ブックマーク階層の複合ブックマークを指定します。 指定可能値 なし 省略 可(launch-report,launch-registration-reportまたはlaunch-combination-bookmarkのどれか一つだけを指定する必要があります。) 属性 なし 親要素 pr-cli-parameters 子要素 combination-definition - combination-definition
種別 説明 意味 レポート出力対象となる複合ブックマークを一つ指定します。 指定可能値 なし 省略 可(launch-combination-bookmarkを指定した場合は省略不可) 属性 bookmark-name ファイル出力する複合ブックマークの名前を指定します。ブックマーク名に「\」または「/」を含む場合は,それぞれ「\\」または「\/」と記述します。存在しないブックマーク,複合ブックマークではないブックマークを指定した場合はエラーになります。省略した場合はエラーになります。 bookmark-parent-folder bookmark-name属性で指定したブックマークの親ディレクトリをディレクトリパスで指定します。ディレクトリパスは「/」で始まり,上位レベルのディレクトリ名から順に半角「/」で区切って指定します。ルートディレクトリを指定する場合は,「/」だけを指定します。ディレクトリ名に「\」または「/」を含む場合,それぞれ「\\」「\/」と記述します。存在しないディレクトリを指定すると,エラーになります。また,省略するとエラーになります。ディレクトリパス名の最後に「\」または「/」を記述するとエラーになります。 親要素 launch-combination-bookmark 子要素 ※ combination-options(1combination-definitionに1回だけ指定できます。省略できます。) launch-options(1combination-definitionに1回だけ指定できます。省略できます。) 注※ 子要素を指定する場合は,記載順に指定します。
- combination-options
種別 説明 意味 複合レポートを出力する場合のオプションを指定します。指定は子要素によって行います。 指定可能値 なし 省略 複合レポートの表示オプションは設定されません。 属性 なし 親要素 combination-definition 子要素 ※ combination-indication-settings(1combination-optionsに1回だけ指定できます。省略できます。) baseline-indication-settings(1combination-optionsに1回だけ指定できます。省略できます。) 注※ 子要素を指定する場合は,記載順に指定します。
- 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回だけ指定できます。省略できます。) - baseline-indication-settings
種別 説明 意味 複合レポートのベースラインの表示開始位置を指定します。指定は子要素により行います。 指定可能値 なし 省略 ベースラインの開始位置として,デフォルト(レポートの開始日時)が使用されます。 属性 なし 親要素 combination-options 子要素 baseline-start-time - baseline-start-time
種別 説明 意味 複合レポートのベースラインの表示開始位置を指定します。
絶対時刻で直接指定する方法と,子要素の<relative-time>タグで相対指定する方法があります。指定可能値 report-intervalで指定したフォーマットで指定します。report-intervalが指定できないレポートは,「MINUTE」が指定された場合のフォーマットで指定します。例えば,引数-dateformatに「pattern-yyyyMMdd」を,引数-dateseparatorに「space」を指定し,report-intervalに「MINUTE」を指定した場合,baseline-start-timeは「YYYY MM DD hh:mm」のフォーマットで指定します(YYYY=西暦年,MM=月,DD=日,hh=時,mm=分)。
次の場合,エラーになります。
指定した年が1970以下,または2036以上
- 指定値不正
- フォーマット不正
- end-timeより大きい値を指定
省略 可(baseline-start-timeを指定した場合は省略不可) 属性 なし 親要素 baseline-indication-settings 子要素 relative-time(1baseline-start-timeに1回だけ指定できます。省略できます)。 - relative-time
種別 説明 意味 基点日時または基点日時からの相対時間で時刻を指定します。
基点日時は,PFM - Web Consoleホストのローカル時刻で,コマンドを実行した時間,またはコマンドを実行した時,日,週,月,年どれかの開始時刻から選択してorigin属性で指定します。さらに,オプション属性であるyear, month, week, day, hour, minuteを組み合わせて指定することで,基点日時から相対時間で時刻を指定できます。
最終的に算出された時刻の年が1970以下または2036以上の場合はエラーになります。指定可能値 なし 省略 省略時は,親要素のフォーマットに従って絶対時刻を指定する必要があります。 属性 origin 基点時刻を,コマンドを実行した時刻,または時,日,週,月,年どれかの開始時刻から指定します。
上記以外の値を指定した場合や,省略時はエラーになります。
- 「NOW」または「now」
コマンドを実行した時刻
- 「THIS-HOUR」または「this-hour」
コマンドを実行した時の0分
- 「THIS-DAY」または「this-day」
コマンドを実行した日の0時0分
- 「THIS-WEEK」または「this-week」
コマンドを実行した週の開始曜日の0時0分
- 「THIS-MONTH」または「this-month」
コマンドを実行した月の1日の0時0分
- 「THIS-YEAR」または「this-year」
コマンドを実行した年の1月1日0時0分
開始曜日は,デフォルトでは,コマンドを実行した環境のロケールに依存し,日本やアメリカでは日曜日になります。開始曜日はconfig.xmlのfirstDayOfWeekパラメーターで任意の曜日に変更できます。year 基点時刻からの相対年数を指定します。省略した場合は0になります。相対値を示す属性の中で,最初に評価されます。最終的に算出された時刻の年が1970以下または2036以上の場合はエラーになります。 month 基点時刻からの相対的な月の数を指定します。範囲は-12〜12です。省略した場合は0になります。year属性の次に評価されます。 week 基点時刻からの相対的な週の数を指定します。範囲は-53〜53です。省略した場合は0になります。month属性の次に評価されます。 day 基点時刻からの相対日数を指定します。範囲は-366〜366です。省略した場合は0になります。week属性の次に評価されます。 hour 基点時刻からの相対的な時間数を指定します。範囲は-24〜24です。省略した場合は0になります。day属性の次に評価されます。 minute 基点時刻からの相対的な分の数を指定します。範囲は-60〜60です。省略した場合は0になります。hour属性の次に評価されます。 親要素 start-time,end-time,expression-value,baseline-start-time 子要素 なし
- このコマンドは,実行時にPFM - Managerに対する認証が必要です。認証用のキーファイルを作成していない場合は,コマンドを実行する前に,jpcmkkeyコマンドで認証用のキーファイルを作成してください。
- 複数のレポートを出力する場合,その中のどれかのレポート出力処理がエラーになると処理をスキップし,ほかのレポートを出力します。ただし,パラメーターファイルの構文エラーが見つかった場合,スキップしないでその時点で終了します。
- レポート定義のフィルター条件式が「Specify when displayed」で初期値を設定している場合,パラメーターファイルの設定値の有無にかかわらず初期値が適用されます。ただし,初期値を設定していない場合は,パラメーターファイルに値を設定していないとエラーになります。
- date-range,start-time,およびend-timeの組み合わせでのレポート取得時の設定値を次の表に示します。
表2-26 date-range,start-time,およびend-timeの指定の組み合わせ
パラメーターファイルでの
指定有無レポート実行時の設定値 date-range start-time end-time date-range start-time end-time − − − レポート定義の値 end-timeから計算した値※1 レポート実行時のPFM - Web Consoleサーバ時間 − ○ − Specify when displayed パラメーターファイルで指定した値 ※2 − − ○ Specify when displayed ※1 パラメーターファイルで指定した値 − ○ ○ Specify when displayed パラメーターファイルで指定した値 パラメーターファイルで指定した値 ○ − − パラメーターファイルで指定した値 ※1 レポート実行時のPFM - Web Consoleサーバ時間 ○ ○ − Specify when displayed パラメーターファイルで指定した値 ※2 ○ − ○ Specify when displayed ※1 パラメーターファイルで指定した値 ○ ○ ○ エラーになる エラーになる エラーになる
- (凡例)
- ○:指定あり。
- −:指定なし。
- 注※1
- 計算方法は,「表2-27 start-timeおよびend-timeの計算式」のstart-timeの値を参照してください。
- ただし,date-rangeが「SPECIFY_WHEN_DISPLAYED」の場合は,report-intervalの設定値で計算されます。
- 注※2
- 計算方法は,「表2-27 start-timeおよびend-timeの計算式」のend-timeの値を参照してください。
- ただし,date-rangeが「SPECIFY_WHEN_DISPLAYED」の場合は,report-intervalの設定値で計算されます。
表2-27 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年分引いた数値になる。うるう年の2月29日に指定した場合は,前年の2月28日を設定する。 start-timeに1年分足した数値になる。うるう年の2月29日に指定した場合は,翌年の2月28日を設定する。 Year - start-time,end-time,およびbaseline-start-timeの入力フォーマットを次の表に示します。
表2-28 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]
- 注※
- 日付フォーマットは,初期設定ファイル(config.xml)の設定値やコマンドライン引数の-dateformatと-dateseparatorによって決定されます。なお,表中の△はデフォルトで半角スペースになりますが,日付フォーマットのセパレーター名に"slash", "hyphen", "period"を指定した場合,年月日の区切り位置にある△はそれぞれ「/」,「-」,「.」になります。
戻り値
0 正常終了した。 1 コマンドラインの形式が不正である。 2 コマンドの実行権限がない。 4 -rcオプション,または-riオプションに指定した範囲が不正である。 5 DTDファイルと不整合のためパラメーターを解析できない。 6 誤ったDTDファイルが指定された。 10 入力ファイルに指定した値が不正である。 11 PFM - Managerへの認証処理に失敗した。 21 出力ファイルにアクセスできない。 80 ユーザーによって上書きを拒否された。 100 Performance Managementの環境不正によって初期化できない。 200 メモリーが不足している。 202 入力ファイルにアクセスできない。 220 PFM - Managerにアクセスできない。 222 PFM - Managerに接続できない。 223 通信処理でエラーが発生した。 224 PFM - Agentに接続できない。 255 予期しないエラーが発生した。
使用例
レポート出力の定義内容を記述したパラメーターファイル(param.xml)をファイル(output.csv)に出力する場合のコマンド実行例を次に示します。
jpcrpt -o output.csv -y param.xml
出力例
コマンド処理の詳細情報を標準出力,標準エラー出力,トレースログファイルに出力します。ログ仕様については「3. ログ情報」を参照してください。
標準出力形式を次に示します。引数で指定したレポート出力の実行結果を表示します。
標準出力の出力例(成功時)
jpcrpt connected to hostname at dd MM yyyy HH:MM:SS.mmm result OK : レポート定義ディレクトリパス/レポート定義名@エージェントID jpcrpt disconnected at dd MM yyyy HH:MM:SS.mmm
レポート結果をCSV形式で出力する場合
このコマンドの出力ファイルのデータヘッダーに出力する情報を次の表に示します。
表2-29 データヘッダーに出力する情報
データヘッダー情報 出力する情報 Report: レポート名のフルパスを出力します。 Agents: エージェント名を出力します。 Date Format: 日付フォーマットおよびセパレーターを出力します。 Command: オプションで指定した順に出力します。 空行 なし。 列見出し フィールドの列見出しを出力します。
フィールドの列見出しに出力されるのは,フィールドのスキーマ名です。ただし,定義時にフィールドに対して,[表示名]が設定されている場合は,設定された[表示名]が出力されます。
詳細は,マニュアル「JP1/Performance Management システム構築・運用ガイド」の,「11.8.3 CSVの形式」のデータヘッダ2部を参照してください。このコマンドの出力ファイル例を次に示します。なお,結果が0件の場合またはエージェントが停止していた場合,データ部は出力されません。データヘッダー部だけが出力されます。
レポート結果をCSV形式で出力したときの出力ファイル例
Report: /Windows/Troubleshooting/RecentPast/System Overview Agents: TA1htmprsvr Date Format: pattern-yyyyMMdd,slash Command:jpcrpt -input C:\ProgramFiles\Hitachi\jp1pcWebCon\ param.xml,-o C:\ProgramFiles\Hitachi\jp1pcWebCon\ 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,2006/07/03 09:00:00,10.910626,8.917643, 1.9929985,4,825.3214,0.040342055,3351.263 htmprsvr,htmprsvr,2006/07/03 10:00:00,10.646775,9.116808, 1.5356027,5,778.178,0.009959743,3238.7776 htmprsvr,htmprsvr,2006/07/03 11:00:00,11.603203,9.505386, 2.0978165,3,809.5369,0.036344547,3257.031 htmprsvr,htmprsvr,2006/07/03 12:00:00,2.2210534,0.8610586, 1.3599948,2,744.3879,0.0121342335,3597.5398 htmprsvr,htmprsvr,2006/07/03 13:00:00,2.2657635,1.1398388, 1.1259354,3,675.37067,0.024730453,2883.5593 htmprsvr,htmprsvr,2006/07/03 14:00:00,10.394524,8.527414, 1.8726714,4,817.1143,0.009072154,3453.1233レポート結果をHTML形式で出力する場合
HTML形式のレポートは,レポートヘッダー部分,グラフ表示部分,およびテーブル表示部分で構成されます。
各部分に出力される内容および出力条件については,マニュアル「JP1/Performance Management システム構築・運用ガイド」の,「11.8.4 HTMLの形式」を参照してください。
結果が0件の場合またはエージェントが停止していた場合は,レポートヘッダー部だけが出力されます。
HTMLはUTF-8コードで出力されます。config.xmlのExport形式での文字コードや改行の設定には従いません。
時刻の相対指定によるレポート実行の運用例
時刻の相対指定方法を利用すると,定期的にレポートを実行する運用で,取得期間を効率良く指定できます。時刻の相対指定方法によるパラメータファイルの記述例について説明します。なお,時刻の相対指定ができるのはPFM - Web Console 08-50以降です。
運用例1
毎日24時間分(00:00〜24:00)に対するレポートを実行します。なお,jpcrptコマンドは翌日の00:00〜24:00の間に実行します。
- エージェント:TA1host1
- レポート定義:/Folder1/ReportA
- 取得期間:jpcrptコマンド実行時刻の前日1日
- サンプルのパラメータファイル名:jpcrpt-parameters-for-scheduled-operation1.xml
サンプルパラメータファイルの太字の部分を編集してください。
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd"> <pr-cli-parameters ver="0210"> <launch-report> <agent>TA1host1</agent> <report-definition name="ReportA" parent-folder="/Folder1"> <launch-options> <indication-settings> <report-interval>HOUR</report-interval> <start-time> <relative-time origin="THIS-DAY" day="-1"/> </start-time> <end-time> <relative-time origin="THIS-DAY"/> </end-time> </indication-settings> </launch-options> </report-definition> </launch-report> </pr-cli-parameters>上記の記述例では,<start-time>タグ,<end-time>タグ,共にorigin属性にTHIS-DAYを指定して,基点時刻をjpcrptコマンドを実行した当日の0時0分としています。<start-time>タグはday属性に-1を指定して,そこから1日さかのぼっています。これによって,取得期間の開始時刻を前日の0時0分,取得期間の終了時刻を当日の0時0分(=前日の24時0分)と指定しています。なお,出力するレコードがPIレコードの場合は,出力するレポートの間隔を<report-interval>タグで指定します。
運用例2
毎日8:30から翌日の5:00に対するレポートを実行します。なお,jpcrptコマンドは翌日の5:00〜8:30の間に実行します。
- エージェント:TA1host1
- レポート定義:/Folder1/ReportA
- 取得期間:jpcrptコマンド実行時刻の前日の8:30から当日の5:00
- サンプルのパラメータファイル名:jpcrpt-parameters-for-scheduled-operation2.xml
サンプルパラメータファイルの太字の部分を編集してください。
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd"> <pr-cli-parameters ver="0210"> <launch-report> <agent>TA1host1</agent> <report-definition name="ReportA" parent-folder="/Folder1"> <launch-options> <indication-settings> <report-interval>MINUTE</report-interval> <start-time> <relative-time origin="THIS-DAY" day="-1" hour="8" minute="30"/> </start-time> <end-time> <relative-time origin="THIS-DAY" hour="5"/> </end-time> </indication-settings> </launch-options> </report-definition> </launch-report> </pr-cli-parameters>運用例1の応用で,時や分の単位まで細かく設定している記述例です。<start-time>で前日の8:30を指定するとき,day属性を使用しないで,hour属性に-15,minute属性に-30を指定しても同じ結果が得られますが,この例で示すように,いったんday属性で1日さかのぼり,そこからhour属性とminute属性で時間を進めると読みやすい定義になります。なお,出力するレコードがPIレコードの場合は,出力するレポートの間隔を<report-interval>タグで指定します。
運用例3
毎週月曜日から金曜日(終日)に対するレポートを実行します。なお,jpcrptコマンドは翌日の土曜日にバッチ実行します。
- エージェント:TA1host1
- レポート定義:/Folder1/ReportA
- 取得期間:jpcrptコマンド実行時刻の週の月曜日から金曜日(終日)
- サンプルのパラメータファイル名:jpcrpt-parameters-for-scheduled-operation3.xml
サンプルパラメータファイルの太字の部分を編集してください。
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd"> <pr-cli-parameters ver="0210"> <launch-report> <agent>TA1host1</agent> <report-definition name="ReportA" parent-folder="/Folder1"> <launch-options> <indication-settings> <report-interval>DAY</report-interval> <start-time> <relative-time origin="THIS-WEEK" day="1"/> </start-time> <end-time> <relative-time origin="THIS-WEEK" day="6"/> </end-time> </indication-settings> </launch-options> </report-definition> </launch-report> </pr-cli-parameters>origin属性にTHIS-WEEKを指定する場合,基点時刻は週の開始曜日の0時0分になります。週の開始曜日は,日本ではデフォルトで日曜日となるため,ここでは<start-time>のday属性に+1することで開始時刻に月曜日の0時0分,<end-time>のday属性に+6することで終了時刻に土曜日の0時0分(=金曜日の24時0分)を指定できます。<end-time>はday属性+5とhour属性+24の組み合わせで表記しても同じ結果が得られます。
なお,jpcrptコマンドの実行が日曜日にずれ込んでしまう場合は,基点時刻も翌週にずれてしまうため,week属性に-1を加えるなどの考慮が必要になります。
また,出力するレコードがPIレコードの場合は,出力するレポートの間隔を<report-interval>タグで指定します。
運用例4
毎月25日の22:00に開始する月次処理の時間帯に対するレポートを実行します。ただし,月次処理にかかる時間にばらつきがあるため,終了時刻は26日をまたいでしまう場合があります。jpcrptコマンドは月次処理完了の直後に実行します。
- エージェント:TA1host1
- レポート定義:/Folder1/ReportA
- 取得期間:jpcrptコマンド実行時刻の当月の25日の22:00からコマンド実行時刻直前まで
- サンプルのパラメータファイル名:jpcrpt-parameters-for-scheduled-operation4.xml
サンプルパラメータファイルの太字の部分を編集してください。
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd"> <pr-cli-parameters ver="0210"> <launch-report> <agent>TA1host1</agent> <report-definition name="ReportA" parent-folder="/Folder1"> <launch-options> <indication-settings> <report-interval>MINUTE</report-interval> <start-time> <relative-time origin="THIS-MONTH" day="24" hour="22"/> </start-time> <end-time> <relative-time origin="NOW"/> </end-time> </indication-settings> </launch-options> </report-definition> </launch-report> </pr-cli-parameters>月次で実行するレポートの記述例です。終了時刻はコマンド実行時刻であるNOWを指定します。開始時刻は日付がずれないようにするため,基点時刻にTHIS-DAYではなくTHIS-MONTHなどを指定します。THIS-MONTHとday属性を組み合わせて指定する際の注意点として,THIS-MONTHは当月の1日を示すため,当月の25日を相対指定する場合はday属性を+24する必要があります。同様の理由から,THIS-YEARと組み合わせて指定するmonth属性やday属性の値にも注意が必要です。なお,出力するレコードがPIレコードの場合は,出力するレポートの間隔を<report-interval>タグで指定します。
運用例5
四半期(3個月)ごとのレポートを実行します。jpcrptコマンドは,各四半期の翌月である4月,7月,10月,1月に実行します。
- エージェント:TA1host1
- レポート定義:/Folder1/ReportA
- 取得期間:jpcrptコマンド実行時刻の3ヶ月前から前月
- サンプルのパラメータファイル名:jpcrpt-parameters-for-scheduled-operation5.xml
サンプルパラメータファイルの太字の部分を編集してください。
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd"> <pr-cli-parameters ver="0210"> <launch-report> <agent>TA1host1</agent> <report-definition name="ReportA" parent-folder="/Folder1"> <launch-options> <indication-settings> <report-interval>MONTH</report-interval> <start-time> <relative-time origin="THIS-MONTH" month="-3"/> </start-time> <end-time> <relative-time origin="THIS-MONTH"/> </end-time> </indication-settings> </launch-options> </report-definition> </launch-report> </pr-cli-parameters>四半期のレポートの記述例です。取得期間は3ヶ月であるため,<start-time>タグのmonth属性に-3を指定しています。なお,出力するレコードがPIレコードの場合は,出力するレポートの間隔を<report-interval>タグで指定します。
All Rights Reserved. Copyright (C) 2006, 2008, Hitachi, Ltd.