2.10.1 collect-local-snapshot
ドメイン管理サーバ非稼働時のシステム情報の収集
書式
asadmin [asadmin-options] collect-local-snapshot [--infotype info-type1[,info-type2]...] [--domaindir domain-root-dir] [--domain domain-name] [--nodedir node-root-dir] --targettype={node|server} [--targetname target-name1[,target-name2]...] [--archivefile archive-file] [--timeout timeout]
格納先
Application Serverインストールディレクトリー/javaee/glassfish/bin
機能
collect-local-snapshotサブコマンドは、Application Serverを構成する製品のシステム情報を収集します。集めた情報は、システム情報アーカイブファイルとして出力します。
このサブコマンドの実行中に強制終了した場合、システム情報アーカイブファイルの出力先ディレクトリーに、次に示すファイルやディレクトリーが残ることがあります。
-
拡張子が"zip"の、サブコマンドが一時的に生成したファイル
-
拡張子が"tmp"の、サブコマンドが一時的に生成したファイル
-
サブコマンドが一時的に生成したディレクトリー(ディレクトリー名は実行ごとに異なります)
出力先ディレクトリーに生成されるシステム情報アーカイブファイルの数は上限値を設定できるため、拡張子が"zip"のファイルが残り続けることはありません。これ以外のファイルおよびディレクトリーは適宜削除してください。削除するときは、collect-snapshotサブコマンドおよびcollect-local-snapshotサブコマンドが動作中でないことをメッセージログで確認してください。
- 重要
-
-
collect-local-snapshotサブコマンドを実行するごとにスレッドダンプファイルが生成されます。スレッドダンプファイルを残しておく必要がない場合は、サブコマンドの実行完了後に削除してください。スレッドダンプファイルは、デフォルトではカレントディレクトリーに出力されます。ドメイン管理サーバのカレントディレクトリーは「Application Serverインストールディレクトリー/javaee/glassfish/domains/ドメイン名/config」、Java EEサーバのカレントディレクトリーは「Application Serverインストールディレクトリー/javaee/glassfish/nodes/ノード名/サーバインスタンス名/config」になります。
-
スレッドダンプファイルの出力先をカレントディレクトリーから変更した場合は、システム情報アーカイブファイルにスレッドダンプファイルが含まれなくなります。
-
タイムアウトによってシステム情報の収集が中断された場合は、collect-local-snapshotサブコマンドが内部で呼び出したプロセスの実行も中断されます。ただし、collect-local-snapshotサブコマンドが呼び出したプロセスがさらに別のプロセスを呼び出している場合、このプロセスを中断できない場合があります。
-
実行権限
一般ユーザー
前提条件
-
このサブコマンドを、同一のサーバに対して複数同時に実行しないこと
引数
- --infotype info-type1[,info-type2]...
-
収集するシステム情報の種類を指定します。複数の種類をコンマで区切って記述できます。
型:String
指定できる値を次に示します。
-
initinfo
問題点の切り分けに最低限必要な、初期調査用のシステム情報を収集します。
-
sysinfo
原因の調査に必要な、すべてのシステム情報を収集します。初期調査用のシステム情報も含みます。
デフォルト値:initinfo,sysinfo
-
- --domaindir domain-root-dir
-
ドメインルートディレクトリーの絶対パスを指定します。ドメインルートディレクトリーをApplication Serverのデフォルト値から変更していない場合や、ドメイン管理サーバが存在しないホストで実行する場合は省略できます。
型:String
指定できる値を次に示します。
-
ドメインルートディレクトリーの絶対パス
デフォルト値:Application Serverインストールディレクトリー/javaee/glassfish/domains
-
- --domain domain-name
-
同じ名称のノードやサーバが複数のドメインに存在する場合は、システム情報を収集したいノードやサーバが所属するドメインの名称を指定します。それ以外の場合は省略できます。
このオプションに指定した名称のドメインが複数あり、各ドメインに存在する同じ名称のサーバを--targetnameオプションに指定した場合は、ドメイン名とサーバ名が一致するすべてのサーバのシステム情報を収集します。
型:String
指定できる値を次に示します。
-
ドメイン名
デフォルト値:なし
-
- --nodedir node-root-dir
-
サーバ(Java EEサーバ、Webサーバ、PRF)が構築されているノードルートディレクトリーの絶対パスを指定します。サーバが構築されているノードルートディレクトリーをApplication Serverのデフォルト値から変更していない場合や、ノードが存在しないホストで実行する場合は省略できます。
このオプションは、ノードルートディレクトリーを1つだけ指定できます。異なるノードルートディレクトリー下にあるノードやサーバのシステム情報を取得する場合は、それぞれのノードルートディレクトリーでcollect-local-snapshotサブコマンドを実行してください。
型:String
指定できる値を次に示します。
-
ノードルートディレクトリーの絶対パス
デフォルト値:Application Serverインストールディレクトリー/javaee/glassfish/nodes
-
- --targettype={node|server}
-
システム情報を収集する対象を指定します。
型:String
指定できる値を次に示します。
-
node
--targetnameで指定したノードを構成する全サーバのシステム情報を収集します。
-
server
--targetnameで指定したサーバ(Java EEサーバ、Webサーバ、PRF)のシステム情報を収集します。
デフォルト値:なし
-
- --targetname target-name1[,target-name2]...
-
システム情報を収集するノードまたはサーバの名称を指定します。複数の名称をコンマで区切って記述できます。
型:String
指定できる値を次に示します。
-
ノード名またはサーバ名
デフォルト値:server
-
- --archivefile archive-file
-
システム情報アーカイブファイルの末尾に付く文字列を指定します。文字列の形式を次に示します。
snapshot-info-type-archive-file
info-type:--infotypeオプションの指定値。
archive-file:--archivefileオプションの指定値。
--infotypeオプションに複数の値を指定した場合は、それぞれの指定値に対応するシステム情報アーカイブファイルを作成します。
システム情報アーカイブファイルの出力先ディレクトリーに同じ名前のファイルが存在する場合は、既存のファイルが上書きされます。
型:String
指定できる値を次に示します。
-
システム情報アーカイブファイルの末尾に付く文字列
次の半角文字が使用できます。
英小文字
英大文字
数字
ハイフン
ピリオド
アンダースコア
デフォルト値:domain-name-date-process-id-thread-id.zip
dateの形式は"yyyyMMddHHmmss"。
process-idはcollect-local-snapshotサブコマンドのプロセスIDの16進数表記。
thread-idはcollect-local-snapshotサブコマンドのスレッドIDの16進数表記。
-
- --timeout timeout
-
システム情報の収集を中止してコマンド実行を終了するまでの時間を指定します。
システム情報の収集が中止された場合、システム情報アーカイブファイルの出力先ディレクトリーに生成途中のファイルが残ることがあるため、適宜削除してください。
型:Integer
指定できる値を次に示します。
-
1〜2147483647
デフォルト値:なし(collect-local-snapshotサブコマンドはタイムアウトしない)
-
使用例
次の例では、サーバ名serverのシステム情報を収集します。
asadmin collect-local-snapshot --targettype=server
戻り値
戻り値 |
説明 |
---|---|
0 |
正常終了 |
1 |
異常終了 |
出力形式
このサブコマンドは、--infotypeオプションで指定したシステム情報を収集して、それぞれに対応するシステム情報アーカイブファイルを生成します。
システム情報アーカイブファイルの名称は--archivefileオプションの説明を参照してください。
システム情報アーカイブファイルは、サブコマンドを実行したホストの、次に示すディレクトリーに出力されます。
Application Serverインストールディレクトリー/javaee/snapshot
出力先ディレクトリーの場所や出力先ディレクトリーに生成できるシステム情報アーカイブファイル数は、asadminユーティリティーのsetサブコマンドおよびgetサブコマンドの次のプロパティーで設定および確認できます。
-
hitachi-domain.hitachi-snapshot.output-dir※
-
hitachi-domain.hitachi-snapshot.max-num
-
nodes.node.ノード名.hitachi-node.hitachi-node-snapshot.output-dir※
-
nodes.node.ノード名.hitachi-node.hitachi-node-snapshot.max-num
- 注※
-
アクセス権のないディレクトリーを出力先に指定した場合は、エラーメッセージ(KDKD10211-E)を出力してシステム情報収集処理が中断されます。
プロパティーの詳細は、「setサブコマンドおよびgetサブコマンドで使用するパラメーター一覧」を参照してください。