jpcaspsv update

〈このページの構成〉

形式
機能
コマンドを実行できるホスト
実行権限
格納先ディレクトリ
引数
パラメーターファイルの形式
注意事項
戻り値
使用例
出力例

形式

jpcaspsv update     [-mx 最大ヒープサイズ]
                    [-ms 初期ヒープサイズ]
                    入力ファイル

ページの先頭へ

機能

jpcaspsv updateコマンドは，エージェントに接続しStoreデータベースの保存条件に関する定義情報を変更するコマンドです。変更する保存条件定義情報は，コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。

ページの先頭へ

コマンドを実行できるホスト

PFM - Web Console

ページの先頭へ

実行権限

Windowsの場合: Administrators権限を持つユーザー
UNIXの場合: rootユーザー権限を持つユーザー

また，コマンドを実行するためには，事前にPerformance Managementに対する管理ユーザー権限^※のユーザーアカウントで認証用のキーファイルを作成する必要があります。詳細については，「jpcmkkey」コマンドを参照してください。

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

ページの先頭へ

格納先ディレクトリ

Windowsの場合: インストール先フォルダ\tools\
UNIXの場合: /opt/jp1pcwebcon/tools/

ページの先頭へ

引数

-mx 最大ヒープサイズ

java.exeの最大ヒープサイズをメガバイト単位で指定します。デフォルトは，128メガバイトです。実際に取得できる最大サイズは，システムに依存します。指定する値が次の条件を満たさない場合は，コマンドライン形式不正となります。指定値の条件を次に示します。

1〜2,048の整数
「-mxの指定値 >= -msの指定値」

-ms 初期ヒープサイズ

java.exeの初期ヒープサイズをメガバイト単位で指定します。デフォルトは，32メガバイトです。指定する値が次の条件を満たさない場合は，コマンドライン形式不正となります。指定値の条件を次に示します。

1〜2,048の整数
「-mxの指定値 >= -msの指定値」

入力ファイル

Storeデータベースの保存条件定義情報を変更するための，XML形式のパラメーターファイルを指定します。このパラメーターファイルは，後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名，相対ファイルパス名，ファイル名を指定でき，絶対ファイルパス名以外の場合は，カレントディレクトリを基点とします。

ページの先頭へ

パラメーターファイルの形式

XMLタグ仕様

agent-store-db-preserve-definition

種別	説明
意味	Storeデータベース保存条件定義情報のルートタグ
指定可能値	なし
省略	不可
属性	なし
親要素	pr-cli-parameters
子要素	service（複数指定できる）

service

種別	説明
意味	エージェントを特定するサービスを指定する。
指定可能値	なし
省略	不可
属性	id	サービスID（4〜258文字） 1桁目はエージェントのプロダクトIDを指定する。プロダクトIDについては，各PFM - AgentまたはPFM - RMマニュアルを参照。 2桁目は「S」（Agent StoreまたはRemote Monitor Store）を指定する。
親要素	agent-store-db-preserve-definition
子要素^※	product-interval（1serviceに1回だけ指定できる。省略できる）
	product-detail（1serviceに1回だけ指定できる。省略できる）
	product-log（1serviceに1回だけ指定できる。省略できる）
	ex-product-interval（1serviceに1回だけ指定できる。省略できる）
	ex-product-detail（1serviceに1回だけ指定できる。省略できる）
	ex-product-log（1serviceに1回だけ指定できる。省略できる）

注※　子要素を指定する場合は，記載順に指定します。

product-interval

種別	説明
意味	PIレコードの保存期間を指定する。対象となるStoreデータベースの条件は次のどちらか。バージョン08-00以前バージョン08-10以降，かつStoreバージョンが1.0
指定可能値	なし
省略	可（省略時はproduct-intervalを更新しない）
属性	なし
親要素	service
子要素^※	minute-drawer（1product-intervalに1回だけ指定できる。省略できる）
	hour-drawer（1product-intervalに1回だけ指定できる。省略できる）
	day-drawer（1product-intervalに1回だけ指定できる。省略できる）
	week-drawer（1product-intervalに1回だけ指定できる。省略できる）
	month-drawer（1product-intervalに1回だけ指定できる。省略できる）

注※　子要素を指定する場合は，記載順に指定します。

minute-drawer

種別	説明
意味	分単位のPIレコードの保存期間を指定する。
指定可能値	半角英数字で指定する。大文字，小文字の区別はしない。次に示す値が指定できる。「minute」：1分「hour」：1時間「day」：1日「n days」：n日（ただし，nは2〜6）「week」：1週間「month」：1か月「year」：1年
省略	可（省略時はminute-drawerを更新しない）
属性	なし
親要素	product-interval
子要素	なし

hour-drawer

種別	説明
意味	時間単位のPIレコードの保存期間を指定する。
指定可能値	半角英数字で指定する。大文字，小文字の区別はしない。次に示す値が指定できる。「hour」：1時間「day」：1日「n days」：n日（ただし，nは2〜6）「week」：1週間「month」：1か月「year」：1年
省略	可（省略時はhour-drawerを更新しない）
属性	なし
親要素	product-interval
子要素	なし

day-drawer

種別	説明
意味	日単位のPIレコードの保存期間を指定する。
指定可能値	半角英数字で指定する。大文字，小文字の区別はしない。次に示す値が指定できる。「day」：1日「n days」：n日（ただし，nは2〜6）「week」：1週間「month」：1か月「year」：1年
省略	可（省略時はday-drawerを更新しない）
属性	なし
親要素	product-interval
子要素	なし

week-drawer

種別	説明
意味	週単位のPIレコードの保存期間を指定する。
指定可能値	半角英数字で指定する。大文字，小文字の区別はしない。次に示す値が指定できる。「week」：1週間「month」：1か月「year」：1年
省略	可（省略時はweek-drawerを更新しない）
属性	なし
親要素	product-interval
子要素	なし

month-drawer

種別	説明
意味	月単位のPIレコードの保存期間を指定する。
指定可能値	半角英数字で指定する。大文字，小文字の区別はしない。次に示す値が指定できる。「month」：1か月「year」：1年
省略	可（省略時はmonth-drawerを更新しない）
属性	なし
親要素	product-interval
子要素	なし

product-detail

種別	説明
意味	PDレコードの保存レコード数を指定する。対象となるStoreデータベースの条件は次のどちらか。バージョン08-00以前バージョン08-10以降，かつStoreバージョンが1.0
指定可能値	なし
省略	可（省略時はproduct-detailを更新しない）
属性	なし
親要素	service
子要素	detail-record（1PDレコードに1回だけ指定できる。省略できる）

detail-record

種別	説明
意味	PDレコードの保存レコード数の上限を指定する。
指定可能値	なし
省略	可（省略時はdetail-recordを更新しない）
属性	id	PDレコードID（各PFM - AgentまたはPFM - RMマニュアルのレコードIDを参照。省略はできない）
属性	max-rec	0〜2147483647（省略できない）
親要素	product-detail
子要素	なし

product-log

種別	説明
意味	PLレコードの保存レコード数の上限を指定する。対象となるStoreデータベースの条件は次のどちらかになります。バージョン08-00以前バージョン08-10以降，かつStoreバージョンが1.0
指定可能値	なし
省略	可（省略時はproduct-logを更新しない）
属性	なし
親要素	service
子要素	log-record（1PLレコードに1回だけ指定できる。省略できる）

log-record

種別	説明
意味	PLレコードの保存レコード数の上限を指定する。
指定可能値	なし
省略	可（省略時はlog-recordを更新しない）
属性	id	PLレコードID（各PFM - AgentまたはPFM - RMマニュアルのレコードIDを参照。省略できない）
属性	max-rec	0〜2147483647（省略できない）
親要素	product-log
子要素	なし

ex-product-interval

種別	説明
意味	PIレコードの保存期間を指定する。対象となるStoreデータベースの条件は次のとおり。バージョン08-10以降，かつStoreバージョンが2.0
指定可能値	なし
省略	可（省略時はex-product-intervalを更新しない）
属性	なし
親要素	service
子要素	ex-interval-record（1PIレコードに1回だけ指定できる。省略できる）

注　このタグを指定する場合は，pr-cli-parameters のver属性を「0110」以降にしてください。

ex-interval-record

種別	説明
意味	PIレコードの保存期間を指定する。
指定可能値	なし
省略	可（省略時はex-interval-recordを更新しない）
属性	id	PIレコードID PIレコードIDについては，各PFM - AgentまたはPFM - RMマニュアルを参照。 idは省略できない。
親要素	ex-product-interval
子要素^※	minute-drawer-days（1ex-interval-recordに1回だけ指定できる。省略できる）
	hour-drawer-days（1ex-interval-recordに1回だけ指定できる。省略できる）
	day-drawer-weeks（1ex-interval-recordに1回だけ指定できる。省略できる）
	week-drawer-weeks（1ex-interval-recordに1回だけ指定できる。省略できる）
	month-drawer-months（1ex-interval-recordに1回だけ指定できる。省略できる）

注※　子要素を指定する場合は，記載順に指定します。

minute-drawer-days

種別	説明
意味	分単位のPIレコードの保存期間を指定する。値は日数で指定する。366日（1年相当）まで指定できる。
指定可能値	なし
省略	可（省略時はminute-drawer-daysを更新しない）
属性	period	0〜366（省略できない）
親要素	ex-interval-record
子要素	なし

hour-drawer-days

種別	説明
意味	時間単位のPIレコードの保存期間を指定する。値は日数で指定する。366日（1年相当）まで指定できる。
指定可能値	なし
省略	可（省略時はhour-drawer-daysを更新しない）
属性	period	0〜366（省略できない）
親要素	ex-interval-record
子要素	なし

day-drawer-weeks

種別	説明
意味	日単位のPIレコードの保存期間を指定する。値は週の数で指定する。522週（10年相当）まで指定できる。
指定可能値	なし
省略	可（省略時はday-drawer-weeksを更新しない）
属性	period	0〜522（省略できない）
親要素	ex-product-interval
子要素	なし

week-drawer-weeks

種別	説明
意味	日単位のPIレコードの保存期間を指定する。値は週の数で指定する。522週（10年相当）まで指定できる。
指定可能値	なし
省略	可（省略時はweek-drawer-weeksを更新しない）
属性	period	0〜522（省略できない）
親要素	ex-product-interval
子要素	なし

month-drawer-months

種別	説明
意味	月単位のPIレコードの保存期間を指定する。値は月数で指定する。120か月（10年相当）まで指定できる。
指定可能値	なし
省略	可（省略時はmonth-drawer-monthsを更新しない）
属性	period	0〜120（省略できない）
親要素	ex-product-interval
子要素	なし

ex-product-detail

種別	説明
意味	PDレコードの保存期間を指定する。対象となるStoreデータベースの条件は次のとおり。バージョン08-10以降，かつStoreバージョンが2.0
指定可能値	なし
省略	可（省略時はex-product-detailを更新しない）
属性	なし
親要素	service
子要素	ex-detail-record（1PDレコードに1回だけ指定できる。省略できる）

注　このタグを指定する場合は，pr-cli-parameters のver属性を「0110」以降にしてください。

ex-detail-record

種別	説明
意味	PDレコードの保存期間を指定する。値は日数で指定する。366日（1年相当）まで指定できる。
指定可能値	なし
省略	可（省略時はex-detail-recordを更新しない）
属性	id	PDレコードID（各PFM - AgentまたはPFM - RMマニュアルのレコードIDを参照。省略できない）
属性	period	0〜366（省略できない）
親要素	ex-product-detail
子要素	なし

ex-product-log

種別	説明
意味	PLレコードの保存期間を指定する。対象となるStoreデータベースの条件は次のとおり。バージョン08-10以降，かつStoreバージョンが2.0
指定可能値	なし
省略	可（省略時はex-product-logを更新しない）
属性	なし
親要素	service
子要素	ex-log-record（1PLレコードに1回だけ指定できる。省略できる）

ex-log-record

種別	説明
意味	PLレコードの保存期間を指定する。値は日数で指定する。366日（1年相当）まで指定できる。
指定可能値	なし
省略	可（省略時はex-log-recordを更新しない）
属性	id	PLレコードID（各PFM - AgentまたはPFM - RMマニュアルのレコードIDを参照。省略できない）
属性	period	0〜366（省略できない）
親要素	ex-product-log
子要素	なし

パラメーターファイルの記述例を次に示します。

パラメーターファイル記述例（Storeバージョンが1.0の場合）

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "aspsv_params.dtd">
<pr-cli-parameters ver="0110">
<agent-store-db-preserve-definition>
    <service id="TS1host1">
        <product-interval>
            <minute-drawer>day</minute-drawer>
            <hour-drawer>day</hour-drawer>
            <day-drawer>week</day-drawer>
            <week-drawer>month</week-drawer>
            <month-drawer>year</month-drawer>
            <!-- year-drawer : Year -->
        </product-interval>
        <product-detail>
            <detail-record id="PD" max-rec="30000"/>
            <detail-record id="PD_THRD" max-rec="30000"/>
            <detail-record id="PD_ADRS" max-rec="30000"/>
            <detail-record id="PD_PDI" max-rec="30000"/>
            <detail-record id="PD_PEND" max-rec="30000"/>
        </product-detail>
        <product-log>
            <log-record id="PL" max-rec="30000"/>
            <log-record id="RM" max-rec="30000"/>
        </product-log>
    </service>
</agent-store-db-preserve-definition>
</pr-cli-parameters>

パラメーターファイル記述例（Storeバージョンが2.0の場合）

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "aspsv_params.dtd">
<pr-cli-parameters ver="0110">
<agent-store-db-preserve-definition>
    <service id="TS1host1">
        <ex-product-interval>
            <ex-interval-record id="PI">
                <minute-drawer-days period="10"/>
                <hour-drawer-days period="10"/>
                <day-drawer-weeks period="10"/>
                <week-drawer-weeks period="10"/>
                <month-drawer-months period="10"/>
                <!-- year-drawer-years period="10" -->
            </ex-interval-record>
            <ex-interval-record id="PI_LOGD">
                <minute-drawer-days period="10"/>
                <hour-drawer-days period="10"/>
                <day-drawer-weeks period="10"/>
                <week-drawer-weeks period="10"/>
                <month-drawer-months period="10"/>
                <!-- year-drawer-years period="10" -->
            </ex-interval-record>
        </ex-product-interval>
        <ex-product-detail>
            <ex-detail-record id="PD" period="10"/>
            <ex-detail-record id="PD_THRD" period="10"/>
            <ex-detail-record id="PD_ADRS" period="10"/>
            <ex-detail-record id="PD_PDI" period="10"/>
            <ex-detail-record id="PD_PEND" period="10"/>
        </ex-product-detail>
        <ex-product-log>
            <ex-log-record id="PL" period="10"/>
            <ex-log-record id="RM" period="10"/>
        </ex-product-log>
    </service>
</agent-store-db-preserve-definition>
</pr-cli-parameters>

ページの先頭へ

注意事項

このコマンドは，実行時にPFM - Managerに対する認証が必要です。認証用のキーファイルを作成していない場合は，コマンドを実行する前に，jpcmkkeyコマンドで認証用のキーファイルを作成してください。各タグの指定値は，各PFM - AgentまたはPFM - RMマニュアルの「パフォーマンスデータの収集の設定」に関する注意に従って設定してください。
指定できるサービスID，レコードIDについては，各PFM - AgentまたはPFM - RMマニュアルを参照してください。
指定したサービスIDが，エージェントのプロダクト以外の場合はエラーとします。
同一サービスIDを複数回指定した場合，エラーとします。
同一レコードIDを複数回指定した場合，エラーとします。
複数のStoreデータベース保存条件定義を連続登録中に，どれかの定義登録が失敗した場合，コマンドはその定義の登録を中断し，ほかの定義があればそれを登録します。
minute-drawer〜month-drawerの各保存期間の指定は，それぞれの単位の保存期間であって，相互の関連はありません。
ex-product-intervalタグ，ex-product-detailタグ，およびex-product-logタグは，Storeバージョンが1.0のときに指定しても無視されます。また，product-intervalタグ，product-detailタグ，およびproduct-logタグは，Storeバージョンが2.0のときに指定しても無視されます。
通常，-mxオプションおよび-msオプションを設定する必要はありません。コマンド実行時に，メモリー不足を示すKAVJK0401-Eメッセージが出力された場合は，-mxオプションの最大ヒープサイズに64以上を指定して，再度実行してください。

ページの先頭へ

戻り値

0	正常終了した。
1	コマンドラインの形式が不正である。
2	コマンドの実行権限がない。
3	出力ファイルの作成に失敗した。
5	DTDファイルと不整合のためパラメーターが解析できない。
10	1件以上のStoreデータベース定義の更新に失敗した。
11	PFM - Managerへの認証処理に失敗した。または，認証時に指定したユーザーに実行権限がない。
100	環境が不正である。
200	メモリーエラーが発生した。
202	ファイルアクセスエラーが発生した。
222	通信処理でエラーが発生した。
255	予期しないエラーが発生した。

ページの先頭へ

使用例

Storeデータベースの保存条件に関する定義情報を記述したパラメーターファイル（aspsv_update.xml）を指定する場合のコマンド実行例を次に示します。

jpcaspsv  update  aspsv_update.xml

ページの先頭へ

出力例

コマンド処理の詳細情報を標準出力，標準エラー出力，トレースログファイルに出力します。ログ仕様については「4.　Performance Managementで出力するログ情報」を参照してください。

3つのサービスIDを指定し，1つがエラーとなった場合の標準出力形式を次に示します。serviceタグで指定したサービスIDごとに実行結果を表示します（OKまたはERR）。

標準出力の出力例

jpcaspsv update connected to hostname at yyyy MM dd HH:MM:SS.mmm
update result  OK  : TS1host1
update result  OK  : TS1host2
update result  ERR : TS1host3
jpcaspsv update disconnected at yyyy MM dd HH:MM:SS.mmm

ページの先頭へ