jpcconf agent setup
- 〈このページの構成〉
形式
形式1
jpcconf agent setup -key サービスキー [-noquery]
形式2
jpcconf agent setup -key サービスキー [-register]
形式3
jpcconf agent setup -key サービスキー [-unregister]
機能
jpcconf agent setupコマンドは,Performance Managementシステムに対して,新しくPFM - AgentまたはPFM - RMを追加するコマンドです。PFM - AgentまたはPFM - RMの情報をPFM - ManagerやPFM - Baseに登録します。
PFM - Managerに登録されている場合には,このコマンドの実行は不要です。登録されていない場合には,このコマンドにより手動登録をしてください。
手動登録の要否については次の条件を確認してください。
次の条件をすべて満たす場合に,このコマンドを実行して手動登録してください。
-
インストールするPFM - AgentまたはPFM - RMの製品バージョンがPFM - Managerのリリースノートに記載していないバージョンである。
-
PFM - AgentまたはPFM - RMをPFM - Manager以外のホストにインストールしている。
ただし,PFM - AgentまたはPFM - RMのリリースノートにセットアップコマンドの実行が必要であることが記載されている場合は,このコマンドを実行してください。
PFM - Manager へ新しく登録したPFM - AgentまたはPFM - RMの情報をPFM - Web Consoleに表示させたい場合,新しく登録したPFM - AgentまたはPFM - RMを起動したあと,PFM - Web Consoleにログインした時点で反映されます。
このコマンドは次の場合に実行してください。
- 形式1
-
PFM - AgentまたはPFM - RMをPFM - Managerに登録する場合
- 形式2
-
PFM - AgentまたはPFM - RMを起動しないで,PFM - AgentまたはPFM - RMの情報をPFM - Managerに登録し,PFM - Web Consoleに表示させる場合
- 形式3
-
PFM - Web Consoleのアラーム階層およびレポート階層で,製品の情報を非表示にする場合
PFM - Managerに論理ホストの設定がされている場合,設定されている論理ホストおよび物理ホストに対して,新規PFM - AgentまたはPFM - RMの情報が登録されます。
コマンドを実行できるホスト
- 形式1
-
-
PFM - Manager
-
PFM - Agent
-
PFM - RM
-
- 形式2および形式3
-
PFM - Manager
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー(WindowsのUAC機能が有効な場合は管理者コンソールから実行)
- UNIXの場合
-
rootユーザー権限を持つユーザー
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pc/tools/
引数
-key サービスキー
追加セットアップを実行したい新規PFM - AgentまたはPFM - RMのサービスキーを指定します。なお,プロダクト名表示機能が有効な場合はプロダクト名でも指定できます。
ただし,jpcconf agent setupコマンドを実行するホストにインストールしているPFM - Managerに対して,PFM - Managerのリリースノートの付録「JP1/PFM - Managerに含まれるJP1/PFM - Agentの登録情報」に記載されていない製品のセットアップを実行する場合,プロダクト名ではなく,サービスキーを指定してください。
-
形式1
ここで指定できるサービスキーは,次のディレクトリにセットアップファイルをコピー済みのPFM - AgentまたはPFM - RMのサービスキーだけです。
-
Windowsの場合:インストール先フォルダ\setup\
-
UNIXの場合:/opt/jp1pc/setup/
セットアップファイルについては,各PFM - AgentまたはPFM - RMマニュアルの,インストールとセットアップについて説明している章を参照してください。
サービスキーにallを指定した場合,このディレクトリにコピーされているすべてのセットアップファイルに対してセットアップを実行します。
-
-
形式2
形式1と異なり,セットアップファイルをコピーする必要はありません。サービスキーにallは指定できません。
-register
サービスキーで指定したPFM - AgentまたはPFM - RMをPFM - Web Consoleに表示します。PFM - Managerがクラスタシステムで運用されている場合は,実行系ノードだけで実行できます。
-noquery
このオプションを指定すると,コマンドの実行を中断する問い合わせメッセージが出力されなくなり,ユーザーの応答が不要になります。非対話形式で実行したい場合に指定します。
なお,起動中のPerformance Managementサービスがあった場合は,KAVE05143-Eメッセージが出力され,コマンドの実行が中断されます。ローカルホスト上で起動しているすべてのPerformance Managementサービスを停止して,コマンドを再度実行してください。
-unregister
サービスキーで指定したPFM - AgentまたはPFM - RMをPFM - Web Consoleで非表示にします。PFM - Managerがクラスタシステムで運用されている場合は,実行系ノードだけで実行できます。サービスが残っている場合は,PFM - Managerの再起動後にPFM - Web Consoleにログインすると更新されます。
注意事項
-
このコマンドの実行時のログ情報は,セットアップ先が論理ホスト上であっても,物理ホストの共通メッセージログに出力されます。
-
コマンドの実行をCtrl+Cキーやシグナルで中断した場合,特定の戻り値が返りません。そのため,コマンドをCtrl+Cキーやシグナルで中断した場合は戻り値を無視してください。
-
このコマンドの実行時にPFM - Web Consoleにログインしている場合は,再ログインしてください。
形式1で実行する場合の注意事項
-
このコマンドを実行する前に,新しく情報を登録したいPFM - AgentまたはPFM - RMのセットアップファイルを,実行ホストの次のディレクトリにコピーしておいてください。
-
Windowsの場合:インストール先フォルダ\setup\
-
UNIXの場合:/opt/jp1pc/setup/
新規PFM - AgentまたはPFM - RMをインストールしたホストとは別のホストで新規PFM - AgentまたはPFM - RMの追加セットアップを実行する場合,あらかじめ新規PFM - AgentまたはPFM - RMのセットアップファイルを実行ホストのこれらのディレクトリにコピーしてください。WindowsホストとUNIXホスト間でFTPを使用して,コピー(ファイル転送)する場合は,バイナリーモードを使用してください。
-
-
このコマンドを実行する前に,ローカルホスト上で起動しているすべてのPerformance Managementサービスを停止させてください。サービスを停止させないでこのコマンドを実行しても,コマンドがサービスを停止しますが,完全にサービスを停止できなかった場合,コマンドはエラーとなります。このときは,サービスが完全に停止したことを確認したあと,コマンドを再実行してください。
また,このコマンドで物理ホスト上のPerformance Managementプログラムのサービスを停止した場合,コマンドの処理が終わったあと,次に示す方法で物理ホストのPerformance Managementプログラムのサービスを手動で再起動してください。
-
CentOS 7,Linux 7,Oracle Linux 7,またはSUSE Linux 12以降の環境の場合
サービスの自動起動と自動停止の両方を有効に設定しているときは,サービスの自動停止を有効にするために,systemctl stop jp1_pcコマンドを実行したあとで,systemctl start jp1_pcコマンドを実行して,サービスを起動してください。
上記以外の設定のときは,jpcspmコマンドを使用してサービスを起動してください。
-
上記以外の環境の場合
jpcspmコマンドを使用してサービスを起動してください。
サービスの起動状態を確認するには,jpctool service listコマンドを実行してください。
-
-
すでにPFM - ManagerがサポートしているPFM - AgentまたはPFM - RMをセットアップしようとすると,KAVE05944-Wメッセージが出力され,PFM - Managerへのセットアップがスキップされます。この場合,PFM - Managerへのセットアップは必要ありません。
形式2および形式3で実行する場合の注意事項
-
Performance Managementサービスを停止させる必要はありません。
-
次の場合,形式2では登録できません。形式1でセットアップしてください。
-
インストールするPFM - AgentまたはPFM - RMの製品バージョンがPFM - Managerのリリースノートに記載していないバージョンである。
-
PFM - AgentまたはPFM - RMをPFM - Manager以外のホストにインストールしている。
-
-
PFM - Managerホスト以外では実行できません。
戻り値
0 |
正常終了した。 |
1 |
引数の指定に誤りがある。 |
2 |
コマンドの実行権限がない。 |
4 |
ローカルホスト上のサービスが停止されていない。 |
10 |
コマンドはほかのセッションで実行中である。 |
11 |
ユーザーによって処理が中止された(問い合わせに対して「N」を返した場合)。 |
100 |
Performance Managementの環境が不正である。 |
101 |
ポート番号が取得できない。 |
200 |
メモリーが不足している。 |
210 |
ディスク容量が不足している。 |
211 |
ファイルまたはディレクトリにアクセスできない。 |
222 |
通信処理でエラーが発生した(IPアドレスが取得できない)。 |
230 |
内部コマンドの実行に失敗した。 |
255 |
予期しないエラーが発生した。 |
使用例1
PFM - Managerより後でリリースされたPFM - Agent for Oracleのセットアップを実行する場合のコマンド実行例を次に示します。
jpcconf agent setup -key Oracle
使用例2
新規に追加したPFM - Agent for Oracleの情報を起動前にPFM - Web Consoleに表示させる場合のコマンド実行例を次に示します。
jpcconf agent setup -key Oracle -register
使用例3
PFM - Agent for Oracleの情報をPFM - Web Consoleで非表示にする場合のコマンド実行例を次に示します。
jpcconf agent setup -key Oracle -unregister