7.4.5 jpcuserコマンドの形式
jpcuserコマンドの形式について説明します。
- 形式
jpcuser レコード名 -file ユーザー作成データのファイル名1 [-file ユーザー作成データのファイル名2]... [-debug [0|1|2]] [-lhost 論理ホスト名][ ]は，省略できることを示します。|は，複数の項目に対して項目間の区切りを示し，「または」の意味を示します。
- 機能
-
ユーザーコマンドによって出力した独自のパフォーマンスデータ（ユーザー作成データ）を，PFM - Agent for Platformが読み取れる形式のデータファイル（ユーザーデータファイル）に変換するコマンドです。
デバッグログを出力することで，ユーザー作成データの内容が正しいかどうかも確認できます。デバッグログの形式と見方については，「7.4.7 ユーザー作成データの内容が正しいかどうかを確認するためのデバッグログの参照」を参照してください。
論理ホスト環境でこのコマンドを実行する場合は実行系ノードで実行してください。
このコマンド実行時にエラーが発生した場合は，エラーメッセージが次のディレクトリに出力されます。
-
物理ホスト環境：/opt/jp1pc/agtu/agent/jpcuser/log/public/
-
論理ホスト環境：環境ディレクトリ/jp1pc/agtu/agent/jpcuser/log/public/
-
- 実行権限
-
rootユーザー権限をもつユーザー
- 格納先ディレクトリ
-
/opt/jp1pc/agtu/agent/jpcuser/
- 引数
-
コマンドラインの第一引数にはレコード名を指定してください。-fileオプション，-debugオプション，および-lhostオプションは，順不同で指定できます。レコード名および-fileオプションは必ず指定してください。-debugオプション，および-lhostオプションは省略できます。
- レコード名
-
パフォーマンスデータを格納するユーザーレコード名を指定します。複数のレコード名を指定することはできません。
-
PD_UPD
-
PD_UPDB
-
PI_UPI
-
PI_UPIB
-
PI_XUI1
-
PI_XUI2
-
PI_XUI3
-
PI_XUI4
-
PI_XUI5
-
- -file ユーザー作成データのファイル名
-
ファイル名を1,023バイト以内で指定します。ファイル名は複数指定でき，複数のユーザー作成データファイルを1つのユーザーデータファイルにまとめることができます。
ファイル名にワイルドカードは指定できません。
ファイル名は，カレントディレクトリ（jpcuserコマンド実行時のディレクトリ）から見た相対パスで指定できます。
ユーザー作成データを複数読み込ませた場合，1つでも警告が発生すれば戻り値は「警告のある正常終了」，1つでもエラーが発生すれば戻り値は「異常終了またはエラー発生」になります。
- -debug [0|1|2]
-
ユーザーデータファイル，およびデバッグログを出力するかどうかを値で指定します。このオプションは，ユーザー作成データの内容が正しいかどうかを確認する目的で使用します。このオプションは，一度だけしか設定できません。
-debug 1を指定した場合は，デバッグだけ行われます。ユーザーレコードを作成したい場合は，-debug 1以外を指定してください。
デバッグログにエラーが出力された場合は，ユーザーコマンドのスクリプトに誤りがあるおそれがあります。
このオプションを省略した場合は，デバッグログは出力されません。
このオプションに指定する値を次の表に示します。
表7‒26 debugオプションに指定する値 値
ユーザーデータファイルの出力
デバッグログの出力
0
○
×
1
×
○
2
○
○
上記以外の値
○
×
指定しない
○
×
- （凡例）
-
○：出力する。
×：出力しない。
なお，ユーザーデータファイルは，jpcuser_XXXを指します。XXXは，レコード形式のUPD，UPDB，UPI，UPIB，またはXUIn（nは1〜5の数字）に相当します。格納ディレクトリは次のとおりです。
-
物理ホスト環境：/opt/jp1pc/agtu/agent/jpcuser/userdata
-
論理ホスト環境：環境ディレクトリ/jp1pc/agtu/agent/jpcuser/userdata
デバッグログは，jpcuser_dbg_XX.logを指します。XXは，作成された順番を表します。格納ディレクトリは次のとおりです。
-
物理ホスト環境：/opt/jp1pc/agtu/agent/jpcuser/debug
-
論理ホスト環境：環境ディレクトリ/jp1pc/agtu/agent/jpcuser/debug
デバッグログの出力例を次の表に示します。
表7‒27 デバッグログの出力例 デバッグログファイル名
説明
jpcuser_dbg_01.log
最新のデバッグログファイル
jpcuser_dbg_02.log
最新から1つ前のデバッグログファイル
jpcuser_dbg_03.log
最新から2つ前のデバッグログファイル
・・・
・・・
-
- -lhost
-
このコマンドを実行するホストの論理ホスト名を指定します。指定を省略した場合，物理ホストが仮定されます。論理ホスト名の形式については，マニュアル「JP1/Performance Management リファレンス」のjpcconf ha setupコマンドの-lhostオプションを参照してください。
なお，このオプションは一度だけ設定できます。
- 戻り値
-
0
正常終了
1〜100
警告のある正常終了
101〜255
異常終了またはエラー発生