[Linux][Windows]

WASService コマンド

WASService コマンド・ライン・ツールを使用すると、 Linux® および Windows オペレーティング・システム上で製品の Java™ プロセス用のサービスを作成できます。

WebSphere® Application Server Java プロセス用のサービスを作成できます。 潜在的なサービスには、以下のサーバー・プロセスが含まれます。
  • アプリケーション・サーバー・ノードでのデフォルトの server1 プロセス
  • アプリケーション・サーバー・ノードで作成するアプリケーション・サーバー・プロセス
  • デプロイメント・マネージャー・セルの一部であるアプリケー ション・サーバー・ノード上の nodeagent プロセス。
  • デプロイメント・マネージャー・プロセス、dmgr
[Windows]注: 統合ノードまたは管理対象ノードの一部であるアプリケーション・サーバーを Windows サービスとして追加しないでください。 フェデレーテッド・ノードを管理するにはノード・エージェントを使用してください。
トラブルの回避: WASService コマンドの代わりに、 WASServiceHelper ユーティリティーを使用することができます。このユーティリティーは、 WASService コマンドを補完し、構成エラーの可能性を減らします。 詳しくは、WASServiceHelper を使用した Windows サービスの作成に関する資料を参照してください。
[Windows] Microsoft Windows オペレーティング・システムでこの機能をセットアップして実行するには、ユーザーが管理者グループに属していて、以下の拡張ユーザー権限を持っている必要があります。
  • オペレーティング・システムの一部として機能
  • サービスとしてログオンする

コマンド・ファイルのロケーション

[Linux] wasservice.sh コマンド・ファイルは、 app_server_root\bin ディレクトリーにあります。

[Windows] WASService.exe コマンド・ファイルは、 app_server_root\bin ディレクトリーにあります。

コマンド構文

既存のサービスを開始するコマンド構文

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

[Linux]
wasservice.sh -start service_name [optional startServer.bat parameters] 
[Windows]
WASService.exe -start service_name [optional startServer.bat parameters] 

サービスの作成または既存のサービスの更新を行う コマンド構文

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

[Linux]
wasservice.sh -add service_name
   -serverName server_name
   -profilePath server_profile_directory
   [-wasHome app_server_root]
   [-startArgs additional_start_arguments]
   [-stopArgs additional_stop_arguments]
   [-userid user_id -password password]
        
[Linux]注: WebSphere Application Server バージョン 7.0 以降のバージョンの場合、 wasservice.shを指定するときにユーザー ID の接頭部として「@」記号を使用しないでください。 wasservice.sh のユーザー ID で接頭部として「@」記号を使用できるのは、 WebSphere Application Server バージョン 6.1 の場合のみです。

バージョン 7.0 以降では、-userid @myuser を使用して wasservice.sh を指定してはなりません。

[Windows]
WASService.exe -add service_name
   -serverName server_name
   -profilePath server_profile_directory
   [-wasHome app_server_root]
   [-configRoot configuration_repository_directory]
   [-startArgs additional_start_arguments]
   [-stopArgs additional_stop_arguments]
   [-userid user_id -password password]
   [-logFile service_log_file]
   [-logRoot server_log_directory]
   [-restart true | false]
   [-startType automatic | manual | disabled]
      
問題の回避: -logroot パラメーターはオプションですが、このオプション・パラメーターを含めることをお勧めします。 場合によっては、このオプション・パラメーターを指定しないと、アプリケーション・サーバーが -logroot パラメーターを使用してサービスの作成を試行していることを示すエラーがイベント・ログに表示される場合があります。

サービスを削除するコマンド構文

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

[Linux]
wasservice.sh -remove service_name
[Windows]
WASService.exe -remove service_name

サービスの実行を停止するコマンド構文

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

[Linux]
wasservice.sh -stop service_name [optional stopServer.bat parameters]
[Windows]
WASService.exe -stop service_name [optional stopServer.bat parameters]

サービス状況を検索するコマンド構文

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

[Linux]
wasservice.sh -status service_name
[Windows]
WASService.exe -status service_name

必要なパラメーター

このコマンドには、以下のパラメーターが必要です。

-profilePath サーバー・プロファイル・ディレクトリー
このオプションを使用して、サーバー・プロセスを定義するプロファイルのディレクトリー・パスを指定します。
-serverName サーバー名
このオプションを使用して、サービスが制御するサーバーを識別します。

オプション・パラメーター

以下のパラメーターは、このコマンドのオプション・パラメーターです。

-add サービス名
このオプションを使用して、「service_name」という名前のサービスを作成するか、 既存のサービスを更新します。 この構文はどちらの場合も同じです。
-configRoot configuration_repository_directory (Windows のみ)
このオプションを使用して、 WebSphere Application Server 製品のインストール・ルート・ディレクトリーの構成ディレクトリーを識別します。
-encodeParams service_name (Windows のみ)
このオプションを使用して、サービスに -startArgs および -stopArgs を強制的にエンコードさせ、レジストリーの編集によって引数 が判別できないようにします。 引数のないコマンド行に -encodeParams を加えて、-add パラメーターの付いたサービスを作成する場合に、このパラメーターを使用します。
[Windows]または、既存のサービスのパラメーターをエンコードします。
WASService -encodeParams service_name
-logFile service_log_file (Windows のみ)
このオプションを使用して、WASService コマンドがアクティビティーを記録するときに使用する ログ・ファイルを識別します。
トラブルの回避: 必ず、固有のパスを持つ完全修飾名としてサービス・ログ・ファイルを指定してください。 システムに複数インスタンスがある場合、この修飾がないと結果は予測不能となり、WASService はいつ初期化が完了したか判別できません。
-logRoot server_log_directory (Windows のみ)
このオプションを使用して、プロファイルのサーバー・ログ・ディレクトリーを識別します。 WASService コマンドは server_name.pid という名前のファイルを 見つけて、サーバーが稼働しているかどうかを決定します。
-remove サービス名
このオプションを使用して、指定されたサービスを削除します。
-restart true | false (Windows のみ)
このパラメーターを使用して、サービスが失敗した場合に既存のサービスを自動的に再始動するかどうかを指定します。 値を false に設定していると、既存のサービスは自動で始動しません。 デフォルトで、この再始動の動作は true に設定されているため、既存のサービスが失敗すると、そのサービスは自動的に再始動します。
-start service_name [オプションの startServer.bat パラメーター]
このオプションを使用して、既存のサービスを開始します。
-startArgs の additional_start_arguments
このページを使用して、追加のパラメーターを識別します。
-startType automatic | manual | disabled (Windows のみ)
このオプションを使用して、新しいサービスの始動タイプを定義します。 自動始動タイプは、システムが始動したと き、またはサービスが初めて呼び出されたときに自動的に始動します。 オペレーティング・システムがサービスを読み込み、利用できるようにす る前に、手動のサービスを始動する必要があります。 開始タイプを変更する前に使用不可のサービスを始動することはできま せん。 デフォルトでは、このパラメーターの値は manual に設定されます。
-status サービス名
このオプションを使用して、サービスが実行中か、停止しているかなど、 サービスの現在の状況を戻します。
-stop service_name [オプションの stopServer.bat パラメーター]
このオプションを使用して、指定されたサービスを停止します。
-stopArgs の「追加停止」引数
このページを使用して、追加のパラメーターを指定します。
-userid user_id -パスワード password
このオプションを使用して、Windows サービスを実行する特権ユーザー ID とパスワードを指定します。
-wasHome アプリケーション・サーバー・ルート
このオプションを使用して、製品のインストール・ルート・ディレクトリーを識別します。
注: 以下のパラメーターは 「Windows のみ」 のパラメーターです。
  • -configRoot
  • -encodeParams
  • -logFile
  • -logRoot
  • -restart
  • -startType
Linux でエラーのロギングおよびスローを行う代替手段は、 システムの標準の sysvinit を使用して通常の startServer.sh スクリプトを実行する方法です。
注意:
認識されないパラメーターは無視されます。

ウィザードによって作成されるサービスのデフォルト名

プロファイル管理ツール が作成できるサービスの名前は、以下のとおりです。
デプロイメント・マネージャー
IBM WebSphere Application Server V9.x - node_name_of_the_deployment_manager_node
アプリケーション・サーバー
IBM WebSphere Application Server V9.x - node_name_of_the_server1_node
カスタム・プロファイル
ノードを統合し、アプリケーション・サーバーを作成した後、 IBM WebSphere Application Server V9.x - node_name_of_the_managed_nodeという名前のサービスを作成できます。

カスタム・プロファイルを作成した後、ノードを統 合してノード上にノード・エージェント・サーバーを作成する必要がありま す。 デプロイメント・マネージャーの管理コンソールを使用してノード上にアプリケーション・サーバー・プロセスを作成することもできます。 ノード・エージェント・サーバー・プロセス用の Windows サービスを作成できます。

デプロイメント・マネージャー・セルにアプリケーション・サーバー・ノードを追加した後に ノード・エージェント・サーバーも作成されます。 後述するように、ノード・エージェント・サーバー・プロセス用にサービスを作成することができます。

サービス・パネルの表示

サービスを表示するには、コントロール・パネルを開き、「管理ツール」 >「サービス」をクリックします。 情報を表示するにはサービスを選択します。 サービスを右クリックして、「プロパティー」をクリックします。 4 つのタブが情報および機 能を提供します。 例えば、「一般」 タブの「Setup type」フィールドを選択して、 セットアップ・タイプを変更します。

[Windows]

デプロイメント・マネージャー・サービスの作成

この例では、dmgr プロセスを開始する IBM® WebSphere Application Server V9.x - name_of_the_deployment_manager_service というサービスを作成します。

WASService -add name_of_the_deployment_manager_service
   -servername deployment_manager_server_name
   -profilePath profile_root
   -wasHome app_server_root
   -logFile WS_startManager.log
   -logRoot profile_root\logs\deployment_manager_server_name
   -restart true
各部の意味は、次のとおりです。
  • name_of_the_deployment_manager_service は、 サービスに指定したい名前です。
  • deployment_manager_server_name は、 ご使用のサーバーの名前です。

コマンドを入力した後、次の例と 同様のメッセージがコマンド・ウィンドウに表示されます。

Adding Service: name_of_the_deployment_manager_service
   Config Root: profile_root\config
   Server Name: deployment_manager_server_name
   Profile Path: profile_root
   Was Home: app_server_root
   Start Args:
   Restart: 1
IBM WebSphere Application Server V9.x - name_of_the_deployment_manager_service service successfully added.

「スタート」 >「設定」>「コントロール・パネル」>「管理ツール」>「サービス」とクリックして 新しいサービスを操作します。

ノード・エージェント・サービスの作成

この例では、ノード・エージェント・サーバー・プロセスを開始する IBM WebSphere Application Server V9.x - name_of_the_node_agent_service というサービスを作成します。

WASService -add name_of_the_node_agent_service
   -servername node_agent_server_name
   -profilePath profile_root
   -wasHome app_server_root
   -logFile WS_startNode.log
   -logRoot profile_root\logs\node_agent_server_name
   -restart true
各部の意味は、次のとおりです。
  • name_of_the_node_agent_service は、 サービスに指定したい名前です。
  • profile_root は、ファイル・システム上でノード・エージェントがある場所です。
  • node_agent_server_name は、ノード・エージェントの 名前です。

    これは単純に nodeagent にするのが一般的です。

コマンドを入力した後、次の例と 同様のメッセージがコマンド・ウィンドウに表示されます。

Adding Service: name_of_the_node_agent_service
   Config Root: profile_root\config
   Server Name: node_agent_server_name
   Profile Path: profile_root
   Was Home: app_server_root
   Start Args:
   Restart: 1
IBM WebSphere Application Server V9.x - name_of_the_node_agent_service service successfully added.

アプリケーション・サーバー・サービスの作成

この例では、アプリケーション・サーバー・プロセスを開始する IBM WebSphere Application Server V9.x - name_of_the_application_server_service というサービスを作成します。

WASService -add name_of_the_application_server_service
   -servername application_server_name
   -profilePath profile_root
   -wasHome app_server_root
   -logFile WS_startServer.log
   -logRoot profile_root\logs\application_server_name
   -restart true
各部の意味は、次のとおりです。
  • name_of_the_application_server_service は、 サービスに指定したい名前です。
  • application_server_name は、 ご使用のサーバーの名前です。

コマンドを入力した後、次の例と 同様のメッセージがコマンド・ウィンドウに表示されます。

Adding Service: name_of_the_application_server_service
  Config Root: profile_root\config
  Server Name: application_server_name
  Profile Path: profile_root
  Was Home: app_server_root
  Start Args:
  Restart: 1
IBM WebSphere Application Server V9.x - name_of_the_application_server_service service successfully added.

既存のアプリケーション・サーバー・サービスの更新

Windows オペレーティング・システムの場合のこの例では、 IBM WebSphere Application Server V9.x - Server2 Service という既存のサービスを、追加の停止引数、ユーザー名、およびパスワードで更新します。 パラメーターは、Windows サービスがシステムをシャットダウンするために使用するスクリプトに自動的に渡されます。

WASService -add "Server2 Service"
   -servername server2
   -profilePath profile_root
   -logRoot profile_root\logs\server2
   -stopArgs "-username user_name  -password password"
   -encodeParams
[Windows]

Windows サービス作成後のサーバー・プロセスの開始および停止

この Windows オペレーティング・システムの例では、 server1の Windows サービスを作成した後に startServer server1 コマンドまたは stopServer server1 を発行すると、以下の例のようなメッセージが表示されます。

Because server1 is registered to run as a Windows Service, the
request to start this server will be completed by starting the
associated Windows Service.

ノード・エージェント・プロセス用の Windows サービスを作成した後に startNode コマンドまたは stopNode コマンドを発行すると、以下の例のようなメッセージが表示されます。

Because nodeagent is registered to run as a Windows Service, the
request to start or stop this server will be completed by 
starting or stopping the associated Windows Service. Examine 
the log files to view messages related to this command.

デプロイメント・マネージャー用の Windows サービスを作成した後に startManager コマンドまたは stopManager コマンドを発行すると、以下の例のようなメッセージが表示されます。

Because dmgr is registered to run as a Windows Service, the
request to start or stop this server will be completed by 
starting or stopping the associated Windows Service. Examine 
the log files to view messages related to this command.
問題の回避: Windows で WebSphere サービスを作成および削除すると、混乱が生じ、エラーが発生しやすくなります。 エラー診断のヘルプについては、 WASServiceHelper ユーティリティーを使用した WebSphere Application Server 用の Windows サービスの作成に関する情報を参照してください。