形式
jpcaspsv update [-mx 最大ヒープサイズ]
[-ms 初期ヒープサイズ]
入力ファイル
機能
jpcaspsv updateコマンドは,エージェントに接続しStoreデータベースの保存条件に関する定義情報を変更するコマンドです。変更する保存条件定義情報は,コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。
コマンドを実行できるホスト
PFM - Web Console
実行権限
格納先ディレクトリ
引数
-mx 最大ヒープサイズ
java.exeの最大ヒープサイズをMB単位で指定します。デフォルトは,64MBです。実際に取得できる最大サイズは,システムに依存します。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
-ms 初期ヒープサイズ
java.exeの初期ヒープサイズをMB単位で指定します。デフォルトは,32MBです。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
入力ファイル
Storeデータベースの保存条件定義情報を変更するための,XML形式のパラメーターファイルを指定します。このパラメーターファイルは,後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名,相対ファイルパス名,ファイル名を指定でき,絶対ファイルパス名以外の場合は,カレントディレクトリを基点とします。
パラメーターファイルの形式
XMLタグ仕様
種別 | 説明 |
---|---|
意味 | Storeデータベース保存条件定義情報のルートタグ |
指定可能値 | なし |
省略 | 不可 |
属性 | なし |
親要素 | pr-cli-parameters |
子要素 | service(複数指定できます。) |
種別 | 説明 | |
---|---|---|
意味 | エージェントを特定するサービスを指定します。 | |
指定可能値 | なし | |
省略 | 不可 | |
属性 | id | サービスID(4~258文字) 1けた目はエージェントのプロダクトIDを指定します。プロダクトIDについては,各PFM - Agentマニュアルを参照してください。 2けた目は「S」(Agent 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回だけ指定できます。省略できます。) |
注※ 子要素を指定する場合は,記載順に指定します。
種別 | 説明 |
---|---|
意味 | PIレコードの保存期間を指定します。 対象となるStoreデータベースの条件は次のどちらかになります。
|
指定可能値 | なし |
省略 | 可(省略時は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回だけ指定できます。省略できます。) |
注※ 子要素を指定する場合は,記載順に指定します。
種別 | 説明 |
---|---|
意味 | 分単位のPIレコードの保存期間を指定します。 |
指定可能値 | 半角英数字で指定します。大文字,小文字の区別はしません。 次に示す値が指定できます。
|
省略 | 可(省略時はminute-drawerを更新しません。) |
属性 | なし |
親要素 | product-interval |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | 時間単位のPIレコードの保存期間を指定します。 |
指定可能値 | 半角英数字で指定します。大文字,小文字の区別はしません。 次に示す値が指定できます。
|
省略 | 可(省略時はhour-drawerを更新しません。) |
属性 | なし |
親要素 | product-interval |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | 日単位のPIレコードの保存期間を指定します。 |
指定可能値 | 半角英数字で指定します。大文字,小文字の区別はしません。 次に示す値が指定できます。
|
省略 | 可(省略時はday-drawerを更新しません。) |
属性 | なし |
親要素 | product-interval |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | 週単位のPIレコードの保存期間を指定します。 |
指定可能値 | 半角英数字で指定します。大文字,小文字の区別はしません。 次に示す値が指定できます。
|
省略 | 可(省略時はweek-drawerを更新しません。) |
属性 | なし |
親要素 | product-interval |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | 月単位のPIレコードの保存期間を指定します。 |
指定可能値 | 半角英数字で指定します。大文字,小文字の区別はしません。 次に示す値が指定できます。
|
省略 | 可(省略時はmonth-drawerを更新しません。) |
属性 | なし |
親要素 | product-interval |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | PDレコードの保存レコード数を指定します。 対象となるStoreデータベースの条件は次のどちらかになります。
|
指定可能値 | なし |
省略 | 可(省略時はproduct-detailを更新しません。) |
属性 | なし |
親要素 | service |
子要素 | detail-record(1PDレコードに1回だけ指定できます。省略できます。) |
種別 | 説明 | |
---|---|---|
意味 | PDレコードの保存レコード数の上限を指定します。 | |
指定可能値 | なし | |
省略 | 可(省略時はdetail-recordを更新しません。) | |
属性 | id | PDレコードID(各PFM - AgentのマニュアルのレコードIDを参照してください。省略はできません。) |
max-rec | 0~2147483647(省略できません。) | |
親要素 | product-detail | |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | PLレコードの保存レコード数の上限を指定します。 対象となるStoreデータベースの条件は次のどちらかになります。
|
指定可能値 | なし |
省略 | 可(省略時はproduct-logを更新しません。) |
属性 | なし |
親要素 | service |
子要素 | log-record(1PLレコードに1回だけ指定できます。省略できます。) |
種別 | 説明 | |
---|---|---|
意味 | PLレコードの保存レコード数の上限を指定します。 | |
指定可能値 | なし | |
省略 | 可(省略時はlog-recordを更新しません。) | |
属性 | id | PLレコードID(各PFM - AgentのマニュアルのレコードIDを参照してください。省略できません。) |
max-rec | 0~2147483647(省略できません。) | |
親要素 | product-log | |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | PIレコードの保存期間を指定します。 対象となるStoreデータベースの条件は次のとおりです。
|
指定可能値 | なし |
省略 | 可(省略時はex-product-intervalを更新しません。) |
属性 | なし |
親要素 | service |
子要素 | ex-interval-record(1PIレコードに1回だけ指定できます。省略できます。) |
注 このタグを指定する場合は,pr-cli-parameters のver属性を「0110」以降にしてください。
種別 | 説明 | |
---|---|---|
意味 | PIレコードの保存期間を指定します。 | |
指定可能値 | なし | |
省略 | 可(省略時はex-interval-recordを更新しません。) | |
属性 | id | PIレコードID PIレコードIDについては,各PFM - Agentマニュアルを参照してください。 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回だけ指定できます。省略できます。) |
注※ 子要素を指定する場合は,記載順に指定します。
種別 | 説明 | |
---|---|---|
意味 | 分単位のPIレコードの保存期間を指定します。 値は日数で指定します。366日(1年相当)まで指定できます。 | |
指定可能値 | なし | |
省略 | 可(省略時はminute-drawer-daysを更新しません。) | |
属性 | period | 0~366(省略できません。) |
親要素 | ex-interval-record | |
子要素 | なし |
種別 | 説明 | |
---|---|---|
意味 | 時間単位のPIレコードの保存期間を指定します。 値は日数で指定します。366日(1年相当)まで指定できます。 | |
指定可能値 | なし | |
省略 | 可(省略時はhour-drawer-daysを更新しません。) | |
属性 | period | 0~366(省略できません。) |
親要素 | ex-interval-record | |
子要素 | なし |
種別 | 説明 | |
---|---|---|
意味 | 日単位のPIレコードの保存期間を指定します。 値は週の数で指定します。522週(10年相当)まで指定できます。 | |
指定可能値 | なし | |
省略 | 可(省略時はday-drawer-weeksを更新しません。) | |
属性 | period | 0~522(省略できません。) |
親要素 | ex-product-interval | |
子要素 | なし |
種別 | 説明 | |
---|---|---|
意味 | 日単位のPIレコードの保存期間を指定します。 値は週の数で指定します。522週(10年相当)まで指定できます。 | |
指定可能値 | なし | |
省略 | 可(省略時はweek-drawer-weeksを更新しません。) | |
属性 | period | 0~522(省略できません。) |
親要素 | ex-product-interval | |
子要素 | なし |
種別 | 説明 | |
---|---|---|
意味 | 月単位のPIレコードの保存期間を指定します。 値は月数で指定します。120か月(10年相当)まで指定できます。 | |
指定可能値 | なし | |
省略 | 可(省略時はmonth-drawer-monthsを更新しません。) | |
属性 | period | 0~120(省略できません。) |
親要素 | ex-product-interval | |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | PDレコードの保存期間を指定します。 対象となるStoreデータベースの条件は次のとおりです。
|
指定可能値 | なし |
省略 | 可(省略時はex-product-detailを更新しません。) |
属性 | なし |
親要素 | service |
子要素 | ex-detail-record(1PDレコードに1回だけ指定できます。省略できます。) |
注 このタグを指定する場合は,pr-cli-parameters のver属性を「0110」以降にしてください。
種別 | 説明 | |
---|---|---|
意味 | PDレコードの保存期間を指定します。 値は日数で指定します。366日(1年相当)まで指定できます。 | |
指定可能値 | なし | |
省略 | 可(省略時はex-detail-recordを更新しません。) | |
属性 | id | PDレコードID(各PFM - AgentのマニュアルのレコードIDを参照してください。省略できません。) |
period | 0~366(省略できません。) | |
親要素 | ex-product-detail | |
子要素 | なし |
種別 | 説明 |
---|---|
意味 | PLレコードの保存期間を指定します。 対象となるStoreデータベースの条件は次のとおりです。
|
指定可能値 | なし |
省略 | 可(省略時はex-product-logを更新しません。) |
属性 | なし |
親要素 | service |
子要素 | ex-log-record(1PLレコードに1回だけ指定できます。省略できます。) |
種別 | 説明 | |
---|---|---|
意味 | PLレコードの保存期間を指定します。 値は日数で指定します。366日(1年相当)まで指定できます。 | |
指定可能値 | なし | |
省略 | 可(省略時はex-log-recordを更新しません。) | |
属性 | id | PLレコードID(各PFM - Agentのマニュアルのレコード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>
パラメーターの記述を定義するDTDファイルを次に示します。
パラメーターの記述を定義するDTDファイル
<!ELEMENT pr-cli-parameters (agent-store-db-preserve-definition)>
<!ATTLIST pr-cli-parameters ver (0100|0110) #REQUIRED>
<!ELEMENT agent-store-db-preserve-definition (service+)>
<!ELEMENT service (product-interval?, product-detail?,
product-log?, ex-product-interval?,
ex-product-detail?, ex-product-log?)>
<!ATTLIST service id CDATA #REQUIRED>
<!ELEMENT product-interval (minute-drawer?, hour-drawer?, day-drawer?,
week-drawer?, month-drawer?)>
<!ELEMENT minute-drawer (#PCDATA)>
<!ELEMENT hour-drawer (#PCDATA)>
<!ELEMENT day-drawer (#PCDATA)>
<!ELEMENT week-drawer (#PCDATA)>
<!ELEMENT month-drawer (#PCDATA)>
<!ELEMENT product-detail (detail-record*)>
<!ELEMENT detail-record EMPTY>
<!ATTLIST detail-record id CDATA #REQUIRED>
<!ATTLIST detail-record max-rec CDATA #REQUIRED>
<!ELEMENT product-log (log-record*)>
<!ELEMENT log-record EMPTY>
<!ATTLIST log-record id CDATA #REQUIRED>
<!ATTLIST log-record max-rec CDATA #REQUIRED>
<!ELEMENT ex-product-interval (ex-interval-record*)>
<!ELEMENT ex-interval-record (minute-drawer-days?, hour-drawer-days?,
day-drawer-weeks?, week-drawer-weeks?,
month-drawer-months?)>
<!ATTLIST ex-interval-record id CDATA #REQUIRED>
<!ELEMENT minute-drawer-days EMPTY>
<!ATTLIST minute-drawer-days period CDATA #REQUIRED>
<!ELEMENT hour-drawer-days EMPTY>
<!ATTLIST hour-drawer-days period CDATA #REQUIRED>
<!ELEMENT day-drawer-weeks EMPTY>
<!ATTLIST day-drawer-weeks period CDATA #REQUIRED>
<!ELEMENT week-drawer-weeks EMPTY>
<!ATTLIST week-drawer-weeks period CDATA #REQUIRED>
<!ELEMENT month-drawer-months EMPTY>
<!ATTLIST month-drawer-months period CDATA #REQUIRED>
<!ELEMENT ex-product-detail (ex-detail-record*)>
<!ELEMENT ex-detail-record EMPTY>
<!ATTLIST ex-detail-record id CDATA #REQUIRED>
<!ATTLIST ex-detail-record period CDATA #REQUIRED>
<!ELEMENT ex-product-log (ex-log-record*)>
<!ELEMENT ex-log-record EMPTY>
<!ATTLIST ex-log-record id CDATA #REQUIRED>
<!ATTLIST ex-log-record period CDATA #REQUIRED>
注意事項
戻り値
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
出力例
コマンド処理の詳細情報を標準出力,標準エラー出力,トレースログファイルに出力します。ログ仕様については「3. ログ情報」を参照してください。
三つのサービスIDを指定し,一つがエラーとなった場合の標準出力形式を次に示します。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