8.3.3 esrtmsetup(実行環境のセットアップ)
目的
運用ディレクトリ下にシステム分析支援リアルタイムモニタの実行環境(運用ディレクトリ)を作成、または更新します。
形式
esrtmsetup [-d 運用ディレクトリパス] [-w Webコンテナ名] [-o ダッシュボード出力用ポート番号] [-c Webコンテナ通信用ポート番号] [-e Webコンテナ終了用ポート番号] [-i 稼働情報最大保持件数] [-a アラート検知稼働情報最大保持件数]
機能
システム分析支援リアルタイムモニタの実行環境(運用ディレクトリ)を作成します。
コマンドの実行結果は標準出力に出力されます。実行環境の更新時は作成するディレクトリ、ファイルが存在しない場合に作成し、存在した場合はファイルを上書きします。例外的に上書きしないファイルを次に示します。
-
稼働情報格納領域
本コマンドは次の用途で使用します。
-
新規に実行環境を作成する
-
構築済みの実行環境を更新する
また、次のシステム分析支援リアルタイムモニタの定義ファイルは上書き対象ですが、元のファイルのバックアップを作成します。
-
運用ディレクトリ\conf\hsicrtm_config.properties
-
運用ディレクトリ\conf\jvm_options.cfg
-
運用ディレクトリ\conf\system_config.properties
バックアップファイルは運用ディレクトリ\conf内に格納します。
バックアップファイルは定義ファイルごとに最大3つまで作成し定義ファイル名の末尾に.bk1、.bk2、.bk3を付けて作成します。
バックアップファイル名の形式例を次に示します。
- 形式例
-
hsicrtm_config.properties.bk1 hsicrtm_config.properties.bk2 hsicrtm_config.properties.bk3
バックアップファイルは、.bk1、.bk2、.bk3の順に新しい定義のバックアップです。
バックアップファイル作成時に、運用ディレクトリ\conf内にすでにバックアップファイルが3つ存在する場合は、.bk3のバックアップファイルの定義が消去されます。
コマンド実行の前提条件
実行環境を更新する前に、esrtmlsコマンドでシステム分析支援リアルタイムモニタが終了していることを確認してください。
システム分析支援リアルタイムモニタが起動している場合はesrtmstopコマンドで終了後、本コマンドを実行してください。
コマンド実行パス
インストールディレクトリ\bin\esrtmsetup
オプション
- -d 運用ディレクトリパス ~〈108文字以内のパス名〉
-
《 インストールディレクトリ\job\HSICRTM00 》
作成(または更新)するシステム分析支援リアルタイムモニタの運用ディレクトリを絶対パスで指定します。
次の条件に該当するディレクトリパスは指定しないでください。
-
存在しないディレクトリパス
-
"\\"を含むディレクトリパス
-
"\"で終端しているディレクトリパス
-
シンボリックリンクを含むディレクトリパス
-
インストールディレクトリパス
-
空白を含むディレクトリパス
-
- -w Webコンテナ名 ~〈16文字以内の文字列〉《HSICRTM_Server》
-
ダッシュボード出力時に使用するWebコンテナのサーバ名を指定します。
指定するサーバ名の条件を次に示します。
-
サーバ名称には、半角英数字(0~9、A~Z、a~z)、アンダースコア(_)またはハイフン(-)が使用できます。サーバ名称の先頭の文字は英数字でなければなりません。
-
セットアップ済みのサーバ名称を指定して再セットアップを行うと、エラーとなります。
-
サーバ名称の大文字・小文字は区別されません。
-
- -o ダッシュボード出力用ポート番号 ~〈符号なし整数〉((1~65535))《29105》
-
ダッシュボード出力用のポート番号を指定します。
ポート番号は、ほかのプログラムと重複しないようにしてください。
- -c Webコンテナ通信用ポート番号 ~〈符号なし整数〉((1~65535))《29106》
-
Webコンテナとの通信で使用するポート番号を指定します。
ポート番号は、ほかのプログラムと重複しないようにしてください。
- -e Webコンテナ終了用ポート番号 ~〈符号なし整数〉((1~65535))《29107》
-
Webコンテナの終了時に使用するポート番号を指定します。
ポート番号は、ほかのプログラムと重複しないようにしてください。
- -i 稼働情報最大保持件数 ~〈符号なし整数〉((10000~1000000))《100000》
-
ダッシュボードの稼働情報表示エリアに表示するために保持する稼働情報の最大件数を指定します。
稼働情報が本指定値を超えたときは、古い稼働情報を削除します。
- -a アラート検知稼働情報最大保持件数 ~〈符号なし整数〉((100~100000))《1000》
-
ダッシュボードのアラート検知表示エリアに表示するために保持する稼働情報の最大件数を指定します。
稼働情報が本指定値を超えたときは、古い稼働情報を削除します。
実行環境の新規作成、または実行環境の更新時に指定できるオプションを次に記載します。
目的 |
-d |
-w |
-o |
-c |
-e |
-i |
-a |
---|---|---|---|---|---|---|---|
実行環境の新規作成 |
○ |
○ |
○ |
○ |
○ |
○ |
○ |
実行環境の更新 |
○ |
× |
× |
× |
× |
× |
× |
- (凡例)
-
○:省略できるオプション
×:指定できないオプション(コマンドがエラー終了)
戻り値
0:コマンドが正常に終了しました。
1:コマンドでエラーが発生しました。
コマンド実行例
実行環境の新規作成の場合
# esrtmsetup -d 運用ディレクトリ KFSE94255-Q The execution environment will be set up. Do you want to continue? [y: Continue n: Cancel] setup mode = new, setup directory = <運用ディレクトリ> y (ユーザーがyと入力) KFSE94254-I The execution environment was set up. setup directory = 運用ディレクトリ
実行環境の更新の場合
# esrtmsetup -d 運用ディレクトリ KFSE94255-Q The execution environment will be set up. Do you want to continue? [y: Continue n: Cancel] setup mode = update, setup directory = <運用ディレクトリ> y (ユーザーがyと入力) KFSE94254-I The execution environment was set up. setup directory = 運用ディレクトリ
注意事項
-
実行環境は1つだけ作成できます。実行環境を2つ以上作成した場合の動作は保証しません。
-
このコマンドの実行中にこのコマンドを含むほかのコマンドを実行しないでください。