8.4.4 jpcaspsv update

形式

jpcaspsv update      <入力ファイル>

機能

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

実行権限

Windowsの場合:
Administrators権限を持つユーザー
SolarisおよびLinuxの場合:
rootユーザー権限を持つユーザー

格納先ディレクトリ

Windowsの場合:
<Tuning Manager serverのインストール先フォルダ>¥PerformanceReporter¥tools¥
Solarisの場合:
/opt/HiCommand/TuningManager/PerformanceReporter/tools/
Linuxの場合:
<Tuning Manager serverのインストール先ディレクトリ>/PerformanceReporter/tools/

オプション

jpcaspsv updateコマンドのオプションを次の表に示します。

表8-30 jpcaspsv updateコマンドのオプション一覧

オプション目的必須/任意注記
<入力ファイル>Storeデータベースの保存条件定義情報を変更するための,XML形式のパラメーターファイルを指定します。このパラメーターファイルは,後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名,相対ファイルパス名,ファイル名を指定でき,絶対ファイルパス名以外の場合は,カレントディレクトリを基点とします。必須なし

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

XMLタグ仕様

表8-31 agent-store-db-preserve-definition

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

表8-32 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回だけ指定できます。省略できます)

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

表8-33 product-interval

種別説明
意味PIレコードの保存期間を指定します。
対象となるStoreデータベースの条件は次のどちらかになります。
  • バージョン08-00以前
  • バージョン08-10以降,かつStoreバージョンが1.0
Tuning Managerシリーズのエージェントの場合,「08-00以前」を「05-50以前」に,「08-10以降」を「05-70以降」に読み替えてください。
指定可能値なし
省略可(省略時は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回だけ指定できます。省略できます)

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

表8-34 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
子要素なし

表8-35 hour-drawer

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

表8-36 day-drawer

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

表8-37 week-drawer

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

表8-38 month-drawer

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

表8-39 product-detail

種別説明
意味PDレコードの保存レコード数を指定します。
対象となるStoreデータベースの条件は次のどちらかになります。
  • バージョン08-00以前
  • バージョン08-10以降,かつStoreバージョンが1.0
Tuning Managerシリーズのエージェントの場合,「08-00以前」を「05-50以前」に,「08-10以降」を「05-70以降」に読み替えてください。
指定可能値なし
省略可(省略時はproduct-detailを更新しません)
属性なし
親要素service
子要素detail-record(1PDレコードに1回だけ指定できます。省略できます)

表8-40 detail-record

種別説明
意味PDレコードの保存レコード数の上限を指定します。
指定可能値なし
省略可(省略時はdetail-recordを更新しません)
属性idPDレコードID(各PFM - AgentのマニュアルのレコードIDを参照してください。省略はできません)
max-rec0~2,147,483,647(省略できません)
親要素product-detail
子要素なし

表8-41 product-log

種別説明
意味PLレコードの保存レコード数の上限を指定します。
対象となるStoreデータベースの条件は次のどちらかになります。
  • バージョン08-00以前
  • バージョン08-10以降,かつStoreバージョンが1.0
Tuning Managerシリーズのエージェントの場合,「08-00以前」を「05-50以前」に,「08-10以降」を「05-70以降」に読み替えてください。
指定可能値なし
省略可(省略時はproduct-logを更新しません)
属性なし
親要素service
子要素log-record(1PLレコードに1回だけ指定できます。省略できます)

表8-42 log-record

種別説明
意味PLレコードの保存レコード数の上限を指定します。
指定可能値なし
省略可(省略時はlog-recordを更新しません)
属性idPLレコードID(各PFM - AgentのマニュアルのレコードIDを参照してください。省略できません)
max-rec0~2,147,483,647(省略できません)
親要素product-log
子要素なし

表8-43 ex-product-interval

種別説明
意味PIレコードの保存期間を指定します。
対象となるStoreデータベースの条件は,バージョン08-10以降,かつStoreバージョンが2.0です。
Tuning Managerシリーズのエージェントの場合,「08-10以降」を「05-70以降」に読み替えてください。
指定可能値なし
省略省略時はex-product-intervalを更新しません。
属性なし
親要素service
子要素ex-interval-record(1PIレコードに1回だけ指定できます。省略できます)

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

表8-44 ex-interval-record

種別説明
意味PIレコードの保存期間を指定します。
指定可能値なし
省略省略時はex-interval-recordを更新しません。
属性idPIレコード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回だけ指定できます。省略できます)

注※ 子要素を指定する場合は,上記の順序で指定します。

表8-45 minute-drawer-days

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

表8-46 hour-drawer-days

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

表8-47 day-drawer-weeks

種別説明
意味日単位のPIレコードの保存期間を指定します。
値は週の数で指定します。522週(10年相当)まで指定できます。
指定可能値なし
省略省略時はday-drawer-weeksを更新しません。
属性period0~522(省略できません)
親要素ex-interval-record
子要素なし

表8-48 week-drawer-weeks

種別説明
意味週単位のPIレコードの保存期間を指定します。
値は週の数で指定します。522週(10年相当)まで指定できます。
指定可能値なし
省略省略時はweek-drawer-weeksを更新しません。
属性period0~522(省略できません)
親要素ex-interval-record
子要素なし

表8-49 month-drawer-months

種別説明
意味月単位のPIレコードの保存期間を指定します。
値は月数で指定します。120か月(10年相当)まで指定できます。
指定可能値なし
省略省略時はmonth-drawer-monthsを更新しません。
属性period0~120(省略できません)
親要素ex-interval-record
子要素なし

表8-50 ex-product-detail

種別説明
意味PDレコードの保存期間を指定します。
対象となるStoreデータベースの条件は,バージョン08-10以降,かつStoreバージョンが2.0の場合です。
Tuning Managerシリーズのエージェントの場合,「08-10以降」を「05-70以降」に読み替えてください。
指定可能値なし
省略省略時はex-product-detailを更新しません。
属性なし
親要素service
子要素ex-detail-record(1PDレコードに1回だけ指定できます。省略できます)

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

表8-51 ex-detail-record

種別説明
意味PDレコードの保存期間を指定します。
値は日数で指定します。366日(1年相当)まで指定できます。
指定可能値なし
省略省略時はex-detail-recordを更新しません。
属性idPDレコードID
PDレコードIDについては,各PFM - Agentマニュアルのレコードについて説明している章を参照してください。idは省略できません。
period0~366(省略できません)
親要素ex-product-detail
子要素なし

表8-52 ex-product-log

種別説明
意味PLレコードの保存期間を指定します。
対象となるStoreデータベースの条件は,バージョン08-10以降,かつStoreバージョンが2.0の場合です。
Tuning Managerシリーズのエージェントの場合,「08-10以降」を「05-70以降」に読み替えてください。
指定可能値なし
省略省略時はex-product-logを更新しません。
属性なし
親要素service
子要素ex-log-record(1PLレコードに1回だけ指定できます。省略できます)

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

表8-53 ex-log-record

種別説明
意味PLレコードの保存期間を指定します。
値は日数で指定します。366日(1年相当)まで指定できます。
指定可能値なし
省略省略時はex-log-recordを更新しません。
属性idPLレコードID
PLレコードIDについては,各PFM - Agentマニュアルのレコードについて説明している章を参照してください。idは省略できません。
period0~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"/>
           </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"/>
           </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コマンドを実行したOSユーザーに実行権限がありません。
3出力ファイルの作成に失敗しました。
5DTDファイルと不整合のためパラメーターを解析できません。
101件以上のStoreデータベース定義の更新に失敗しました。
100環境が不正です。
200メモリーエラーが発生しました。
202ファイルアクセスエラーが発生しました。
222通信処理でエラーが発生しました。
255予期しないエラーが発生しました。

使用例

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

jpcaspsv  update  aspsv_update.xml

出力例

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

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