サーバー・コマンド・オプション

この server コマンドでは、Liberty サーバーの始動、停止、作成、パッケージ化、およびダンプがサポートされます。このトピックでは、server コマンドおよびこのコマンドに相当する実行可能 JAR ファイル ws-server.jar で使用できる、すべての使用可能なオプションおよび出口コードについて説明します。

構文

コマンド構文は次のようになります。

server action serverName [options]

action の値は、Liberty サーバーで実行できる操作を表します。コマンド・プロンプトからの Liberty で使用可能な管理操作を参照してください。

注: コマンド行にサーバーが指定されていない場合、デフォルトのサーバー・インスタンス defaultServer(存在する場合) に対してアクションが実行されます。

オプション

server コマンドで使用可能なオプションは、以下のとおりです。

-- archive=path_to_the_target_archive_file

package または dump操作のターゲット・ファイルを指定します。このパスには、Liberty のインストール・ルート・ディレクトリーを基準にした相対パス、または絶対パスが可能です。デフォルトのアーカイブ・ターゲットは、サーバー名の付いた圧縮ファイルです。これは、インストール・ルート・ディレクトリーに格納されます。値にスペースが含まれる場合は、引用符を使用します。このオプションは、package 操作と dump 操作の両方で使用できます。

IBM i プラットフォームの場合分散: [AIX MacOS Linux Windows] アーカイブ・ファイル名に .jar 拡張子を指定すると、 server コマンドは新しい自己解凍型アーカイブ・ファイルを作成します。このファイルから、 java コマンドを使用して Liberty サーバーをインストールできます。詳しくは、製品資料の「 Java アーカイブ・ファイルの解凍による Liberty のインストール」を参照してください。 .jar 拡張機能は、 z/OS® プラットフォームでは使用できません。

--clean

指定したサーバー・インスタンスに関連するパーシスタント・キャッシュ情報をすべて除去します。これには、OSGi リゾルバー・メタデータおよびパーシスタント OSGi バンドル・データが含まれます。このオプションを使用した場合、サーバーは次の始動時にキャッシュ・データをすべて再計算する必要があります。これには、キャッシュ・データを再使用できる場合の再始動より、時間がかかることがあります。

注: このオプションは、通常の操作には必要ありません。 IBM® サービスが、暫定修正の提供時やキャッシュ・データの問題が疑われる場合に、このオプションの使用をお客様に求めることがあります。製品拡張を開発中に、 OSGi マニフェストを更新しているか、パーシスタント OSGi バンドル・データを消去する予定がある場合にも、このオプションが必要なことがあります。

-- 包含 =package_option

パッケージ化するファイルを指定します。ここで、package_option には、以下のいずれかの値が可能です。

all は、Liberty のインストール・ディレクトリー内のすべてのファイルをパッケージ化することを指定します。 ${WLP_USER_DIR} および ${WLP_OUTPUT_DIR} が server.env ファイルに定義されている場合、それらの下のファイルがパッケージ化されます。この値は、package 操作にのみ適用されます。
usr は、${WLP_USER_DIR} ディレクトリー内のファイルをパッケージ化することを指定します。この値は、package 操作にのみ適用されます。
minify は、ランタイム環境のパーツと ${WLP_USER_DIR} ディレクトリー内のファイルの中で、サーバーの実行に必要なものだけをパッケージ化することを指定します。これにより、生成されるアーカイブのサイズを最小限にすることができます。この値は、package 操作にのみ適用されます。

-- 包含 =diagnose_option,diagnose_option,...

取り込む診断情報のタイプを指定します。 --include の値はコンマ区切りリストで、以下のどの値でも指定できます。

heap は、メモリーの過剰消費およびメモリー・リークの診断に役立てるために使用されます。これは、メモリー内のライブ・オブジェクトおよびオブジェクト間の参照を示します。 IBM J9 仮想マシンでは、結果のファイルの名前は heapdump.date.time.processID.sequenceNumber.phdになります。 HotSpot 仮想マシンでは、結果ファイルの名前は java.date.time.processID.sequenceNumber.hprof. です。この値は、 dump 操作と javadump 操作の両方に適用されます。
system も、メモリーの過剰消費およびメモリー・リークの診断に役立てるために使用されますが、仮想マシン内の障害を検出するためにも役立ちます。これらのダンプは、 IBM J9 仮想マシンでのみサポートされます。結果のファイルの名前は、core.date.time.processID.sequenceNumber.dmp です。この値は、dump 操作と javadump 操作の両方に適用されます。
thread は、ハング・スレッド、デッドロックの診断に役立てるために使用され、過剰 CPU の問題の診断に使用されることもあります。これらのダンプは、常に server javadump コマンドを使用して作成されます。 IBM J9 仮想マシンでは、結果のファイルの名前は javacore.date.time.processID.sequenceNumber.txtになります。 HotSpot 仮想マシンでは、結果ファイルの名前は javadump.date.time.processID.sequenceNumber.txt. です。この値は、 dump 操作にも適用できます。
注: スレッド・ダンプ・タイプは、サーバーが Java™ SDK で実行されている場合にのみサポートされます。サーバーが JRE を使用して始動されている場合は、エラーが報告され、サーバーでこのダンプ・タイプがサポートされないことが示されます。この制限は、 HotSpot 仮想マシンにのみ適用されます。スレッド Java ダンプ・タイプは、すべての IBM JVM (JRE または SDK) でサポートされます。

-- OS =os_value,os_value,...

パッケージ化されたサーバーでサポートするオペレーティング・システムを指定します。コンマ区切りリストを指定します。デフォルト値は any で、ソースでサポートされるどのオペレーティング・システムにもサーバーをデプロイできることを示します。

オペレーティング・システムがサポートされないことを指定するには、その前に負符号 (-) を付けます。オペレーティング・システム値のリストについては、OSGi Alliance の Web サイト ( https://www.osgi.org/developer/specifications/reference/#os) を参照してください。

このオプションは、package 操作にのみ適用され、 --include=minify オプションと一緒にのみ使用できます。あるオペレーティング・システムを除外すると、その後、アーカイブに対して minify 操作を再度実行する場合にそれを組み込むことはできません。

-- ターゲット =pausable_component,pausable_component,...

一時停止できる特定のコンポーネントのコンマ区切りリストを指定します。 target オプションを指定すると、リストされたコンポーネントだけが一時停止または再開されます。ターゲット値の例のリストについては、コマンド行からの Liberty サーバーの一時停止と再開を参照してください。

サーバー・プロセス

サーバー・プロセスは、server.env ファイルで指定された環境変数を使用して作成されます。デフォルトで以下の JVM オプションが追加されます。

-javaagent:wlp/bin/tools/ws-javaagent.jar オプションは、トレース、モニター、アプリケーションのインクリメンタル公開、その他のサーバー機能に必要です。
-Xshareclasses および関連するオプションは、サポートされる IBM J9 仮想マシン上で共有クラス・キャッシュを使用可能にします。キャッシュ・ディレクトリーは WLP_OUTPUT_DIR/.classCache に設定されます。
-XX:MaxPermSize オプションは、Java 8 より前の HotSpot 仮想マシンの永続世代のサイズを増やします。 WLP_SKIP_MAXPERMSIZE 環境変数を true に設定すると、このデフォルト・オプションを回避できます。これにより、以下のような警告が回避されます。
```
Java HotSpot(TM) Client VM warning: ignoring option MaxPermSize=256m; support was removed in 8.0
```
-Djava.awt.headless=true オプションは、すべてのプラットフォームで java.awt.HeadlessException を回避し、 macOSでの問題のスチーリングに重点を置きます。

jvm.options ファイルを使用して、これらのデフォルト JVM オプションをオーバーライドすることや、JVM オプションを追加することができます。 server.env ファイルおよび jvm.options ファイルについて詳しくは、 Liberty 環境のカスタマイズを参照してください。

デフォルトでは、 server コマンドは、コマンドがアクションを実行する前に Other ユーザーに対してすべての許可を拒否するように umask 値を設定します。 server.env ファイルで WLP_SKIP_UMASK 環境変数を true に設定して、サーバー・コマンドが umask を変更しないようにすることができます。 WLP_SKIP_UMASK 環境変数を設定すると、サーバーは、オペレーションの基礎となるプロセスから umask を使用します。 z/OSでは、以下のいずれかの方法で WLP_SKIP_UMASK プロパティーを指定できます。

server.env ファイルを使用します。
あるいは、 z/OS プロシージャーを使用してサーバーを始動する場合は、 STDENDV DD エントリーを使用してプロパティーを指定できます。

サーバー・プロセスの現行作業ディレクトリーは、サーバー出力ディレクトリーに設定されます。

UNIX プラットフォームの場合 z/OS プラットフォームの場合 IBM i プラットフォームの場合 server コマンドは、サーバーの始動時にプロセス ID (PID) ファイルを作成し、サーバーの停止時に PID ファイルを削除します。デフォルトでは、PID ファイルは、WLP_OUTPUT_DIR/.pid/serverName.pid に設定されます。 PID_FILE 環境変数を設定することで、PID ファイルの絶対パスを変更できます。また、PID_DIR 環境変数を設定することで、PID ディレクトリーの絶対パスを変更できます。

サーバー・プロセスからの標準出力とエラーは、 run アクションと debug アクションを使用するとフォアグラウンド・コンソールに出力され、 start アクションを使用するとデフォルトで WLP_OUTPUT_DIR/serverName/logs/console.log ファイルにリダイレクトされます。ログ名は LOG_FILE 環境変数の設定によって、ログ・ディレクトリーは LOG_DIR 環境変数の設定によって変更することができます。ロギング構成について詳しくは、ロギングおよびトレースを参照してください。

stop アクションにより、新規アプリケーション要求をサーバーに入力できなくなるため、既存の要求に完了するための時間が与えられます。その時間の後、残りのサーバー・コンポーネントが停止され、サーバー・プロセスが終了します。与えられた時間内に完了しなかったアプリケーション要求は失敗しますが、その正確な動作は、サーバー・コンポーネントの停止時のそのアクティビティーによって異なります。

出口コード

server コマンドおよびこのコマンドに相当する実行可能 JAR ファイル ws-server.jar では、以下の出口コードが使用可能です。

0: OK。 0 は、要求された操作が正常に完了したことを示します。サーバー状況の場合、0 は、サーバーが実行されていることを示します。
1: サーバー状況の場合、1 は、サーバーが実行されていないことを示します。他の操作の場合、冗長操作の呼び出しを示します。例えば、始動しているサーバーを始動したり、停止しているサーバーを停止したりした場合です。このコードは、無効な Java オプションが使用された場合に JVM によって返されることもあります。
2: 目的のサーバーは存在しません。
3: サポートされないアクションが、実行中のサーバーで呼び出されました。例えば、パッケージ・アクションが呼び出されたときにサーバーが実行中である場合です。
4: サポートされないアクションが、停止しているサーバーで呼び出されました。例えば、ダンプ・アクションが呼び出されたときにサーバーが実行されていない場合です。
5: 不明なサーバー状況。例えば、workarea ディレクトリーがない場合や、Attach API が機能しない場合です。
>=20: 20 以上の戻りコードは、要求されたアクションの実行中にエラーが発生したことを示します。メッセージが表示され、エラーに関する詳細情報とともにログ・ファイルに取り込まれます。

使用法

以下は、正しい構文の例です。

server run
server start myserver --clean
server package myserver --archive="archivefile.zip" --include=all
server dump myserver --archive="c:\mybackup\myserver.zip" --include=thread
server javadump myserver
server javadump myserver --include=thread,system