PFM - Web Consoleで実行するコマンドに関する注意事項

コマンド実行の前提条件

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

• コマンドに指定するパラメーターファイルの作成

  パラメーターファイルを引数として指定するコマンドを実行する場合，指定するパラメーターファイルを事前に作成する必要があります。

  パラメーターファイルの記述方式は，「コマンドの入力方式」を参照してください。また，パラメーターファイルに指定するパラメーターについては，各コマンドの，パラメーターファイルの形式についての説明を参照してください。

• config.xml^※ファイルに設定する<logging>，<vsa>タグの確認

  config.xml^※に<logging>，<vsa>タグが設定されているか確認してください。必須項目です。設定されていない場合は，config.xml^※のファイル例を参考に記述してください。

• PFM - Managerの稼働状況の確認

  コマンド実行時にPFM - Managerが稼働している必要があります。

• PFM - AgentまたはPFM - RMの稼働状況の確認

  Storeデータベースに関するコマンドおよびレポート結果出力コマンドを実行する場合は，対応するPFM - AgentまたはPFM - RMが稼働している必要があります。

• コマンドの実行権限

  コマンドを実行する場合，OSユーザーにAdministrators権限が必要となります。

• 認証用のキーファイルの作成

  コマンドを実行する前に，あらかじめPFM - Managerに対する認証用のキーファイルを作成する必要があります。認証用のキーファイルはjpcmkkeyコマンドで作成します。

注※

config.xmlのファイル例については，「初期設定ファイル（config.xml）」を参照してください。

ページの先頭へ

コマンドの入力方式

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

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

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

• パラメーターファイルはXML形式で作成します。

• パラメーターは，XMLバージョンとエンコーディングを指定した直後に，<pr-cli-parameters>タグで囲んで指定します。

  指定するパラメーターは，各コマンドのパラメーターの形式を参照してください。

• 「<」などXML形式の書式制御文字を値に含める場合，XML仕様が定める記法に従って記述する必要があります。

  例えば，「<」の場合は「&lt;」，「>」の場合は「&gt;」と記述します。

• フィールドID，レコードID，date-range，report-intervalなど，コマンドのパラメーターファイル仕様で規定する固定のトークンから選択して指定する値は，仕様として明示的に制限されないかぎり，大文字だけ，または小文字だけであれば使用できます。パラメーターに指定する値の定義は，各コマンドの，パラメーターファイルの形式またはDTDファイルについての説明を参照してください。

• 「TRUE」を指定できるパラメーターについては，「true」も指定できます。また，「FALSE」を指定できるパラメーターについては，「false」も指定できます。

• 空白だけの要素値または属性値については，省略と見なします。また，要素値，属性値の前後に指定した半角空白は，無視します。

• 印字文字以外の文字を要素または属性に指定するとエラーとなります。

• パラメーターファイルのDOCTYPE宣言は固定です。パラメーターファイルのDOCTYPE宣言には，パラメーターの記述を定義するDTDファイル名を必ず指定してください。DOCTYPE宣言の例を次に示します。

  <!DOCTYPE pr-cli-parameters SYSTEM "DTDファイル名">

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

• parent-folder属性に「/」を指定すると，ルートディレクトリを指定できます。ルート以下のディレクトリ「Directory1」を指定する場合は，「/Directory1」と指定します。同様に，「Directory1」以下のディレクトリを指定する場合は，「/Directory1/Directory2...」のようにディレクトリ名を「/」で連結したディレクトリパスを指定します。ルートディレクトリ「/」に「User Reports」または「System Reports」を指定するとエラーになります。

• 「パラメーターファイルの形式」で指定する範囲外の値を指定した場合は，パラメーターファイルエラーとなります。

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

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

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

ページの先頭へ

コマンドの出力方式

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

ページの先頭へ

標準出力例

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

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

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

jpcrdef   -h

Usage: jpcrdef <subcmd> [ <option>... ] {<parameter file>|<parameter option>... }
    <subcmd> 必須。次の中から一つを指定します。
        create          レポート定義を作成します。
        delete          レポート定義を削除します。
        output          レポート定義を出力します。
    <option> オプション情報を次の中から指定します。
        -o <outputfile> <subcmd>が'output'の時に，
                        出力先ファイル名称を指定します。
                        <subcmd>が'output'の時に必須です。
        -mx             プログラムの最大ヒープサイズを，
                        1〜2048の数値で指定します（単位MB）。
                        例: '-mx 128'。 省略時は128MBです。
        -ms             プログラムの最小ヒープサイズを，
                        1〜2048の数値で指定します（単位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>    <subcmd>が'create'，'delete'，'output'の時に
                        パラメーターファイル名を指定します。
                        <subcmd>が'create'，'delete'の時は必須です。
    <parameter option>  <subcmd>が'output'の時に指定できます。
        -parent <parent directory>
                        出力するレポート定義へのディレクトリパスを
                        指定します。
                        <parameter option>を指定する時に必須です。
        -name <report name>
                        出力するレポート定義名を指定します。
                        省略した場合，<parent directory>で指定した
                        ディレクトリに含まれる全てのレポート定義を
                        下位層を含めて１つのファイルに出力します。

ページの先頭へ

コマンドの同時実行

次のコマンド（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のユーザー権限を，次の表に示します。

注※

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

ページの先頭へ