コマンド入出力

ここでは,PFM - Web Consoleで実行する次のコマンドの前提条件,コマンド入力方式,およびコマンド出力方式について説明します。

コマンド実行の前提条件

コマンド実行の前提条件を次に示します。

注※
config.xmlのファイル例については,「付録E 初期設定ファイル(config.xml)」を参照してください。

コマンドの入力方式

コマンドに指定するパラメーターファイルの記述方式を次に説明します。

パラメーターファイルの記述方式

コマンドの引数に指定するパラメーターファイルの記述方式を次に示します。

コマンドがサポートするDTDファイルの一覧を次の表に示します。

表2-2 コマンドがサポートするDTDファイル

コマンド名DTDファイル名
jpcrdef createrdef_create_params.dtd
rdef_params.dtd
jpcrdef deleterdef_create_params.dtd
rdef_delete_params.dtd
rdef_output_params.dtd
rdef_params.dtd
jpcrdef outputrdef_create_params.dtd
rdef_output_params.dtd
rdef_params.dtd
jpcasrec updateasrec_params.dtd
jpcasrec outputasrec_params.dtd
jpcaspsv updateaspsv_params.dtd
jpcaspsv outputaspsv_params.dtd
jpcrptrpt_params.dtd

pr-cli-parametersの説明を次の表に示します。

表2-3 pr-cli-parametersの説明

種別説明
意味PFM - Web Consoleコマンド入力のルートタグ
指定可能値なし
省略不可
属性verDTDファイルのバージョン。コマンドのサポート範囲外の値ならば,パラメーターファイルエラーとなります。また,省略するとエラーになります。サポート範囲については,各DTDファイルを参照してください。
親要素なし
子要素report-definitionsレポート定義情報のルートタグ
agent-store-db-record-definitionStoreデータベース記録方法変更定義情報のルートタグ
agent-store-db-preserve-definitionStoreデータベース保存条件変更定義情報のルートタグ
launch-reportレポート出力定義情報のルートタグ
launch-registration-report登録レポート出力定義情報のルートタグ
launch-combination-bookmark複合ブックマーク出力定義情報のルートタグ

パラメーターファイルの記述例を次に示します。太字で囲まれた部分にレポート定義を記述します。

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

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rdef_params.dtd">
<pr-cli-parameters ver="0110">
<report-definitions>
<report-definition> ・・・・レポート定義・・・・</report-definition>
<report-definition> ・・・・レポート定義・・・・</report-definition>
</report-definitions>
</pr-cli-parameters >

コマンドの出力方式

コマンド処理の詳細情報を標準出力,標準エラー出力,トレースログファイルに出力します。詳細情報の出力先を次の表に示します。

表2-4 詳細情報の出力

項目出力先
実行結果標準出力
メッセージ標準エラー出力
トレースログ初期化ファイルで指定したログ出力ディレクトリ下に「コマンド名_処理種別_log#.log(#:ログファイル番号[1からログファイル生成数まで])」を出力します。レポート作成コマンドの場合「jpcrdef_create_log1.log」などとなります。
jpcrptコマンドの場合,初期化ファイルで指定したログ出力ディレクトリ下に「コマンド名_プロセスID_log#.log(#:ログファイル番号[1からログファイル生成数まで])」を出力します。プロセスIDが100の場合,「jpcrpt_100_log1.log」になります。
コマンドを実行するごとにログファイルの合計サイズを計算し,上限を超えると更新日付の古いファイルから削除されます。ただし,コマンド起動時刻から初期化ファイルの「logFileRetention」で指定された日数より前に更新されたファイルだけ削除されます。サイズの上限は,config.xmlの「logFileSize」と「logFileNumber」を掛けた数値になります。
jpcmkkeyコマンドの場合,初期化ファイルで指定したログ出力ディレクトリ下に「jpcmkkey_log#.log(#:ログファイル番号[1からログファイル生成数まで])」を出力します。

標準出力例

コマンド名,接続先PFM - Managerホスト名/IPアドレス,PFM - Manager接続時刻,PFM - Manager切断時刻をコマンド共通のタイトル行・終了行として付けます。

jpcrdef createコマンドで,三つのレポート定義を指定し,二つのレポート定義が作成され,一つのレポート定義がエラーとなった場合の標準出力を次に示します。

実行結果出力例

jpcrdef create connected to hostname at yyyy MM dd HH:MM:SS.mmm
create result OK  : レポート定義ディレクトリパス1/レポート定義名1
create result OK  : レポート定義ディレクトリパス2/レポート定義名2
create result ERR : レポート定義ディレクトリパス3/レポート定義名3
エラー要因
jpcrdef create disconnected at yyyy MM dd HH:MM:SS.mmm

(凡例)
yyyy MM dd
西暦年,月,日を示します。ロケールによって設定されるデフォルトの形式またはconfig.xmlの「selectFormat」に指定した形式で表示します。日付フォーマットの設定については,「付録E 初期設定ファイル(config.xml)」を参照してください。
HH : MM : SS . mmm
時間:分:秒. ミリ秒を示します。
レポート定義ディレクトリパス1~3
report-definitionパラメーターのparent-folder属性で設定する,レポート定義を格納するディレクトリ名を示します。
レポート定義名1~3
report-definitionパラメーターのname属性で設定するレポート定義の名称を示します。

ログ仕様については「3. ログ情報」を参照してください。

ヘルプ参照オプション

コマンドに -hオプションを指定すると,コマンドのヘルプを参照できます。jpcrdefコマンドのヘルプを参照する場合は次のように入力します。

jpcrdef   -h

jpcrdefコマンドの場合のヘルプを次に示します。

Usage: jpcrdef <subcmd> [ <option>... ] <parameter file>
   <subcmd> 必須。次の中から一つを指定します。
       create          レポート定義を作成します。
       delete          レポート定義を削除します。
       output          レポート定義を出力します。
   <option> オプション情報を次の中から指定します。
       -o <outputfile> <subcmd>が'output'の時に,
                       出力先ファイル名称を指定します。
                       <subcmd>が'output'の時に必須です。
       -mx             プログラムの最大ヒープサイズを,
                       1~1024の数値で指定します(単位MB)。
                       例: '-mx 64'。 省略時は64MBです。
       -ms             プログラムの最小ヒープサイズを,
                       1~1024の数値で指定します(単位MB)。
                       例: '-ms 32'。 省略時は32MBです。
       -y              <subcmd>が'delete'の時に指定できます。
                       指定すると削除確認メッセージに対して,
                       すべて'y'で回答したことになります。
       -dateformat <pattern>
                       <subcmd>が'create','output'の時に
                       指定できます。
                       指定した<pattern>で,<expression>タグに
                       入出力する日付フォーマットを決定します。
                       指定できる<pattern>は,
                       'pattern-ddMMyyyy','pattern-MMddyyyy',
                       'pattern-yyyyMMdd'のどれかです。
       -dateseparator <pattern>
                       <subcmd>が'create','output'の時に
                       指定できます。
                       指定した<pattern>で,<expression>タグに
                       入出力する日付の区切り文字を決定します。
                       指定できる<pattern>は,'space','slash',
                       'hyphen','period'のどれかです。
   <parameter file>    必須。パラメーターファイル名を指定します。

注※ AIX,HP-UX(IPF),Solarisの場合は2から1024の数値を指定します。

コマンドの第1引数に -hオプションを指定すると,それ以降は無視して上記のヘルプを出力します。また,コマンドラインの書式不正の場合にも出力されます。

コマンドの同時実行

次のコマンド(jpcrptコマンド以外のコマンド)は,同じコマンド,またはほかのコマンドと同時に実行できません。

コマンド実行に必要なPerformance Managementのユーザー権限

GUIからレポート定義や収集項目を変更する場合,あらかじめPFM - Managerに対してログイン処理(認証)を行っておく必要があります。コマンドを実行する場合も,同様に認証を行います。この認証によって,コマンドの実行ユーザーがPerformance Managementシステム内で正当な実行権限を持っているのかを証明します。

コマンドでの認証は,実行時にユーザー名やパスワードを設定するのではなく,あらかじめ認証用のキーファイルを作成しておいて,コマンド実行時にそのキーファイルを読み込んで認証を行います。キーファイルはjpcmkkeyコマンドで作成します。1ホストに1キーファイルを作成し,キーファイル作成時に指定したユーザー名/パスワードを使用して,そのホストからのコマンドの実行を許可します。また,キーファイルはホストから実行されるコマンドで共有します。

コマンド実行に必要なPerformance Managementのユーザー権限を,次の表に示します。

表2-5 コマンド実行に必要なPerformance Managementのユーザー権限

コマンド必要なPerformance Managementのユーザー権限
jpcrdef create一般ユーザー権限または管理ユーザー権限
jpcrdef delete一般ユーザー権限または管理ユーザー権限
jpcrdef output一般ユーザー権限または管理ユーザー権限
jpcasrec update管理ユーザー権限
jpcasrec output管理ユーザー権限
jpcaspsv update管理ユーザー権限
jpcaspsv output管理ユーザー権限
jpcrpt一般ユーザー権限または管理ユーザー権限
jpcmkkeyなし
注※
Performance ManagementユーザーまたはJP1ユーザーが必要とする,Performance Managementに対する実行権限です。