jpcprocdef output
形式
jpcprocdef output -agent サービスID
{-name アプリケーション定義名
[-name アプリケーション定義名]... | -all}
-f 出力ファイル名
[-noquery]
機能
jpcprocdef outputコマンドは，指定したエージェントに定義されているアプリケーション定義の定義情報を，XML形式のアプリケーション定義ファイルに出力するコマンドです。現在の定義情報をコマンドで確認できます。また，出力ファイルはjpcprocdef createコマンドの入力ファイルとして指定できます。
コマンドを実行できるホスト
PFM - Web Console
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー
- UNIXの場合
-
rootユーザー権限を持つユーザー
また，コマンドを実行するためには，事前にPerformance Managementに対する管理ユーザー権限※のユーザーアカウントで認証用のキーファイルを作成する必要があります。詳細については，「jpcmkkey」コマンドを参照してください。
- 注※
-
Performance ManagementユーザーまたはJP1ユーザーが必要とする，Performance Managementに対する実行権限です。
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pcwebcon/tools/
引数
-agent サービスID
アプリケーション定義の定義情報を出力する対象エージェントを，Agent CollectorサービスまたはリモートエージェントのサービスIDで指定します。ワイルドカード文字は使用できません。
指定するサービスIDは，使用している監視エージェントによって次のように異なります。
|
使用している監視エージェント |
指定するサービスID |
|---|---|
|
PFM - Agent for Platform（Windows） |
Agent CollectorサービスのサービスID |
|
PFM - Agent for Platform（UNIX） |
|
|
PFM - RM for Platform |
リモートエージェントのサービスID |
次に示すサービスIDは指定できません。
-
Agent Storeサービス，Remote Monitor Collectorサービス，Remote Monitor StoreサービスおよびグループエージェントのサービスID
-
PFM - Agent for PlatformまたはPFM - RM for Platform以外のプロダクトのサービスID
-name アプリケーション定義名
-agentオプションで指定したエージェントに定義されているアプリケーション定義の中で，出力したい定義情報の定義名を指定します。ワイルドカードは指定できません。
複数のアプリケーション定義を出力する場合は，-nameオプションを複数回続けて指定します。その場合，出力する順番はエージェントに定義されている順番ではなく，-nameオプションで指定した順番となります。-nameオプションで指定したアプリケーション定義がエージェントに定義されていない場合は無視されます。
-all
-agentオプションで指定したエージェントに定義されているアプリケーション定義の定義情報をすべて出力します。出力する順番はエージェントに定義されている順番です。
-f 出力ファイル名
出力先のアプリケーション定義ファイル名を指定します。複数のアプリケーション定義を出力する場合，1つのファイルにまとめて出力します。ファイル名は，相対パスまたは絶対パスで指定します。
-noquery
このオプションを指定すると，コマンドの実行を中断する問い合わせメッセージが出力されなくなり，ユーザーの応答が不要になります。非対話形式で実行したい場合に指定します。
-fオプションで指定したアプリケーション定義ファイルがすでにある場合，上書きされます。
アプリケーション定義ファイルの形式
コマンド「jpcprocdef create」の「アプリケーション定義ファイルの形式」の記載個所を参照してください。
注意事項
-
このコマンドは，実行時にPFM - Managerに対する認証が必要です。認証用のキーファイルを作成していない場合は，コマンドを実行する前に，jpcmkkeyコマンドで認証用のキーファイルを作成してください。各タグの指定値は，各PFM - AgentまたはPFM - RMマニュアルの「パフォーマンスデータの収集の設定」に関する注意に従って設定してください。
-
このコマンドはPFM - Managerおよび対象PFM - Agentのサービスが起動した状態で実行してください。
戻り値
|
0 |
正常終了した。 |
|
1 |
コマンドラインの形式が不正である。 |
|
2 |
コマンドの実行権限がない。 |
|
3 |
出力ファイルの作成に失敗した。 |
|
4 |
コマンドの引数が不正である。 |
|
11 |
PFM - Managerへの認証処理に失敗した。または，jpcmkkeyで作成されたユーザーに実行権限がない。 |
|
21 |
出力ファイルにアクセスできない。 |
|
80 |
-noquery指定なし時の確認に対して，「Y」または「y」以外を指定して中断させた。 |
|
100 |
Performance Managementの環境が不正である。 |
|
142 |
指定されたアプリケーション定義の一部がない。 |
|
145 |
指定されたアプリケーション定義がすべてない。 |
|
146 |
エージェントにアプリケーション定義が設定されていない。 |
|
200 |
メモリーが不足している。 |
|
222 |
通信処理でエラーが発生した。 |
|
224 |
エージェントに接続できない。 |
|
225 |
エージェントがない。 |
|
226 |
エージェントがサポート対象外である。 |
|
227 |
接続先PFM - Managerがサポート対象外である。 |
|
228 |
接続先PFM - Managerに対象エージェントがセットアップされていない。 |
|
255 |
予期しないエラーが発生した。 |
使用例
エージェント「TA1hostpfm」に定義されているアプリケーション定義「PFM - Manager」の定義情報を出力する場合のコマンド実行例を次に示します。
jpcprocdef output -agent TA1hostpfm -name "PFM - Manager" -f appdef.xml
出力例
コマンド処理の詳細情報を標準出力，標準エラー出力，稼働状況ログファイルに出力します。ログ仕様については「6. Performance Managementで出力するログ情報」を参照してください。
標準出力の出力例を次に示します。引数で指定したサービスIDの実行結果を表示します（OKまたはERR）。
標準出力の出力例
jpcprocdef output connected to localhost at yyyy MM dd HH:MM:SS.mmm output result OK : TA1hostpfm jpcprocdef output disconnected at yyyy MM dd HH:MM:SS.mmm
出力ファイル
このコマンドの出力ファイル例を次に示します。
出力ファイル例
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "processmonitoring_params.dtd"> <pr-cli-parameters ver="0100"> <application-definition> <name>PFM - Manager</name> <virtual-env-id></virtual-env-id> <process01 label="jpcah" max="65535" min="1" type="none">jpcah.exe</process01> <process02 label="jpcagt0" max="65535" min="1" type="program">jpcagt0.exe</process02> <process03 label="jpcep" max="65535" min="1" type="program">jpcep.exe</process03> <process04 label="jpcmm" max="65535" min="1" type="program">jpcmm.exe</process04> <process05 label="jpcnsvr" max="65535" min="1" type="program">jpcnsvr.exe</process05> <process06 label="jpcstatsvr" max="65535" min="1" type="program">jpcstatsvr.exe</process06> <process07 label="jpcsto" max="65535" min="2" type="program">jpcsto.exe</process07> <process08 label="jpctrap" max="65535" min="1" type="program">jpctrap.exe</process08> <process09 label="jpcvsvr" max="65535" min="1" type="program">jpcvsvr.exe</process09> <process10 label="Monitoring10" max="0" min="0" type="none"></process10> <process11 label="Monitoring11" max="0" min="0" type="none"></process11> <process12 label="Monitoring12" max="0" min="0" type="none"></process12> <process13 label="Monitoring13" max="0" min="0" type="none"></process13> <process14 label="Monitoring14" max="0" min="0" type="none"></process14> <process15 label="Monitoring15" max="0" min="0" type="none"></process15> </application-definition> </pr-cli-parameters>