jpcconf inst setup
- 〈このページの構成〉
形式
形式1
jpcconf inst setup -key サービスキー [-lhost 論理ホスト名] -inst インスタンス名 [-input 定義ファイル名] [-noquery]
形式2
jpcconf inst setup -key サービスキー -template 定義ファイル名 [-noquery]
機能
jpcconf inst setupコマンドは,1つのホスト上で複数のサービスのセットを起動できるPFM - AgentまたはPFM - RMのインスタンス環境を作成および更新するコマンドです。インスタンス起動できるPFM - AgentまたはPFM - RMの場合,必ず実行してください。
このコマンドを実行すると,インスタンス環境の設定ファイルなどが格納された次のディレクトリを作成または更新します。
-
Windowsの場合
-
インストール先フォルダ\xxxx※\agent\インスタンス名\
-
インストール先フォルダ\xxxx※\store\インスタンス名\
-
-
UNIXの場合
-
/opt/jp1pc/xxxx※/store/インスタンス名/
-
/opt/jp1pc/xxxx※/agent/インスタンス名/
-
- 注※
-
「xxxx」は,各PFM - AgentまたはPFM - RMのサービスキーを示します。サービスキーについては,マニュアル「JP1/Performance Management 設計・構築ガイド」の付録の,命名規則について説明している個所を参照してください。
コマンドを実行できるホスト
-
PFM - Agent
-
PFM - RM
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー
- UNIXの場合
-
rootユーザー権限を持つユーザー
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pc/tools/
引数
-key サービスキー
実行環境を作成または更新したいPFM - AgentまたはPFM - RMのサービスのサービスキー名を指定します。プロダクト名表示機能が有効な場合はプロダクト名でも指定できます。指定できるサービスキーは,インスタンス環境を持つPFM - AgentまたはPFM - RMのサービスキーだけです。PFM - AgentまたはPFM - RMのサービスのサービスキーについては,マニュアル「JP1/Performance Management 設計・構築ガイド」の付録の,命名規則について説明している個所を参照してください。
-lhost 論理ホスト名
インスタンス環境を追加する論理ホストのホスト名を指定します。
1〜32バイトの半角英数字で指定します。半角空白文字および"."は指定できません。
論理ホスト名に,"localhost",IPアドレス,"-"から始まるホスト名は指定できません。
-inst インスタンス名
実行環境を作成または更新するインスタンス名を指定します。1〜32バイトの半角英数字で指定します。
-noquery
このオプションを指定すると,コマンドの実行を中断する問い合わせメッセージが出力されなくなり,ユーザーの応答が不要になります。
このコマンドを非対話形式で実行するには,このオプションと-inputオプションを同時に指定します。
なお,コマンド実行時は次のように動作します。
-
対象とするPFM - AgentまたはPFM - RMサービスが起動中の場合
KAVE05143-Eメッセージが出力され,サービスを停止しないで終了します。サービスを停止してコマンドを再度実行してください。
-
すでにあるインスタンス環境を指定した場合
KAVE05407-Iメッセージが出力され,インスタンス環境が更新されます。
-
-templateで指定したファイルと同名のファイルがある場合
KAVE05399-Iメッセージが出力され,ファイルが更新されます。
-input 定義ファイル名
インスタンス環境の設定値を定義ファイルから読み込む場合に指定します。1〜250バイトで指定します。指定した定義ファイルの内容で,インスタンス環境を自動的にセットアップまたは更新します。
指定したファイルパスに空白が含まれる場合は「"」で囲んで指定してください。
このコマンドを非対話形式で実行するには,このオプションと-noqueryオプションを同時に指定します。
-template 定義ファイル名
定義ファイルのテンプレートを出力する場合に指定します。1〜245バイトで指定します。対象とするPFM - AgentまたはPFM - RMの設定項目に合わせて,セクションおよびラベルが記載された定義ファイルが出力されます。なお,[Instance Definitions]セクションのラベルに対応する値は,空白のままです。
出力した定義ファイルは,環境に応じて編集した上で,-inputオプション指定時の入力ファイルとして使用できます。
指定したファイルパスに空白が含まれる場合は「"」で囲んで指定してください。
定義ファイルの形式(jpcconf inst setupコマンド)
定義ファイルはテキスト形式のファイルです。次に示すセクションおよびラベルで構成されます。ラベルの設定値は,ラベル名の後ろの「=」に続けて指定します。
各セクションおよびラベルは省略できません。また,設定値を記載しない場合,値が指定されていないものと見なされます。不正なセクション名およびラベル名を指定した場合,該当するセクションおよびラベルは無視されます。
- [Common Definitions]セクション
-
定義ファイルの基本情報を指定するセクションです。
- Definition File Versionラベル
-
定義ファイルのバージョンを指定するラベルです。固定で「0001」を指定してください。
- [Product Information]セクション
-
対象とするPFM - AgentまたはPFM - RMを指定するセクションです。
- Product IDラベル
-
対象とするPFM - AgentまたはPFM - RMのプロダクトIDを指定するラベルです。プロダクトIDについては,各PFM - AgentまたはPFM - RMマニュアルの付録の,識別子について説明している個所を参照してください。
- [Instance Definitions]セクション
-
インスタンス環境の設定値を指定するセクションです。
- Store Versionラベル
-
インスタンス環境のStoreバージョンを指定するラベルです。「1.0」または「2.0」を指定してください。
対象とするPFM - Agentが07-50以前の場合,またはPFM - RMを対象とする場合,このラベルの指定は不要です。指定しても,無視されます。
- プロダクト固有ラベル
-
対象とするPFM - AgentまたはPFM - RMに固有のインスタンス設定項目を指定するラベルです。指定できるラベルについては,各PFM - AgentまたはPFM - RMマニュアルの,インストールとセットアップについて説明している章を参照してください。なお,パスワードなどの設定項目の場合,対話形式での実行時に2回入力を求められることがありますが,ラベルは1回だけ指定してください。
定義ファイルの記述例を次に示します。
[Common Definitions] Definition File Version=0001 [Product Information] Product ID=O [Instance Definitions] Store Version=2.0 oracle_sid=ORCL oracle_home=/home/oracle :
注意事項
-
引数は,「形式」にある順番で指定してください。
-
インスタンス環境の更新時に,指定したインスタンス名のサービスが起動されている場合は,そのサービスを停止してからこのコマンドを実行してください。更新が終わったあと,手動でサービスを起動してください。
-
コマンドの実行をCtrl+Cキーやシグナルで中断した場合,特定の戻り値が返りません。そのため,コマンドをCtrl+Cキーやシグナルで中断した場合は戻り値を無視してください。
-
定義ファイルにパスワードなどの秘匿情報が含まれる場合,定義ファイルはセキュリティを確保した安全な場所に保存し,使用後は削除してください。また,定義ファイルをホスト間で転送したいときには,SFTP(SSHトンネル経由のFTP)など,盗聴のおそれがない安全な方法を使用することをお勧めします。
-
-inputオプションを指定した場合,定義ファイルに必要なラベルがないとき,または必要なラベルの値が不正なときは,コマンドの実行が中断されます。-noqueryオプションを同時に指定して,バッチまたはスクリプトファイルなどで処理を自動化したい場合は,定義ファイルの内容が正しいことをあらかじめ確認してください。また,コマンドが正常終了したかどうかは,出力されるメッセージまたは戻り値で確認してください。
戻り値
0 |
正常終了した。 |
1 |
引数の指定に誤りがある。 |
2 |
コマンドの実行権限がない。 |
4 |
指定されたサービスが停止されていない。 |
5 |
指定されたサービスがインストールされていない。 |
6 |
定義ファイルの内容に誤りがある。 |
10 |
コマンドはほかのセッションで実行中である。 |
11 |
ユーザーによって処理が中止された(問い合わせに対して「N」を返した場合)。 |
100 |
Performance Managementの環境が不正である。 |
101 |
ポート番号が取得できない。 |
102 |
指定された論理ホスト名がセットアップされていない。 |
200 |
メモリーが不足している。 |
210 |
ディスク容量が不足している。 |
211 |
ファイルまたはディレクトリにアクセスできない。 |
222 |
通信処理でエラーが発生した(IPアドレスが取得できない)。 |
230 |
内部コマンドの実行に失敗した。 |
231 |
Windowsサービスの登録に失敗した(Windows版だけ)。 |
255 |
予期しないエラーが発生した。 |
使用例
名前がSDCのインスタンスの実行環境を作成する場合のコマンド実行例を次に示します。
jpcconf inst setup -key Oracle -inst SDC
非対話形式のコマンドの運用例
-noqueryオプション,-inputオプション,および-templateオプションを使用することで,Performance Managementからの問い合わせを抑止した状態でセットアップを実行できます。運用例を次に示します。
運用例1
PFM - Agent for Oracleの定義ファイルのテンプレートをOracleTemplate01.txtに出力する例を次に示します。
# jpcconf inst setup -key Oracle -template OracleTemplate01.txt
運用例2
PFM - Agent for Oracleに,新しいインスタンス環境としてinst01〜inst03を自動的に作成する例を次に示します。
なお,ここでは運用例1で出力したOracleTemplate01.txtをそれぞれのインスタンス環境に合わせて編集した,OracleInst01〜03.txtをあらかじめ用意しているものとします。
# jpcconf inst setup -key Oracle -inst inst01 -input OracleInst01.txt -noquery # jpcconf inst setup -key Oracle -inst inst02 -input OracleInst02.txt -noquery # jpcconf inst setup -key Oracle -inst inst03 -input OracleInst03.txt -noquery