jpcconf target setup
- 〈このページの構成〉
形式
形式1
jpcconf target setup -key サービスキー -inst インスタンス名 -target 監視対象名 [-lhost 論理ホスト名] [-input 定義ファイル名] [-noquery]
形式2
jpcconf target setup -key サービスキー -template 定義ファイル名 [-noquery]
機能
jpcconf target setupコマンドは,PFM - RMがインスタンス内で監視する監視対象の作成,および設定を更新するコマンドです。
コマンドを実行できるホスト
-
PFM - Manager(PFM - RMがインストールされたホストだけ実行可能)
-
PFM - RM
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー(WindowsのUAC機能が有効な場合は管理者コンソールから実行)
- UNIXの場合
-
rootユーザー権限を持つユーザー
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pc/tools/
引数
-key サービスキー
監視対象の設定を実施するPFM - RMのサービスキーを指定します。プロダクト名表示機能が有効な場合はプロダクト名でも指定できます。
-inst インスタンス名
監視対象の設定を実施するPFM - RMのインスタンス名を指定します。1〜32バイトの半角英数字で指定します。
-target 監視対象名
PFM - RMがインスタンス内で監視対象を区別するための識別子を指定します。1〜32バイトの半角英数字および"-"で指定します。
新しく監視対象名を作成する場合は,対象となるPFM - RMのインスタンス内で,ほかと重複しない名前を指定してください。"-"から始まる名前およびAllは指定できません。すでに同じ名前がある場合は,設定を更新します。
-lhost 論理ホスト名
このコマンドを実行するホストの論理ホスト名を指定します。1〜32バイトの半角英数字で指定します。空白文字は,指定できません。指定を省略した場合,物理ホストが仮定されます。ワイルドカード文字は使用できません。
-noquery
このオプションを指定すると,コマンドの実行を中断する問い合わせメッセージが出力されなくなり,ユーザーの応答が不要になります。
このコマンドを非対話形式で実行するには,このオプションと-inputオプションを同時に指定します。
なお,コマンド実行時は次のように動作します。
-
すでにある監視対象を指定した場合
KAVE05405-Iメッセージが出力され,監視対象の設定が更新されます。
-
-templateで指定したファイルと同名のファイルがある場合
KAVE05399-Iメッセージが出力され,ファイルが更新されます。
-input 定義ファイル名
監視対象の設定値を定義ファイルから読み込む場合に指定します。1〜250バイトで指定します。指定した定義ファイルの内容で,監視対象を自動的に作成または更新します。
指定したファイルパスに空白が含まれる場合は「"」で囲んで指定してください。
このコマンドを非対話形式で実行するには,このオプションと-noqueryオプションを同時に指定します。
-template 定義ファイル名
定義ファイルのテンプレートを出力する場合に指定します。1〜245バイトで指定します。対象とするPFM - RMの設定項目に合わせて,セクションおよびラベルが記載された定義ファイルが出力されます。なお,[Target Definitions]セクションのラベルに対応する値は,空白のままです。出力した定義ファイルは,環境に応じて編集した上で,-inputオプション指定時の入力ファイルとして使用できます。
指定したファイルパスに空白が含まれる場合は「"」で囲んで指定してください。
定義ファイルの形式(jpcconf target setupコマンド)
定義ファイルはテキスト形式のファイルです。次に示すセクションおよびラベルで構成されます。ラベルの設定値は,ラベル名の後ろの「=」に続けて指定します。
各セクションおよびラベルは省略できません。また,設定値を記載しない場合,値が指定されていないものと見なされます。不正なセクション名およびラベル名を指定した場合,該当するセクションおよびラベルは無視されます。
- [Common Definitions]セクション
-
定義ファイルの基本情報を指定するセクションです。
- Definition File Versionラベル
-
定義ファイルのバージョンを指定するラベルです。固定で「0001」を指定してください。
- [Product Information]セクション
-
対象とするPFM - RMを指定するセクションです。
- Product IDラベル
-
対象とするPFM - RMのプロダクトIDを指定するラベルです。プロダクトIDについては,各PFM - RMマニュアルの付録の,識別子について説明している個所を参照してください。
- [Target Definitions]セクション
-
監視対象の設定値を指定するセクションです。
- Target Hostラベル
-
監視対象のホスト名を指定するラベルです。
- プロダクト固有ラベル
-
対象とするPFM - RMに固有の監視対象の設定項目を指定するラベルです。指定できるラベルについては,各PFM - RMマニュアルの,インストールとセットアップについて説明している章を参照してください。なお,パスワードなどの設定項目の場合,対話形式での実行時に2回入力を求められることがありますが,ラベルは1回だけ指定してください。
定義ファイルの記述例を次に示します。
[Common Definitions] Definition File Version=0001 [Product Information] Product ID=7 [Target Definitions] Target Host=hostname User=Administrator Password=aaa :
注意事項
-
jpcconf target setupコマンドを実行する場合は,実行ホスト上のPFM - ManagerまたはPFM - Baseのバージョンが09-00以降である必要があります。
-
論理ホスト環境で動作するPFM - RMの監視対象の設定を実施する場合,待機系ノードでは実行できません。
-
最大監視対象数は,PFM - RMによって異なります。最大監視対象数に達した状態で監視対象を追加しようとすると,KAVE05397-Eメッセージが出力されます。お使いのPFM - RMの最大監視対象数については,各PFM - RMマニュアルを参照してください。
-
定義ファイルにパスワードなどの秘匿情報が含まれる場合,定義ファイルはセキュリティを確保した安全な場所に保存し,使用後は削除してください。また,定義ファイルをホスト間で転送したいときには,SFTP(SSHトンネル経由のFTP)など,盗聴のおそれがない安全な方法を使用することをお勧めします。
-
-inputオプションを指定した場合,定義ファイルに必要なラベルがないとき,または必要なラベルの値が不正なときは,コマンドの実行が中断されます。-noqueryオプションを同時に指定して,バッチまたはスクリプトファイルなどで処理を自動化したい場合は,定義ファイルの内容が正しいことをあらかじめ確認してください。また,コマンドが正常終了したかどうかは,出力されるメッセージまたは戻り値で確認してください。
戻り値
0 |
正常終了した。 |
1 |
引数の指定に誤りがある。 |
2 |
コマンドの実行権限がない。 |
5 |
指定されたサービスキーがない。 |
6 |
定義ファイルの内容に誤りがある。 |
10 |
コマンドが実行中である。 |
11 |
ユーザーによって処理が中止された。 |
100 |
Performance Managementの環境が不正である。 |
102 |
指定された論理ホスト名はセットアップされていない。 |
109 |
PFM - RMへの監視対象の設定の通知に失敗した。 |
200 |
メモリーが不足している。 |
210 |
ディスク容量が不足している。 |
211 |
ファイルまたはディレクトリにアクセスできない。 |
230 |
内部コマンドの実行に失敗した。 |
255 |
予期しないエラーが発生した。 |
使用例
PFM - RM for Platformのインスタンスinst1に,新規に監視対象targetname1を追加する場合のコマンド実行例を次に示します。
jpcconf target setup -key RMPlatform -inst inst1 -target targetname1
非対話形式のコマンドの運用例
-noqueryオプション,-inputオプション,および-templateオプションを使用することで,Performance Managementからの問い合わせを抑止した状態でセットアップを実行できます。運用例を次に示します。
運用例1
PFM - RM for Platformの定義ファイルのテンプレートをRMPlatformTemplate.txtに出力する例を次に示します。
# jpcconf target setup -key RMPlatform -template RMPlatformTemplate.txt
運用例2
PFM - RM for Platformに,新しい監視対象としてtarget01〜target03を自動的に作成する例を次に示します。
なお,ここでは運用例1で出力したRMPlatformTemplate.txtをそれぞれのインスタンス環境に合わせて編集した,RMPlatformTarget01〜03.txtをあらかじめ用意しているものとします。
# jpcconf target setup -key RMPlatform -inst inst01 -target target01 -input RMPlatformTarget01.txt -noquery # jpcconf target setup -key RMPlatform -inst inst01 -target target02 -input RMPlatformTarget02.txt -noquery # jpcconf target setup -key RMPlatform -inst inst01 -target target03 -input RMPlatformTarget03.txt -noquery