JP1/Performance Management リファレンス
ここでは,PFM - Web Consoleで実行する次のコマンドの前提条件,コマンド入力方式,およびコマンド出力方式について説明します。
- jpcrdef create
- jpcrdef delete
- jpcrdef output
- jpcasrec update
- jpcasrec output
- jpcaspsv update
- jpcaspsv output
- jpcrpt
- jpcmkkey
- jpcprocdef create
- jpcprocdef delete
- jpcprocdef list
- jpcprocdef output
コマンド実行の前提条件を次に示します。
- コマンドに指定するパラメーターファイルの作成
パラメーターファイルを引数として指定するコマンドを実行する場合,指定するパラメーターファイルを事前に作成する必要があります。
パラメーターファイルの記述方式は,後述の「コマンドの入力方式」を参照してください。また,パラメーターファイルに指定するパラメーターについては,各コマンドの,パラメーターファイルの形式についての説明を参照してください。
- config.xml※ファイルに設定する<common>,<logging>,<vsa>タグの確認
config.xml※に<common>,<logging>,<vsa>タグが設定されているか確認してください。必須項目です。設定されていない場合は,config.xml※のファイル例を参考に記述してください。
- PFM - Managerの稼働状況の確認
コマンド実行時にPFM - Managerが稼働している必要があります。
- PFM - AgentまたはPFM - RMの稼働状況の確認
Storeデータベースに関するコマンドおよびレポート結果出力コマンドを実行する場合は,対応するPFM - AgentまたはPFM - RMが稼働している必要があります。
- コマンドの実行権限
コマンドを実行する場合,OSユーザーにAdministrators権限が必要となります。
- 認証用のキーファイルの作成
コマンドを実行する前に,あらかじめPFM - Managerに対する認証用のキーファイルを作成する必要があります。認証用のキーファイルはjpcmkkeyコマンドで作成します。
- 注※
- config.xmlのファイル例については,「付録E 初期設定ファイル(config.xml)」を参照してください。
コマンドに指定するパラメーターファイルの記述方式を次に説明します。
パラメーターファイルの記述方式
コマンドの引数に指定するパラメーターファイルの記述方式を次に示します。
- パラメーターファイルはXML形式で作成します。
- パラメーターは,XMLバージョンとエンコーディングを指定した直後に,<pr-cli-parameters>タグで囲んで指定します。
指定するパラメーターは,各コマンドのパラメーターの形式を参照してください。
- 「<」などXML形式の書式制御文字を値に含める場合,XML仕様が定める記法に従って記述する必要があります。
例えば,「<」の場合は「<」,「>」の場合は「>」と記述します。
- フィールドID,レコードID,date-range,report-intervalなど,コマンドのパラメーターファイル仕様で規定する固定のトークンから選択して指定する値は,仕様として明示的に制限されないかぎり,大文字だけ,または小文字だけであれば使用できます。パラメーターに指定する値の定義は,各コマンドの,パラメーターファイルの形式またはDTDファイルについての説明を参照してください。
- 「TRUE」を指定できるパラメーターについては,「true」も指定できます。また,「FALSE」を指定できるパラメーターについては,「false」も指定できます。
- 空白だけの要素値または属性値については,省略と見なします。また,要素値,属性値の前後に指定した半角空白は,無視します。
- 印字文字以外の文字を要素または属性に指定するとエラーとなります。
- パラメーターファイルのDOCTYPE宣言は固定です。パラメーターファイルのDOCTYPE宣言には,パラメーターの記述を定義するDTDファイル名を必ず指定してください。DOCTYPE宣言の例を次に示します。
<!DOCTYPE pr-cli-parameters SYSTEM "DTDファイル名">コマンドがサポートするDTDファイルの一覧を次の表に示します。
コマンド名 DTDファイル名 jpcrdef create rdef_create_params.dtd rdef_params.dtd jpcrdef delete rdef_create_params.dtd rdef_delete_params.dtd rdef_output_params.dtd rdef_params.dtd jpcrdef output rdef_create_params.dtd rdef_output_params.dtd rdef_params.dtd jpcasrec update asrec_params.dtd jpcasrec output asrec_params.dtd jpcaspsv update aspsv_params.dtd jpcaspsv output aspsv_params.dtd jpcrpt rpt_params.dtd jpcprocdef create processmonitoring_params.dtd jpcprocdef output processmonitoring_params.dtd
- parent-folder属性に「/」を指定すると,ルートディレクトリを指定できます。ルート以下のディレクトリ「Directory1」を指定する場合は,「/Directory1」と指定します。同様に,「Directory1」以下のディレクトリを指定する場合は,「/Directory1/Directory2...」のようにディレクトリ名を「/」で連結したディレクトリパスを指定します。ルートディレクトリ「/」に「User Reports」または「System Reports」を指定するとエラーになります。
- 「パラメーターファイルの形式」で指定する範囲外の値を指定した場合は,パラメーターファイルエラーとなります。
pr-cli-parametersの説明を次の表に示します。
表2-3 pr-cli-parametersの説明
種別 説明 意味 PFM - Web Consoleコマンド入力のルートタグ 指定可能値 なし 省略 不可 属性 ver DTDファイルのバージョン。コマンドのサポート範囲外の値ならば,パラメーターファイルエラーとなります。また,省略するとエラーになります。サポート範囲については,各DTDファイルを参照してください。 親要素 なし 子要素 report-definitions レポート定義情報のルートタグ agent-store-db-record-definition Storeデータベース記録方法変更定義情報のルートタグ agent-store-db-preserve-definition Storeデータベース保存条件変更定義情報のルートタグ launch-report レポート出力定義情報のルートタグ launch-registration-report 登録レポート出力定義情報のルートタグ launch-combination-bookmark 複合ブックマーク出力定義情報のルートタグ application-definition アプリケーション定義情報のルートタグ パラメーターファイルの記述例を次に示します。太字で囲まれた部分にレポート定義を記述します。
パラメーターファイルの記述例
<?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:
- 西暦年,月,日を示します。
- HH : MM : SS . mmm:
- 時間:分:秒. ミリ秒を示します。
- レポート定義ディレクトリパス1〜3:
- report-definitionパラメーターのparent-folder属性で設定する,レポート定義を格納するディレクトリ名を示します。
- レポート定義名1〜3:
- report-definitionパラメーターのname属性で設定するレポート定義の名称を示します。
ログ仕様については「3. ログ情報」を参照してください。
ヘルプ参照オプション
コマンドに -hオプションを指定すると,コマンドのヘルプを参照できます。jpcrdefコマンドのヘルプを参照する場合は次のように入力します。
jpcrdef -hjpcrdefコマンドの場合のヘルプを次に示します。
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,Solarisの場合は2から1024の数値を指定します。
コマンドの第1引数に -hオプションを指定すると,それ以降は無視して上記のヘルプを出力します。また,コマンドラインの書式不正の場合にも出力されます。
次のコマンド(jpcrptコマンド以外のコマンド)は,同じコマンド,またはほかのコマンドと同時に実行できません。
- jpcrdef create
- jpcrdef delete
- jpcrdef output
- jpcasrec update
- jpcasrec output
- jpcaspsv update
- jpcaspsv output
- jpcmkkey
- jpcprocdef create
- jpcprocdef delete
- jpcprocdef list
- jpcprocdef output
コマンド実行に必要な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 なし jpcprocdef create 管理ユーザー権限 jpcprocdef delete 管理ユーザー権限 jpcprocdef list 管理ユーザー権限 jpcprocdef output 管理ユーザー権限
- 注※
- Performance ManagementユーザーまたはJP1ユーザーが必要とする,Performance Managementに対する実行権限です。
All Rights Reserved. Copyright (C) 2009, 2012, Hitachi, Ltd.
(C)opyright 2000-2009, by Object Refinery Limited and Contributors.