mngsvrutil(Management Serverの運用管理コマンド)
形式
mngsvrutil [-m <ホスト名> [:<ポート番号>] {[-u <管理ユーザID>] [-p <管理ユーザパスワード>] | -interactive} [[-o <ファイル名>] [-h] [-f <出力形式>] [-t <ターゲット名称>] [-k <ターゲット種別>] [-s] [-i <監視時間間隔>] [-l <最大監視時間>] [-w < 稼働確認待ち時間>] <サブコマンド> <引数>]]
機能
Management Serverに接続して,運用管理ドメインについての操作ができます。また,JP1/Cm2/ESAなどのSNMPエージェント製品を使用して,mngsvrutilコマンドの出力結果をMIBに変換すると,SNMP Manager製品と連携できます。
このコマンドでは,次の機能を使用できます。
-
運用管理ドメインの構成情報の取得
運用管理ドメインの名称,および運用管理ドメインを構成する論理サーバの一覧を取得して,表示します。
-
論理サーバのステータス情報の取得
運用管理ドメインを構成する論理サーバの一覧に,ステータス(稼働しているかどうか)情報を付加して表示します。
-
論理サーバにデプロイされているJ2EEアプリケーションの情報の取得
J2EEアプリケーションの一覧を取得して,表示します。
-
論理サーバの性能情報の取得,および統計情報についての設定
論理サーバの性能情報(JavaVM,トランザクション,HTTPサーバ,HTTPサーバコネクタなど)を取得します。また,統計情報のサンプリング時間を設定します。
-
論理サーバの起動または停止
論理サーバを起動または停止します。
-
論理サーバの設定ファイルの再読み込み
論理サーバを再起動しないで,論理サーバで使用する設定ファイルを再読み込みします。また,論理J2EEサーバで,接続先ホストの設定ファイルを再読み込みすることもできます。
-
論理サーバの追加・削除
論理サーバを追加または削除します。
-
論理サーバのアプリケーション管理
J2EEアプリケーション/J2EEリソースの開始/停止および一覧表示をします。アプリケーション管理の動作については,マニュアル「アプリケーションサーバ 運用管理ポータル操作ガイド」の「12. 論理サーバのアプリケーション管理」を参照してください。
-
性能解析トレースの収集
論理パフォーマンストレーサから性能解析トレースを収集します。
-
CTMキューの閉塞/閉塞解除
CTMのスケジュールキューの閉塞,および閉塞の解除をします。
-
CTM稼働統計情報の収集
CTMから稼働統計情報を収集します。
-
同時実行スレッド数の動的変更
Webアプリケーションの同時実行スレッド数を動的に変更します。
このコマンドの-pオプションにパスワードを指定した場合,プロセスの引数を確認できるOS機能などでパスワードが観測されるおそれがあります。このため,-interactiveオプションによる対話形式でのパスワードの設定を推奨します。
引数
- -m <ホスト名>[:<ポート番号>]
-
Management Serverのホスト名とポート番号を指定します。
-
<ホスト名>
ドット記法でのIPアドレス指定(xxx.xxx.xxx.xxx),または名前解決できるホスト名で指定します。なお,xxxには0〜255の整数を指定します。
-
<ポート番号>
Management Serverの設定に従います。デフォルト値は28080です。
-
- -u <管理ユーザID>
-
mngsvrctl setupコマンドまたは運用管理ポータルの「管理ユーザアカウントの設定」で設定した管理ユーザIDを指定します。
運用管理ポータルの「管理ユーザアカウントの設定」で入力できる文字に従います。
管理ユーザアカウントの省略機能が有効の場合,管理ユーザIDを指定しても無効となります。管理ユーザアカウントの省略機能については,マニュアル「アプリケーションサーバ システム構築・運用ガイド」の「4.1.15(3) 管理ユーザアカウントを設定しない場合の設定」を参照してください。
- -p <管理ユーザパスワード>
-
mngsvrctl setupコマンドまたは運用管理ポータルの「管理ユーザアカウントの設定」で設定した管理ユーザIDに対応する管理ユーザパスワードを指定します。
運用管理ポータルの「管理ユーザアカウントの設定」で入力できる文字に従います。
なお,パスワードを設定していない場合,-pオプションを指定する必要はありません。
管理ユーザアカウントの省略機能が有効の場合,管理ユーザパスワードを指定しても無効となります。管理ユーザアカウントの省略機能については,マニュアル「アプリケーションサーバ システム構築・運用ガイド」の「4.1.15(3) 管理ユーザアカウントを設定しない場合の設定」を参照してください。
- -interactive
-
管理ユーザIDと管理ユーザパスワードを対話形式で入力する場合に指定します。対話形式で入力した場合,.mngsvrutilrcファイルまたはmngsvrutilcl.propertiesファイルに指定した,管理ユーザIDおよび管理ユーザパスワードは無視されます。
管理ユーザアカウントの省略機能有効時には,対話形式で入力した管理ユーザIDおよび管理ユーザパスワードは有効になりません。
このオプションを指定する場合は,-uオプションまたは-pオプションは指定できません。-uオプションまたは-pオプションを指定した場合,KEOS16118-Eメッセージが出力され処理を終了します。
このオプションを指定してコマンドを実行すると,次のプロンプトが表示され,管理ユーザIDの入力を待つ状態になります。
> User ID:
管理ユーザIDを入力すると,次のプロンプトが表示され,管理ユーザパスワードの入力を待つ状態になります。
> Password:
コマンドプロンプトやコンソールなどから直接実行した場合,パスワードをエコーバックしません。ほかのプログラムから間接的に実行した場合は,パスワードをエコーバックすることがあります。
- -o <ファイル名>
-
出力先のファイル名を指定します。指定されたファイルに上書き出力します。なお,指定できるファイル名は,コマンドを実行するOSに依存します。また,省略した場合,標準出力に出力します。
- -h
-
ヘッダを出力しない場合に指定します。
- -f <出力形式>
-
接続するManagement Serverで提供している出力形式を指定します。Management Serverでは,次に示す出力形式を提供しています。
-
csv:CSV形式(デフォルト値)
-
snmp:SNMP連携用形式
-
- -t <ターゲット名称>
-
サブコマンドの対象となるターゲット名称(論理サーバ名またはホスト名)を指定します。
運用管理ポータルの「論理サーバの構成定義」の定義に従います。
- -k <ターゲット種別>
-
サブコマンドの対象となるターゲットの種別を指定します。次のどちらかを指定します。
-
logicalServer:論理サーバ
-
host:ホスト
省略した場合,または上記以外の値を指定した場合は,logicalServerが設定されます。
-
- -s
-
論理サーバやJ2EEアプリケーションの起動または停止の完了を待つ場合に指定します。
このオプションは,サブコマンドに"start"または"stop"を指定した場合に有効です。
なお,このオプションを指定した場合,起動/停止障害発生時,障害回復のためにサブコマンドのリトライ処理が実行されます。
- -i <監視時間間隔>
-
論理サーバやJ2EEアプリケーションの起動・停止の完了を監視する際の監視時間間隔を,0〜2147483647の整数(単位:秒)で指定します。省略時のデフォルトは3秒です。
なお,このオプションは,起動/停止障害発生時のサブコマンドのリトライ処理間隔としても利用されます。
- -l <最大監視時間>
-
論理サーバやJ2EEアプリケーションの起動・停止の完了を監視する際の最大監視時間を,0〜2147483647の整数(単位:秒)で指定します。
指定した値の時間を超えても論理サーバやJ2EEアプリケーションが起動・停止しない場合,コマンドは異常終了します。0を指定した場合は無限に待ちます。省略時のデフォルトは60秒です。
- -w <稼働確認待ち時間>
-
Management Serverおよび運用管理エージェントが稼働しているかどうかを確認するための待ち時間を,0〜2147483の整数(単位:秒)で指定します。
指定した待ち時間を経過しても応答がない場合,コマンドは異常終了します。
0を指定した場合は無限に待ちます。なお,0より小さい値を指定した場合は0を,2147483より大きい値を指定した場合は2147483が仮定されます。省略時のデフォルトは0です。
このオプションは,checkサブコマンドを指定した場合だけに有効です。
- <サブコマンド> <引数>
-
サブコマンドと引数を指定します。サブコマンドと引数に指定できる値は,Management Serverのバージョンに依存します。
サブコマンドでは,指定する引数によって,ターゲットに論理サーバまたはホストが指定できます。
次のサブコマンドが指定できます。
なお,サブコマンドの詳細は,「7.3 mngsvrutilコマンドのサブコマンドの詳細」を参照してください。
戻り値
- 0:
-
正常終了しました。
- 1:
-
実行時エラーが発生しました。
- 2:
-
シンタックスエラーが発生しました。
出力形式
- CSV形式
-
名称,および値はコンマで区切って出力します。
-hオプションでヘッダの出力を抑止できます。
- SNMP連携形式
-
値は半角スペース(0x20)で区切って出力します。また,文字列はダブルクォーテーション(0x22)で囲んで出力します。
なお,文字列にダブルクォーテーション(0x22)とバックスラッシュ「\」(0x5c)が含まれていた場合,エスケープコード(バックスラッシュ「\」(0x5c))を付加します。
- (例)
-
編集前文字列: ”abc” def\ g
編集後文字列: ”\”abc\” def\\ g”
整数値は32bit整数型で表します。また,浮動小数点数は小数点以下を切り捨てて32bit整数型で表します。
ヘッダは出力されません。
設定ファイル
- クライアント側定義ファイル(.mngsvrutilrc)
-
mngsvrutilコマンドのオプションのデフォルト値を設定できます。
詳細については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「8.2.14 .mngsvrutilrc(mngsvrutilコマンドのクライアント側定義ファイル)」を参照してください。
mngsvrutilrcのパラメタであるmngsvrutil.target_kind,mngsvrutil.target_name,mngsvrutil.target_server_nameプロパティと"-k","-t"オプションとの組み合わせの時に有効となる値を次の表に示します。
項番
target_kind
target_name
target_server_name
-k
-t
指定値の解釈
1
logicalServer/−
−
−
logicalServer/−
−
サーバ名が指定されていません。
2
logicalServer/−
A
B/−
logicalServer/−
−
“A”という名称のサーバが指定されました。
3
logicalServer/−
−
B
logicalServer/−
−
“B”という名称のサーバが指定されました。
4
logicalServer/−
A/−
B/−
logicalServer/−
C
“C”という名称のサーバが指定されました。
5
host
−
−
−
−
ホスト名が指定されていません。
6
host/−
−
−
host
−
ホスト名が指定されていません。
7
host
−
B
−
−
ホスト名が指定されていません。
8
host/−
−
B
host
−
ホスト名が指定されていません。
9
host
A
B/−
−
−
“A”という名称のホストが指定されました。
10
host/−
A/−
B/−
host
C
“C”という名称のホストが指定されました。
- クライアント側共通定義ファイル(mngsvrutilcl.properties)
-
mngsvrutilコマンドのオプションの共通のデフォルト値を設定できます。
詳細については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「8.2.16 mngsvrutilcl.properties(mngsvrutilコマンドのクライアント側共通定義ファイル)」を参照してください。
- サーバ側定義ファイル(mngsvrutil.properties)
-
mngsvrutilコマンドの実行環境を変更できます。
詳細については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「8.2.15 mngsvrutil.properties(mngsvrutilコマンドのサーバ側定義ファイル)」を参照してください。
入力例・出力例
-
入力例1
運用管理ドメイン内の論理サーバとステータス情報の一覧の取得
$ mngsvrutil -m 123.45.67.89:28880 -u admin1 -p pw1 list status
-
出力例1
logicalServerName,status,type,startingOrder,parent smplSvrName1,working,NamingService,10,- smplSvrName2,starting,SFOServer,15,- smplSvrName3,stopped,J2EEServer,20,J2EEServerCluster1 smplSvrName4,starting,J2EEServer,30,J2EEServerCluster1 smplSvrName5,stopping,WebServer,40,WebServerCluster1 smplSvrName6,abnormal ended,J2EEServer,50,- smplSvrName7,recovering,J2EEServer,60,- smplSvrName8,communication error,J2EEServer,70,J2EEServerCluster2 ・・・ ・・・
-
入力例2
運用管理ドメイン名称の取得
$ mngsvrutil -m localhost -u admin1 -p pw1 get domainName
-
出力例2
smplDomainName
-
入力例3
J2EEアプリケーションについての情報の取得 $ mngsvrutil -m 123.45.67.89 -u admin2 -t myServer get j2eeApps
-
出力例3
index,fullyQualifiedName,name,deployedTime 1,serverName1:smplApp1,smplApp1,1234567890 2,serverName2:smplApp2,smplApp2,9876543210 ・・・ ・・・ 7,serverName7:smplApp7_TEST,smplApp7,7656543210
-
入力例4
Stateless Session Beanのホームインタフェースについての情報の取得
$ mngsvrutil -m 123.45.67.89 -u admin2 -t myServer get statelessBeanHome
-
出力例4
index,fullyQualifiedName,name,responseMaxTime,responseMinTime,responseAveTime,statisticsStartedTime,samplingTime 1,smpQfn1,smplBeanName1,300,100,123.45,67339847,600 2,smpQfn2,smplBeanName2,17,52,34.251,122343838,10 ・・・ ・・・
-
入力例5
ホスト内のすべてのJ2EEアプリケーションに対応するスケジュールキューの閉塞
$ mngsvrutil -m 123.45.67.89 -u admin2 -t hostA -k host hold queues in:-1
-
入力例6
ホスト内のすべてのJ2EEアプリケーションに対応するスケジュールキューの閉塞解除
$ mngsvrutil -m 123.45.67.89 -u admin2 -t hostA -k host release queues
-
入力例7
運用管理ドメイン内のすべてのパフォーマンストレーサが収集した性能解析トレースの一括収集
$ mngsvrutil -m 123.45.67.89 -u admin2 collect allPrfTraces
SNMP連携時の設定手順(UNIXの場合)
UNIXの場合のSNMP連携時の設定手順を次に示します。
-
JP1/Cm2/ESAのインストール
-
~root/.mngsvrutilrcファイルの作成,編集
-
/opt/Cosminexus/manager/config/templates/.mngsvrutilrcファイルを~rootにコピーします。
# cp /opt/Cosminexus/manager/config/templates/.mngsvrutilrc ~root/
-
~root/.mngsvrutilrcファイルのファイルパーミッションを600に変更します。
# chmod 600 ~root/.mngsvrutilrc
-
~root/.mngsvrutilrcファイルを編集します。
適切なエディタを使用して,次の項目を設定します。各項目の詳細については,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「8.2.14 .mngsvrutilrc(mngsvrutilコマンドのクライアント側定義ファイル)」を参照してください。
mngsvrutil.connect.host
mngsvrutil.connect.userid
mngsvrutil.connect.password
mngsvrutil.output.format=snmp
mngsvrutil.target_name
mngsvrutil.target_kind
-
-
JP1/Cm2/ESAの環境設定
Application Serverの拡張MIBオブジェクト定義ファイル(/opt/Cosminexus/manager/config/ hitachi-cosmiMng-MIB※1,※2)を使用して,SNMPサブエージェントを再構成します。SNMPサブエージェントの再構成の方法については,マニュアル「JP1/Cm2/Extensible SNMP Agent」を参照してください。
注※1 実際は,hitachi-cosmiMng-MIBのあとに_V-R(バージョン)が付加されます(例:hitachi-cosmiMng-MIB_2-0)。
注※2 拡張MIBオブジェクト定義ファイルを使用する場合は,hitachi-cosmiMng-MIB_V-R_forESAを使用してください。
拡張MIBオブジェクト定義ファイルは最新のバージョンを使用してください。
注意事項
-
コマンドを入力する際,オプションおよびサブコマンドを次のように指定します。
-
オプションのサブコマンドおよび引数は,必ず最後尾に指定してください。
-
オプションを重複して指定した場合は,最後に指定したものを有効とします。
-
ある特定の操作に対して無意味なオプションを指定した場合(例えば,setサブコマンドで-hオプションを指定),そのオプションは無視されます。
-
オプションの指定が省略された場合,クライアント側定義ファイル(.mngsvrutilrc)にデフォルト値が設定されているときは,そのデフォルト値を有効にします。
-
すべてのオプションを省略した場合,Usage(Simple Usage)を表示します。また,-m,-u,および-pオプション以外の引数をすべて省略した場合,詳細なUsage(detailed usage)を表示します。
-
-
listまたはgetで取得した値が異常値(統計を取得していないときの統計値など)の場合,値は-1を0として表示します。
-
サブコマンドで取得した情報は標準出力に表示します。
-
Usageおよびエラー情報は標準エラー出力に表示します。
-
SNMP連携時の設定で,SNMP Managerが参照する拡張MIBオブジェクト定義ファイルのバージョンが,SNMP Agentが参照する拡張MIBオブジェクト定義ファイルのバージョンよりも新しい場合は,期待する結果が得られない場合があります。
このため,同じバージョンに合わせるか,SNMP Agentが参照する拡張MIBオブジェクト定義ファイルのバージョンを,SNMP Managerが参照する拡張MIBオブジェクト定義ファイルのバージョンより新しくする必要があります。
-
同一論理サーバに対して,startの直後にstopを実行したり,stopの直後にstartを実行したりする場合は,先に実行するサブコマンドに-sオプションを指定し,そのサブコマンドが完了したあとに次のサブコマンドを実行してください。
-
listで取得されるステータスは,list以外のサブコマンド(start,stopなど)の処理の実行状態に関係なく,呼び出し時点での情報が返されます。そのため,startによる起動処理が完了する前に"working"のステータスを返したり,stopによる停止処理が完了する前に"stopped"のステータスを返したりすることがあります。