jpctool service list

〈このページの構成〉

形式
機能
コマンドを実行できるホスト
実行権限
格納先ディレクトリ
引数
注意事項
形式2で実行する場合の注意事項
戻り値
表示情報
使用例1
使用例2
使用例3
使用例4
出力例

形式

形式1

jpctool service list     -id サービスID
                         [-host ホスト名]
                         [-lhost 論理ホスト名]
                         [-proxy {y|n}]
                         [-stat]
                         [-v]

形式2

jpctool service list     -key サービスキー
                         [-lhost 論理ホスト名]
                         [-proxy {y|n}]
                         [-stat]
                         [-v]

ページの先頭へ

機能

jpctool service listコマンドは，Performance Managementプログラムのサービスの構成および状態を表示するコマンドです。

PFM - ManagerまたはPFM - Baseと，PFM - Web Consoleを同一ホストにインストールしていて，起動・停止の連携設定をしている場合には，形式2でjpctool service listコマンドを実行することでPFM - Web Consoleを含むすべてのPerformance Managementプログラムのサービスの構成および状態を表示できます。PFM - Manager，PFM - Base，PFM - Web Consoleそれぞれの起動・停止の連携設定の詳細については，マニュアル「JP1/Performance Management 運用ガイド」の，Performance Managementの起動と停止について説明している章を参照してください。

ページの先頭へ

コマンドを実行できるホスト

PFM - Manager
PFM - Agent
PFM - RM

ページの先頭へ

実行権限

Windowsの場合: なし
UNIXの場合: なし

ページの先頭へ

格納先ディレクトリ

Windowsの場合: インストール先フォルダ\tools\
UNIXの場合: /opt/jp1pc/tools/

ページの先頭へ

引数

-id サービスID

サービスIDを指定します。1〜258バイトで指定します。

ワイルドカード文字を使用して，複数のサービスIDを指定することもできます。この場合，あるサービスがエラーとなっても，残りのサービスに対して処理が続行されます。また，複数のサービスに対してエラーが発生した場合，最後に発生したエラーに対する戻り値が返されます。

-host ホスト名

サービスの構成および状態を表示するホスト名を指定します。特定のホストで動作するPerformance Managementプログラムのサービスの構成および状態を表示する場合にこの引数を使用します。1〜32バイトの半角英数字で指定します。空白文字は，指定できません。このオプションの指定を省略した場合，ローカルホストが仮定されます。

ワイルドカード文字を使用して，複数のホスト名を指定することもできます。

-lhost 論理ホスト名

形式1

このコマンドを実行するホストを，物理ホスト環境ではなく論理ホスト環境とする場合にその論理ホスト名を指定します。1〜32バイトの半角英数字で指定します。空白文字は，指定できません。指定を省略した場合，物理ホストが仮定されます。ワイルドカード文字は使用できません。
形式2

PFM - Web Consoleを論理ホスト環境で運用している場合に，PFM - Web Consoleの起動ホスト名（論理ホスト名）を指定します。1〜32バイトの半角英数字で指定します。空白文字は，指定できません。指定を省略した場合，物理ホストが仮定されます。ワイルドカード文字は使用できません。

-proxy {y`|`n}

リモートホストのPFM - AgentまたはPFM - RMと直接通信できない環境で，-hostオプションにリモートホストを指定した場合，PFM - Managerを経由するかどうかを指定します。

「y」を指定すると，PFM - Manager経由で通信します。

「n」を指定すると，PFM - Managerを経由しません。

-stat

-host ホスト名で指定したホストのStatus Serverサービスと直接通信を行って状態を表示します。PFM - Managerが停止している時にリモートホストの情報を表示したい場合に指定します。また，リモートホストのStatus Serverサービスの状態も表示します。

このオプションを指定する場合は，-host ホスト名にワイルドカードは使用できません。また，-proxy {y|n}と同時に指定できません。

ステータス管理機能が無効の場合，このオプションは使用できません。

-v

プロダクト名表示機能を有効に設定している場合に，サービス名をプロダクト名で表示します。プロダクト名表示機能の詳細については，マニュアル「JP1/Performance Management 設計・構築ガイド」の，Performance Managementの機能について説明している章を参照してください。

-key サービスキー

構成および状態を表示させたいサービスのサービスキーを指定します。指定できるサービスキーを次に示します。

all：すべてのPerformance Managementプログラムのサービスの構成および状態を表示します。
jp1pc：PFM - Web Consoleのサービスを除くすべてのPerformance Managementプログラムのサービスの構成および状態を表示します。
Managerまたはmgr：PFM - Managerサービス（Action Handlerサービスを除く）の構成および状態を表示します。
AHまたはact：Action Handlerサービスの構成および状態を表示します。
StatSvrまたはstat：Status Serverサービスの構成および状態を表示します。
WebConsoleまたはwc：PFM - Web Consoleのサービスの構成および状態を表示します。

PFM - AgentまたはPFM - RMのサービスのサービスキーについては，マニュアル「JP1/Performance Management 設計・構築ガイド」の付録の，命名規則について説明している個所を参照してください。

ページの先頭へ

注意事項

一度も起動したことがないPerformance Managementプログラムのサービスは，コマンドを実行しても表示されません。また，ホスト名の変更後に一度も起動したことがないサービスも同様に，コマンドを実行しても表示されません。
引数は，引数の説明の記載順に指定してください。指定順が異なると，正しく認識されません。
Name ServerサービスおよびMaster Managerサービスが起動されていないと，ローカルホスト以外のサービスの構成および状態が表示できません。また，-proxyオプションに「y」を指定しても，PFM - Managerは経由しません。
Performance Managementプログラムのサービスの起動直後にjpctool service listコマンドを実行すると，サービスのプロセスが起動中であるにも関わらず，サービスの状態の表示が「Inactive」となることがあります。この場合，そのサービスは起動処理中であるか，またはPFM - Managerとの通信接続待ちのため一時的にスタンドアロンモードとして起動しているかのどちらかの場合が考えられます。PFM - Managerが起動している場合は，しばらく待ってからjpctool service listコマンドでサービスの状態を確認するようにしてください。
PFM - AgentまたはPFM - RMのサービスに対してjpctool service listコマンドを実行した場合，サービスが起動しているにもかかわらず「Inactive」または「Timeout」と表示されることがあります。この場合，PFM - AgentまたはPFM - RMのサービスがパフォーマンスデータを収集中のためビジー状態となっています。

サービスの状態を正しく表示するためには，ステータス管理機能を有効にしてください。ステータス管理機能については，マニュアル「JP1/Performance Management 運用ガイド」の，ステータス管理機能によるサービスの状態確認について説明している章を参照してください。
PFM - Managerをアンインストール後，同じマシンに再インストールすると，jpctool service listコマンドでTrap Generatorサービスが2つ表示されることがあります。この場合，PFM - Managerのサービスを起動し，「Inactive」となっているTrap Generatorサービスをjpctool service deleteコマンドで削除してください。
コマンドの実行をCtrl+Cキーやシグナルで中断した場合，特定の戻り値が返りません。そのため，コマンドをCtrl+Cキーやシグナルで中断した場合は戻り値を無視してください。
-statオプションの指定がない場合は，リモートホストのStatus Serverサービスは表示されません。
ステータス管理機能が無効の場合，Status Serverサービスは表示されません。
次の場合，リモートエージェントおよびグループエージェントの構成および状態は表示されません。
- Master ManagerまたはName Serverサービスが起動していない
- -statオプションを指定している

次のどちらかを実行したあとにサービス情報を削除していない場合，該当サービスがjpctool service listコマンドで表示されることがあります。

PFM - Agent，PFM - RMまたはPFM - Baseのアンインストール
PFM - AgentまたはPFM - RMのインスタンス環境のアンセットアップ

サービスが表示される条件を次の表に示します。

jpctool service listコマンド実行時の条件		サービス情報の削除
表示対象ホスト	-statオプション	未実施	実施済み
ローカルホスト	−	表示されない	表示されない
リモートホスト	指定あり	表示されない	表示されない
リモートホスト	指定なし	表示される	表示されない

（凡例）: −：該当しない

サービス情報を削除したが，該当するサービスのアンインストールまたはインスタンス環境のアンセットアップを実行していない場合，該当サービスがjpctool service listコマンドで表示されることがあります。

サービスが表示される条件を次の表に示します。

jpctool service listコマンド実行時の条件		アンインストール，またはインスタンス環境のアンセットアップ
表示対象ホスト	-statオプション	未実施	実施済み
ローカルホスト	−	表示されない	表示されない
リモートホスト	指定あり	表示されない	表示されない
リモートホスト	指定なし	表示される	表示されない

（凡例）: −：該当しない

PFM - ManagerホストでAgentホストリモート操作制限オプションの設定が有効な環境で，このコマンドをPFM - Agent またはPFM - RMホストで実行する場合，-statオプション指定時を除き，ローカルホスト以外で稼働するサービスの構成および状態は表示できません。-hostオプションでリモートホストを指定して実行すると，エラーになります。
-hostオプションで指定したホストでAgent間直接情報参照抑止オプションの設定が有効な場合，-statオプションを指定してこのコマンドを実行することはできません。
IPの種類が異なるホスト間でこのコマンドを実行する場合，PFM - Managerを経由する必要があります。-proxy yオプションを指定してこのコマンドを実行してください。 -proxy yオプションを指定しないでこのコマンドを実行した場合，「Inactive」と表示されます。
IPの種類が異なるホスト間では，-statオプションを指定してこのコマンドを実行できません。

ページの先頭へ

形式2で実行する場合の注意事項

-keyオプションの引数「サービスキー」に，「all」，「wc」または「WebConsole」以外を指定した場合，PFM - Web Consoleのサービスの構成および状態は表示されません。
-hostオプションを指定してリモートホストのサービスの構成および状態を表示することはできません。

ページの先頭へ

戻り値

0	正常終了した。
1	引数の指定に誤りがある。
3	指定されたサービスが登録されていない。
100	Performance Managementの環境が不正である。
101	Name Serverサービスが起動していない。
102	指定された論理ホスト名はセットアップされていない。
200	メモリーが不足している。
210	ディスク容量が不足している。
211	ファイルまたはディレクトリにアクセスできない。
220	サービス構成情報ファイルに指定しているホスト名が不正である。
222	通信処理でエラーが発生した。
255	予期しないエラーが発生した。

ページの先頭へ

表示情報

jpctool service listコマンドを実行して表示される情報について次の表に示します。

出力情報	説明
Host Name	サービスが稼働しているホスト名を示す。
ServiceID^※1	サービスIDを示す。プロダクト名表示機能が有効な場合も，プロダクト名では表示されない。形式2で実行した場合，PFM - Web Consoleのサービス情報の出力行では表示されない。
Service Name^※1	サービス名を示す。プロダクト名表示機能が有効な場合も，プロダクト名では表示されない。形式2で実行した場合，PFM - Web Consoleのサービス情報では固定で「Web Console」が表示される。
Service^※2	サービス名を示す。サービスIDがプロダクト名で表示される。
PID	サービスのプロセスIDを示す。ステータス管理機能が有効の場合 StatusがActive，Busy，S Active，S Busy，Starting，およびStoppingの場合に表示される。ステータス管理機能が無効，またはステータス管理機能をサポートしていないバージョンの場合 StatusがActiveの場合だけ表示される。形式2で実行した場合，PFM - Web Consoleのサービス情報の出力行では表示されない。
Port	サービスが使用している通信ポート番号を示す。 PFM - Web Console以外のサービスの場合ステータス管理機能が有効の場合 StatusがActive，Busy，S Active，およびS Busyの場合に表示される。ステータス管理機能が無効，またはステータス管理機能をサポートしていないバージョンの場合 StatusがActiveの場合だけ表示される。 PFM - Web Consoleの場合 StatusがActiveの場合「−」が表示される。 StatusがActive以外の場合表示されない。
Status	サービスの状態を示す。ステータス管理機能が有効の場合ステータス管理機能をサポートしているバージョンのサービスの状態表示 Active：要求待ち状態を示す。 Inactive：停止状態を示す。 Starting：起動処理中を示す。 Busy：要求処理中を示す。 S Active：要求待ち状態を示す。スタンドアロンモード。 S Busy：要求処理中を示す。スタンドアロンモード。 Stopping：停止処理中を示す。ステータス管理機能をサポートしていないバージョンのサービスの状態表示 Active：稼働状態を示す。 Incomp：起動または停止処理中を示す。 Inactive：通信接続できない状態または停止状態を示す。 Comm Err：通信接続できるが無応答状態を示す。 Timeout：通信接続がタイムアウトしたことを示す。 Error：通信接続タイムアウト以外のエラーが発生したことを示す。エラーの詳細については，共通メッセージログを参照のこと。ただし，次の場合，ステータス管理機能をサポートしているバージョンのサービスであっても，サポートしていないバージョンの場合と同じ表示になります。・Status Serverサービスが停止している・Status Serverサービスは起動しているが，ステータス管理機能がサービスの状態を正しく認識できない^※3 ステータス管理機能が無効，またはステータス管理機能をサポートしていないバージョンの場合 Active：稼働状態を示す。 Inactive：通信接続できない状態または停止状態を示す。 Comm Err：通信接続できるが無応答状態を示す。 Timeout：通信接続がタイムアウトしたことを示す。 Error：通信接続タイムアウト以外のエラーが発生したことを示す。エラーの詳細については，共通メッセージログを参照のこと。

注※1: -vオプションを指定しないときに表示されます。
注※2: -vオプションを指定したときに表示されます。
注※3: サービスの状態を正しく認識させるには，サービスの再起動が必要です。

ページの先頭へ