Cosminexus リファレンス 定義編

[目次][索引][前へ][次へ]

8.2 adminagent.properties運用管理エージェントプロパティファイル

<この節の構成>
(1) 形式
(2) ファイルの格納先
(3) 機能
(4) 設定できるキー

(1) 形式

J2SEのプロパティファイル形式です。

運用管理エージェントのプロパティファイルです。

(2) ファイルの格納先

(3) 機能

運用管理エージェント本体に関する設定をします。

(4) 設定できるキー

指定できるキーとデフォルト値を次に示します。

キー名称 内容 デフォルト値
adminagent.adapter.allowedHosts サーバへのアクセスを許可するホスト名またはIPアドレスを指定します。複数のアドレスを指定する場合はコンマ(,)で空白を入れずに区切ります。省略した場合はすべてのIPアドレスを許可します。
IPアドレスはメタキャラクタを用いた正規表現で指定できます。IPアドレスを正規表現で指定した場合,利用可能なローカルIPアドレスのうちマッチするIPアドレスが使用されます。複数のIPアドレスがマッチした場合は,マッチしたすべてのIPアドレスが許可されます。
なお,IPアドレスを正規表現で指定する場合は,コンマ(,)で複数の値を指定することはできません。
なし
adminagent.adapter.bind_host 運用管理エージェントとの通信で使用するホスト名またはIPアドレスを指定します。
複数の物理ネットワークインタフェースを持つホスト,または一つの物理ネットワークインタフェースに対して複数の論理IPアドレスを割り当てているホストで運用管理エージェントを利用するとき,任意のIPアドレスを選択できます。
指定しなかった場合,すべてのローカルアドレスに対する接続を受け付けます。また,不正な値を指定した場合は,運用管理エージェントがエラー終了します。
IPアドレスはメタキャラクタを用いた正規表現で指定できます。IPアドレスが正規表現で指定された場合,利用可能なローカルIPアドレスのうちマッチするIPアドレスを採用します。※1
なし
adminagent.adapter.port サーバ機能の使用するポート番号を,1〜65535の数値で指定します。 20295
adminagent.cluster.localaddress.check アプリケーションサーバの系切り替え実行時に,待機系を停止するかどうかを設定します。
アプリケーションサーバの系切り替え実行時,待機系の論理サーバや運用管理エージェントが停止しなかった場合に,論理サーバと運用管理エージェントを停止します。

trueを指定した場合:
アプリケーションサーバの系切り替え実行時に,停止しなかった待機系の論理サーバおよび運用管理エージェントを停止します。
ローカルアドレスをチェックし,クラスタIPアドレスが設定されていなければ論理サーバを停止して,運用管理エージェントを停止します。

falseを指定した場合:
アプリケーションサーバの系切り替え実行時に,停止しなかった待機系の論理サーバおよび運用管理エージェントを停止しません。
false
adminagent.finalization.stop_servers 運用管理エージェントの終了処理で論理サーバを停止するかどうかを指定します。

trueを指定した場合:
運用管理エージェントの終了処理で,論理サーバをすべて停止します。

falseを指定した場合:
運用管理エージェントの終了処理で論理サーバを停止しません。
false
adminagent.forcestop.threaddump J2EEサーバおよびSFOサーバの強制停止時にスレッドダンプを出力するかどうかを指定します。この設定が有効な論理サーバはJ2EEサーバおよびSFOサーバだけです。

trueを指定した場合:
スレッドダンプを出力します。この場合,cjstopsvコマンドに-fdオプションを指定して実行した場合と同じ動作で強制停止します。※2
cjstopsvコマンドについては,マニュアル「Cosminexus リファレンス コマンド編」を参照してください。

falseを指定した場合:
スレッドダンプを出力しません。
false
adminagent.forcestop.threaddump.interval J2EEサーバおよびSFOサーバの強制停止時にスレッドダンプを出力する設定にした場合に,スレッドダンプ出力の完了を確認する間隔を,1〜2147483647の整数(単位:秒)で指定します。
1〜2147483647以外が指定された場合,デフォルト値が設定されます。
1
adminagent.forcestop.threaddump.timeout J2EEサーバおよびSFOサーバの強制停止時にスレッドダンプを出力する設定にした場合に,タイムアウトするまでの時間を,-1〜2147483647の整数(単位:秒)で指定します。
-1を指定した場合,スレッドダンプの出力が終了するまで待機します。-1〜2147483647以外が指定された場合,デフォルト値が設定されます。
指定した時間が経過してもスレッドダンプの出力が終了しない場合は,J2EEサーバおよびSFOサーバを強制停止します。※2ただし,強制停止監視時間を設定している場合,このキーは無効になります。また,06-50以降のバージョンからバージョンアップした場合はadminagent.forcestop.threaddump.timeoutの指定値と同じか,それより長い値を強制停止監視時間に設定してください。
45
adminagent.hws.group Hitachi Web Serverを使用する場合に,Hitachi Web Serverを起動するユーザが所属するグループ名を指定します。
省略した場合は,運用管理エージェントのグループで実行します。
このキーはUNIX用です。
なし
adminagent.hws.owner Hitachi Web Serverを使用する場合に,Hitachi Web Serverを起動するユーザ名を指定します。
省略した場合は,運用管理エージェントのユーザで実行します。
このキーはUNIX用です。
なし
adminagent.hws.watch.method adminagent.hws.watch.levelで2を指定したときのHitachi Web Serverの動作確認用HTTPメソッドを指定します。指定可能なメソッドは"HEAD"または"OPTIONS"のどちらかです。※4

"HEAD"を指定した場合:
adminagent.hws.watch.urlで指定されたURLにアクセスして応答が返ることを確認します。

"OPTIONS"を指定した場合:
WebサーバがHTTPメソッドを受け付け可能な状態であることを確認します。
HEAD※3
adminagent.hws.watch.url adminagent.hws.watch.methodで"HEAD"を指定したときの,Hitachi Web Serverの動作確認用URLを指定します。指定されたURLにアクセスし,レスポンスが返るかどうかで判定するため,実際にアクセスできるURLを指定してください。なお,URLは"http"で始まる絶対パス,またはルートコンテキストからの相対パスで指定します。同一のホストに複数のWebサーバを構築する場合は相対パスで指定してください。

(指定例)http://HostA:80/index.htmlを指定する場合
adminagent.hws.watch.url=http://HostA:80/index.html

http://localhost:<ポート番号>/index.htmlを指定する場合(複数Webサーバ対応)
adminagent.hws.watch.url=index.html
ルートコンテキスト(http://localhost:<ポート番号>/)
adminagent.j2ee.sys_cmd.abnormal_end.threaddump 障害検知時コマンド実行の際にJ2EEサーバのスレッドダンプを収集するかどうかを指定します。

trueを指定した場合:
J2EEサーバのスレッドダンプを収集します。

falseを指定した場合:
J2EEサーバのスレッドダンプを収集しません。
true
adminagent.jp1event.event_server_name 使用するJP1/Baseのイベントサービスのイベントサーバ設定ファイル(conf)に指定した,portsキーのアドレスと同じ値を指定します。portsキーに複数のアドレスを指定している場合は,指定したアドレスのうちのどれか一つを指定します。なお,portsキーのアドレスに「0.0.0.0」(デフォルト値)を指定したイベントサービスを使用する場合は,このキーを省略するか,自マシンのホスト名またはlocalhostを指定します。 localhost
adminagent.jp1event_enabled 運用管理エージェントからJP1イベントを発行するかどうかを指定します。

trueを指定した場合:
JP1イベントを発行します。

falseを指定した場合:
JP1イベントを発行しません。
false
adminagent.log.filenum ログファイル面数を1〜16の整数で指定します。 4
adminagent.log.filesize ログファイル一つ当たりの上限サイズ(単位:バイト)を,65536〜2147483647の数値で指定します。 65536
adminagent.log.level ログ出力レベルを-1〜1000の整数で指定します。
  • -1:出力しません。
  • 0:通常運用:通常運用。
  • 10:通常運用(verbose):通常運用に近い形態での再現待ち。
  • 20:再現テスト:システム環境構築時やテストフェーズでの,デバッグレベルの情報の取得。
  • 30:障害調査:原因究明困難な障害発生時,より詳細な障害情報の取得。
0
adminagent.lsinfo_dir 論理サーバ情報ファイルの出力先ディレクトリを指定します。指定したディレクトリが存在しない場合は作成します。
運用管理エージェント再起動後に,停止前に管理していた論理サーバを再び管理下に置き,操作できるようにするための情報です。論理サーバの起動中に作成され,論理サーバの停止後に削除されます。

  • Windowsの場合
    <Cosminexusのインストールディレクトリ>\manager\spool\lsinfo
  • UNIXの場合
    /opt/Cosminexus/manager/spool/lsinfo
adminagent.maintenance.log.filenum 保守ログのファイル面数を1〜16の整数で指定します。 4
adminagent.maintenance.log.filesize 保守ログのファイル一つ当たりの上限サイズ(単位:バイト)を,65536〜2147483647の整数で指定します。 16777216
adminagent.rmi.log.filenum 運用管理エージェントが行うRMI処理での保守ログのファイル面数を数値で指定します。 8
adminagent.rmi.log.filesize 運用管理エージェントが行うRMI処理での保守ログのファイル一つ当たりの上限サイズを数値で指定します。 16777216
adminagent.rmi.log.level 運用管理エージェントが行うRMI処理での保守ログの出力レベルを文字列で指定します。

<OFF>
出力しません。

<SEVERE>,<WARNING>,<INFO>,<CONFIG>,<FINE>,<FINER>,<FINEST>
SEVEREは深刻な問題だけを出力します。ここに示した順番でより詳細なログが出力されるようになります。
FINER
adminagent.snapshotlog.log_dir snapshotログの出力先ディレクトリを,文字列で指定します。指定したディレクトリがない場合は作成します。
  • Windowsの場合
    <manager.cfgのcom.cosminexus.manager.log.dir>\snapshot\
  • UNIXの場合
    <manager.cfgのcom.cosminexus.manager.log.dir>/snapshot/
adminagent.snapshotlog.num_snapshots 一次資料として収集する,論理サーバごとのsnapshotログファイル数を,-2147483648〜2147483647の数値で指定します。指定されたファイル数を超えた場合,作成時刻の古い順にログファイルは削除されます。また,0以下の値を指定した場合,ログファイルは削除されません。 10
adminagent.snapshotlog.listfile.2.num_snapshots 二次資料として収集する,論理サーバごとのsnapshotログファイル数を,-2147483648〜2147483647の数値で指定します。指定されたファイル数を超えた場合,作成時刻の古い順にログファイルは削除されます。また,0以下の値を指定した場合,ログファイルは削除されません。 10
adminagent.sys_cmd.abnormal_end.prftrace 障害検知時コマンド実行の際に性能解析トレースファイルを収集するかどうかを指定します。

trueを指定した場合:
性能解析トレースファイルを収集します。

falseを指定した場合:
性能解析トレースファイルを収集しません。
true
adminagent.watch.retry_timeout.enabled 論理サーバの動作確認で,タイムアウトの発生をリトライ対象とするかどうかを指定します。

trueを指定した場合:
リトライ対象とします。

falseを指定した場合:
リトライ対象としません。
新規インストールの場合:true
バージョンアップの場合:既存の指定値が設定されます。
adminagent.<サーバ種別>.process.console_event.enabled 論理サーバのコンソール出力情報をServer Plug-inまたはHCSC-Managerに表示するかどうかを指定します。

trueを指定した場合:
コンソール出力情報をServer Plug-inまたはHCSC-Managerに出力します。

falseを指定した場合:
コンソール出力情報をServer Plug-inまたはHCSC-Managerに出力しません。
<サーバ種別>は,論理サーバの種別を表す,次のどちらかになります。
・j2ee:J2EEサーバ
・userserver:ユーザサーバ

注意事項
  • adminagent.process.consolelog.enabledをtrueに設定する必要があります。
  • リソースを消費するため,Server Plug-inまたはHCSC-Managerを使用しない運用ではfalseに設定することを推奨します。
false
adminagent.<サーバ種別>.process.console_log.enabled 論理サーバのコンソール出力情報をコンソールログに出力するかどうかを指定します。

trueを指定した場合:
コンソール出力情報をコンソールログに出力します。

falseを指定した場合:
コンソール出力情報をコンソールログに出力しません。
<サーバ種別>は,論理サーバの種別を表す,次のどちらかになります。
・j2ee:J2EEサーバ
・userserver:ユーザサーバ

注意事項
adminagent.process.consolelog.enabledをtrueに設定する必要があります。
false
adminagent.<サーバ種別>※5.usr_cmd.abnormal_end 障害検知時コマンドを絶対パスで指定します。ファイルセパレータは「/」を使用します。障害が発生した論理サーバの種別に応じてコマンドを変えることができます。<サーバ種別>※5に指定できる値以外の値を指定した場合は,無効になります。

Windowsの場合:
障害検知時コマンドをバッチファイルで作成する場合,コマンド名の前に“%{ComSpec} /C ”を追加する必要があります。“%{ComSpec}”は,cmd.exeの絶対パスに置換されます。“%{ComSpec} /C”が指定されていない場合,コマンドが正常に動作しないことがあります。また,コマンドのパスに半角スペースを含む場合は,コマンドの絶対パスを必ずダブルクォーテーション("")で囲みます。
(例)J2EEサーバ障害発生時に,d:/my bat/j2eeabnormalend.batを実行する場合
adminagent.j2ee.usr_cmd.abnormal_end=%{ComSpec} /c "d:/my bat/j2eeabnormalend.bat"

UNIXの場合:
障害検知時コマンドをシェルスクリプトで作成する場合,コマンド名の前に“/bin/sh”を追加する必要があります。“/bin/sh”が指定されていない場合,コマンドが正常に動作しないことがあります。
(例)J2EEサーバ障害発生時に,/home/user1/j2eeabnormalend.shを実行する場合
adminagent.j2ee.usr_cmd.abnormal_end=/bin/sh /home/user1/j2eeabnormalend.sh
なし
adminagent.<サーバ種別>※5.watch.interval 論理サーバの動作確認間隔(単位:秒)を1〜86400の整数で指定します。
不正な値が指定された場合は,デフォルト値が設定されます。
10
adminagent.<サーバ種別>※5.watch.level 論理サーバの動作確認レベルを指定します。指定できる値は,1または2です。

1を指定した場合:
プロセスの存在確認で論理サーバの動作を確認します。

2を指定した場合:
プロセスの存在確認および論理サーバへのアクセスで論理サーバの動作を確認します。動作を確認できる論理サーバは,ネーミングサービス,SFOサーバ,J2EEサーバおよびWebサーバです。そのほかの論理サーバに2を指定しても,プロセスの存在確認だけになります。

  • ネーミングサービス,SFOサーバ,J2EEサーバおよびWebサーバの場合:2
  • 上記以外の論理サーバの場合:1
adminagent.<サーバ種別>※5.watch.retry_count 論理サーバの動作確認で,動作確認処理に失敗した場合にリトライする回数を0〜86400の整数で指定します。リトライ回数を設定することで,一時的な動作確認の失敗を許容することができます。
リトライする間隔は,adminagent.<サーバ種別>.watch.intervalで指定します。0を指定した場合,動作確認処理に失敗すると,リトライしないで異常発生とみなされます。
動作確認処理に失敗し,リトライする場合はKEOS21033-W,またはKEOS21034-Wが運用管理エージェントのログに出力されます。
動作確認処理に失敗し,リトライしない場合,またはリトライ回数が指定回数を超えた場合はKEOS20511-E,またはKEOS21035-Eが運用管理エージェントのログに出力され,Management Serverに異常が通知されます。
1
adminagent.<サーバ種別>※5.watch.start_time 論理サーバの起動で,起動コマンドを実行してから動作確認(動作確認レベル2)を開始するまでの時間(単位:秒)を0〜86400の整数で指定します。
論理サーバを起動した際の論理サーバのログ(J2EEサーバの場合,cjmessage?.logのKDJE30028-I)から実際に起動に掛かる所要時間を求め,その時間から数秒短い時間をこのプロパティに指定しておくことで,起動前に出力される不要なログ出力を減らし,論理サーバの起動完了をManagement Serverに迅速に通知できます。
論理サーバの起動/停止機能で設定する起動監視時間は,このプロパティに指定した値よりも大きい値を指定する必要があります。指定した値よりも小さい値を指定した場合は起動に失敗します。
<サーバ種別>※5によって次のように異なります。
  • prf:0
  • smartagent:3
  • naming:10
  • ctmdm:0
  • ctm:0
  • sfo:45
  • j2ee:45
  • hws:0
adminagent.<サーバ種別>※5.watch.timeout 論理サーバの動作確認でタイムアウトするまでの時間を,1〜9223372036854775の整数(単位:秒)で指定します。 60
adminagent.j2ee.sys_cmd.abnormal_end.javatrace 障害検知時コマンドの実行の際にJ2EEサーバのスタックトレースを取得するかどうかを指定します。

trueを指定した場合:
スタックトレースを取得します。

falseを指定した場合:
スタックトレースを取得しません。
true
adminagent.hws.sys_cmd.abnormal_end.traceinfo 障害検知時コマンドの実行の際にWebサーバの内部トレースを採取するかどうかを指定します。

trueを指定した場合:
内部トレースを採取します。

falseを指定した場合:
内部トレースを採取しません。
true
adminagent.process.consolelog.enabled 運用管理エージェントが起動したプロセスのコンソール出力情報を取得するかどうかを指定します。ただし,Server Plug-inまたはHCSC-Managerを使用する場合はtrueを指定する必要があります。

trueを指定した場合:
コンソール出力情報を取得します。

falseを指定した場合:
コンソール出力情報を取得しません。
true
adminagent.process.consolelog.filenum 運用管理エージェントが起動したプロセスのコンソール出力情報を出力するログファイル面数を,1〜16の整数で指定します。 4
adminagent.process.consolelog.filesize 運用管理エージェントが起動したプロセスのコンソール出力情報を出力するログファイル一つ当たりの上限サイズ(単位:バイト)を,65536〜2147483647の整数で指定します。 65536
adminagent.process.consolelog.event.queue_size 運用管理エージェントが起動したプロセスのコンソール出力情報を,Management Serverにイベント通知する際の,イベントキューのサイズを設定します。
キューがいっぱいになった場合は,古いイベントから破棄されます。
このプロパティは,デフォルト値が推奨のため,設定を変更しないでください。
1024

注※1
運用管理ドメイン内で運用管理エージェントとの通信に使用されるIPアドレスのサブネットが一つに決められている場合,指定するIPアドレスを"192\\.168\\.0\\..+"のように記述しておけば,前方が"192.168.0."であるIPアドレス("192.168.0.32"や"192.168.0.128"など)にマッチするため,設定ファイルを修正しないで,すべてのホストに配布して利用できます。正規表現についての詳細は,Javaのjava.util.regex.Patternクラスの仕様を確認してください。
ただし,"\\"は1文字の"\"に置き換えられてしまうため,"\"を指定する場合は2文字連続して指定してください。指定した正規表現にマッチするIPアドレスが複数個検出された場合は,最も小さい値のIPアドレスを採用します。例えば,"192.168.0.32"と"192.168.0.128"が検出された場合は"192.168.0.32"を採用します。この場合,採用されたIPアドレスが意図するIPアドレスになるとは限らないため,"192\\.168\\.0\\.1.."のように必ず1個だけマッチする正規表現を記述してください。

注※2
強制停止時にスレッドダンプを出力する場合は,スレッドダンプ出力監視タイムアウト(adminagent.forcestop.threaddump.timeout)に十分な時間を設定してください。また,強制停止にかかる時間が長いため強制停止に失敗する場合は,「論理サーバの起動と停止の設定」の「停止監視時間」を十分な監視時間にする必要があります。また,ワトソン博士を使用している場合,「メッセージボックスによる通知」を設定しないでください。ワトソン博士の詳細はMicrosoft社のホームページなどを参照してください。

注※3
06-50以降のバージョンの設定ファイルには,初期値としてadminagent.hws.watch.method=OPTIONSの行が定義されています。このため,06-50より前のバージョンからバージョンアップした場合の動作確認用HTTPメソッドの初期値はデフォルトの"HEAD"になりますが,新規にインストールした場合または06-50以降のバージョンからバージョンアップした場合の動作確認用HTTPメソッドの初期値は"OPTIONS"になります。

注※4
リダイレクタにマッピングするURLパターンに"/*"を指定した場合,すべてのURLはJ2EEサーバのWebコンテナにリダイレクトされてしまいます。したがって,リダイレクタにマッピングするURLパターンに"/*"を指定する場合は,"OPTIONS"を指定し,URLアクセスを行わないことを推奨します。

注※5
<サーバ種別>は,論理サーバの種別を表す,次のどれかになります。
・smartagent:スマートエージェント
・j2ee:J2EEサーバ
・naming:ネーミングサービス
・hws:Webサーバ(Hitachi Web Server)
・ctm:CTM
・ctmdm:CTMドメインマネジャ
・prf:パフォーマンストレーサ
・sfo:SFOサーバ
・userserver:ユーザサーバ