Hitachi

JP1 Version 12 JP1/Performance Management リファレンス


jpcrdef delete

〈このページの構成〉

形式

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

機能

jpcrdef deleteコマンドは,PFM - Managerに接続し,レポート定義を削除するコマンドです。レポート定義ディレクトリを指定すると下位のレポート定義およびレポート定義ディレクトリを含めて削除します。削除対象のレポート定義とレポート定義ディレクトリは,コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。1つのパラメーターファイルに,複数のレポート定義またはレポート定義ディレクトリを指定し,一括して削除できます。

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

PFM - Web Console

実行権限

Windowsの場合

Administrators権限を持つユーザー

UNIXの場合

rootユーザー権限を持つユーザー

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

注※

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

格納先ディレクトリ

Windowsの場合

インストール先フォルダ\tools\

UNIXの場合

/opt/jp1pcwebcon/tools/

引数

-y

このオプションを指定した場合は,削除確認メッセージを出力しません。省略した場合は,<report-definition>ごとに削除確認メッセージを出力します。削除確認メッセージに対して,「y」または「Y」で応答すると削除します。それ以外の値で応答すると,削除はしないで次の<report-definition>の削除確認メッセージを出力します。

-mx 最大ヒープサイズ

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

  • 1〜2,048の整数

  • 「-mxの指定値 >= -msの指定値」

-ms 初期ヒープサイズ

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

  • 1〜2,048の整数

  • 「-mxの指定値 >= -msの指定値」

入力ファイル

レポート定義を削除するためのXML形式のパラメーターファイルを指定します。このパラメーターファイルは,後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名,相対ファイルパス名,ファイル名が指定でき,絶対ファイルパス名以外の場合,カレントディレクトリを基点とします。

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

XMLタグ仕様

  • report-definitions

    種別

    説明

    意味

    レポート定義情報のルートタグ

    指定可能値

    なし

    省略

    不可

    属性

    なし

    親要素

    pr-cli-parameters

    子要素

    report-definition

  • report-definition

    種別

    説明

    意味

    1つのレポート定義を指定する。

    指定可能値

    なし

    省略

    不可

    属性

    name

    1〜64文字(バイトではない)の全角文字または半角文字でレポート定義名を指定する。レポート定義名に「\」か「/」を含む場合,それぞれ「\\」「\/」と記述する。全角と半角文字が混在できる。name属性を省略するとparent-folderに指定したレポート定義ディレクトリを下位層含めて削除する。レポート定義名の前後に半角空白を指定すると,前後の半角空白を除いた名称で登録される。

    parent-folder

    name属性のレポート定義があるディレクトリ名を指定する。1〜64文字(バイトではない)の全角文字または半角文字のディレクトリ名をルートディレクトリから「/」で区切って指定する。name属性を省略すると,レポート定義ディレクトリを下位層含めて削除します。全角と半角文字とは混在できる。パスの場合は,上位レベルのディレクトリ名から順に半角「/」で区切って指定する。ディレクトリ名に「\」か「/」を含む場合,それぞれ「\\」「\/」と記述する。ディレクトリ名の前後に半角空白を指定するとエラーになる。属性を省略するとエラーになる。

    例えば,ルートディレクトリ「User Reports」の配下にあるレポート定義名「PD define」のレポート定義をファイルに出力する場合,次のように指定する。

    <report-definition name="PD define" parent-folder="/"/>

    また,ルートディレクトリ「User Reports」配下のディレクトリ「Dir1」内のディレクトリ「Dir2」にある,すべてのレポート定義をファイルに出力する場合,次のように指定する。

    <report-definition parent-folder="/Dir1/Dir2"/>

    id

    指定しても無視される。

    read-only

    「TRUE」の場合は,レポート定義の削除を中断して,次のreport-definition要素を処理します。省略または「FALSE」の場合は,レポート定義を削除する。

    親要素

    report-definitions

    子要素

    product

    指定しても無視される。

    report-type

    record

    indication-settings

    view-type

    drilldown

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

パラメーターファイル記述例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rdef_delete_params.dtd">
<pr-cli-parameters ver="0100">
  <report-definitions>
   <report-definition name="Workload Status (Multi-Agent)"
             parent-folder="/"/>
   <report-definition name="daily report"
             parent-folder="/UserReport"
                 read-only="FALSE"/>
   <report-definition name="" parent-folder="/report1"/>
  </report-definitions>
</pr-cli-parameters>

注意事項

戻り値

0

正常終了した。

1

コマンドラインの形式が不正である。

2

コマンドの実行権限がない。

3

出力ファイルの作成に失敗した。

5

DTDファイルと不整合のためパラメーターが解析できない。

10

1件以上のレポート定義作成に失敗した。

11

PFM - Managerへの認証処理に失敗した。

12

監視二重化の場合に,セカンダリーのPFM - Managerに接続しているPFM - Web Consoleホストから実行しようとした。

100

環境が不正である。

200

メモリーエラーが発生した。

202

ファイルアクセスエラーが発生した。

222

通信処理でエラーが発生した。

255

予期しないエラーが発生した。

使用例1

パラメーターファイル(rdef_del.xml)に記述したレポート定義を削除する場合のコマンド実行例を次に示します。

jpcrdef  delete  -y  rdef_del.xml

使用例2

パラメーターファイル(rdef_del02.xml)に記述したレポート定義を確認しながら削除する場合のコマンド実行例を次に示します。

jpcrdef  delete  rdef_del02.xml

出力例

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

10のレポート定義と5つのレポート定義ディレクトリを指定し,3つのレポート定義がエラーとなった場合の標準出力形式を次に示します。

標準出力の出力例

jpcrdef delete connected to vserv01 at 2006 03 20 15:00:55.282
delete result OK  : レポート定義ディレクトリパス1/レポート定義名11
delete result OK  : レポート定義ディレクトリパス2/レポート定義名21
delete result ERR : レポート定義ディレクトリパス3
          Skipped : レポート定義ディレクトリパス3/レポート定義名31
エラー要因
              OK  : レポート定義ディレクトリパス3/レポート定義名32
          Skipped : レポート定義ディレクトリパス3/レポート定義名33
エラー要因
              OK  : レポート定義ディレクトリパス3/レポート定義名34
              OK  : レポート定義ディレクトリパス3/レポート定義名35
delete result ERR : レポート定義ディレクトリパス4/レポート定義名41
エラー要因
delete result OK  : レポート定義ディレクトリパス5
              OK  : レポート定義ディレクトリパス5/レポート定義名51
              OK  : レポート定義ディレクトリパス5/レポート定義名52
jpcrdef delete disconnected at 2006 03 20 15:01:06.2

上記例では,レポート定義ディレクトリパス3のレポート定義ディレクトリパス3/レポート定義名31およびレポート定義ディレクトリパス3/レポート定義名33が削除できなかったため,レポート定義ディレクトリパス3,レポート定義ディレクトリパス3/レポート定義名31,レポート定義ディレクトリパス3/レポート定義名33は残っていることを示します。レポート定義ディレクトリパス4/レポート定義名41も残っていることを示します。