jpcras
形式
jpcras ディレクトリ名 サービスキー [all|data|dump] [lhost=論理ホスト名] [inst=インスタンス名]
機能
jpcrasコマンドは,PFM - Manager,PFM - Agent,PFM - RM,またはPFM - Baseの資料,およびOS情報を採取するコマンドです。PFM - Manager,PFM - Agent,PFM - RM,またはPFM - Baseにトラブルが発生した場合に使用します。
採取できるのは,このコマンドを実行したホストの資料またはlhostオプションで指定した論理ホストの保守資料です。採取した資料は,指定したディレクトリに格納されます。UNIXの場合,採取した資料はtarコマンドと,compressコマンドまたはgzipコマンドで圧縮された形式になりますが,Windowsの場合,圧縮されないので,必要に応じて手動で圧縮してください。
トラブルが発生した場合,このコマンドで採取できる資料以外にも必要な資料があります。トラブル発生時に採取が必要な資料については,マニュアル「JP1/Performance Management 運用ガイド」の,トラブルへの対処方法について説明している章を参照してください。
コマンドを実行できるホスト
-
PFM - Manager
-
PFM - Agent
-
PFM - RM
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー(WindowsのUAC機能が有効な場合は管理者コンソールから実行)
- UNIXの場合
-
rootユーザー権限を持つユーザー
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pc/tools/
引数
ディレクトリ名
採取した資料を格納するディレクトリ名を指定します。1〜127バイトで指定します。半角英数字または半角記号で指定します。相対パスでは指定できません。必ず絶対パスで指定してください。ただし,次の記号は指定できません。
; , * ? ' " < > | & ^ `
空白文字を含む場合," "で囲んでください。また,次の記号を指定する場合,シェルまたはコマンドプロンプトで解析されるのを防ぐため," "で囲んで指定してください。
( )
ディレクトリ名としてPerformance Managementのインストール先ディレクトリを指定しないでください。
このオプションに,フロッピーディスクなどリムーバブルメディアのディレクトリ名は指定できません。
UNIXの場合,このオプションで指定したディレクトリに,採取した資料のファイルが「jpcrasYYMMDD※.tar.Z」(compressコマンドの場合)または「jpcrasYYMMDD※.tar.gz」(gzipコマンドの場合)の名前で作成されます。
Windowsの場合,このオプションで指定したフォルダに,採取した資料のファイルが圧縮されないでコピーされます。
- 注※
-
「YYMMDD」は,ファイルを作成した日時です。各値の意味を次に示します。
-
YY
西暦年の下2桁を示します。
-
MM
月を示します。01〜12(単位:月)で示します。
-
DD
日を示します。01〜31(単位:日)で示します。
-
サービスキー
資料を採取するサービスのサービスキー名を指定します。プロダクト名表示機能が有効な場合もプロダクト名では指定できません。指定できるサービスキーを次に示します。
-
all:すべてのPerformance Managementプログラムのサービスの資料を採取します。
-
mgr:PFM - Managerサービス(Action HandlerサービスおよびStatus Serverサービスを除く)の資料を採取します。
-
act:Action Handlerサービスの資料を採取します。
-
PFM - AgentまたはPFM - RMのサービスのサービスキー :PFM - AgentまたはPFM - RMの各サービス(Action Handlerサービスを含む)の資料を採取します。
-
stat:Status Serverサービスの資料を採取します。
PFM - AgentまたはPFM - RMのサービスのサービスキーについては,マニュアル「JP1/Performance Management 設計・構築ガイド」の付録の,命名規則について説明している個所を参照してください。
[all|data|dump]
採取する資料を選択します。指定するオプションによって採取する資料が異なります。通常は,「all」を指定してください。
指定するオプションと採取する資料をOSごとに次の表に示します。
採取する資料 |
オプション |
||||
---|---|---|---|---|---|
all |
data |
dump |
省略 |
||
システムログ |
○ |
− |
− |
○ |
|
共通メッセージログ |
○ |
− |
− |
○ |
|
サービス構成情報 |
○ |
− |
− |
○ |
|
プロセス情報 |
○ |
− |
− |
○ |
|
バージョン情報 |
○ |
− |
− |
○ |
|
システムファイル |
○ |
− |
− |
○ |
|
データベース情報 |
○ |
○ |
− |
○※ |
|
OS情報 |
システム情報 |
○ |
− |
− |
○ |
ネットワークステータス |
○ |
− |
− |
○ |
|
ホスト名 |
○ |
− |
− |
○ |
|
ファイアウォールの情報 |
○ |
− |
− |
○ |
|
ダンプ情報 |
○ |
− |
○ |
− |
|
Docker環境情報 |
○ |
− |
− |
○ |
採取する資料 |
オプション |
||||
---|---|---|---|---|---|
all |
data |
dump |
省略 |
||
システムログ |
○ |
− |
− |
○ |
|
共通メッセージログ |
○ |
− |
− |
○ |
|
サービス構成情報 |
○ |
− |
− |
○ |
|
プロセス情報 |
○ |
− |
− |
○ |
|
バージョン情報 |
○ |
− |
− |
○ |
|
システムファイル |
○ |
− |
− |
○ |
|
データベース情報 |
○ |
○ |
− |
○※ |
|
OS情報 |
システム情報 |
○ |
− |
− |
○ |
パッチ情報 |
○ |
− |
− |
○ |
|
カーネル情報 |
○ |
− |
− |
○ |
|
バージョン情報 |
○ |
− |
− |
○ |
|
ネットワークステータス |
○ |
− |
− |
○ |
|
環境変数 |
○ |
− |
− |
○ |
|
ホスト名 |
○ |
− |
− |
○ |
|
ファイアウォールの情報(Linux) |
○ |
− |
− |
○ |
|
ダンプ情報 |
○ |
− |
○ |
− |
|
Docker環境情報 |
○ |
− |
− |
○ |
採取する資料の詳細については,マニュアル「JP1/Performance Management 運用ガイド」の,トラブルへの対処方法について説明している章を参照してください。
lhost=論理ホスト名
コマンドを実行するホスト環境を指定します。コマンドを実行するマシンに論理ホストが構成されている場合,この引数を使用します。1〜32バイトの半角英数字で指定します。空白文字は,指定できません。
指定を省略した場合,すべてのホスト環境の保守情報が採取されます。ワイルドカード文字は使用できません。
inst=インスタンス名
特定のインスタンスの資料を採取する場合は,インスタンス名を指定します。このオプションは,サービスキーにインスタンス環境を持つPFM - AgentまたはPFM - RMを指定した場合だけ有効です。1〜32バイトの半角英数字で指定します。
指定を省略した場合,すべてのインスタンスの資料を採取します。
注意事項
-
allまたはdataオプションを指定して,Agent StoreまたはRemote Monitor Storeサービスのデータベース情報を採取する場合,対象サービスを停止する必要はありません。
-
Storeバージョンが2.0の場合は,次の両方のコマンドを実行してデータベース以外の資料を採取してから障害時のデータを採取してください。Storeバージョンを2.0にすると,データベースの容量が大きくなるため,データ採取に時間が掛かり,障害の調査開始を遅らせることがあります。
-
jpcras ディレクトリ名 all
-
jpcras ディレクトリ名 all dump
データベースの容量が大きくない場合は,次のコマンドを実行することで,データベースを含んだ資料を採取できます。
-
jpcras ディレクトリ名 all all
-
-
このコマンドを実行すると,Storeサービスのデータベースが採取されますが,インポートディレクトリにあるデータベースは採取されません。インポートディレクトリにあるデータベースを採取する場合は,環境変数「JPC_COLIMPORT」の値に「1」を設定してください。
-
採取するファイルのサイズやネットワーク環境によって,コマンド終了まで時間が掛かることがあります。
-
このコマンドを実行する場合,syslogファイルがデフォルトのパスおよびファイル名以外に出力されるように設定されているシステムでは,資料は収集できません。そのほかの方法で収集してください。
-
引数は,「形式」にある順番で指定してください。
-
ディレクトリ名を相対パスで指定しないでください。
-
ディレクトリ名としてPerformance Managementのインストール先フォルダを指定しないでください。
-
ディレクトリ名として,配下にファイルまたはディレクトリのない空のディレクトリを指定してください。
-
ディスクに十分な空き容量があるか確認してください。空き容量の目安は,各製品のディスク占有量を参考にしてください。
-
ディスク容量不足やメモリー不足の状態でこのコマンドを実行した場合,OSのメッセージが出力されることがあります。この場合,KAVE06010-Iメッセージが出力されていれば,保守資料は正しく採取されていますので,OSのメッセージは無視してください。
-
KAVE05035-Eメッセージが出力された場合,OSのメッセージに従い,ディスクやメモリーの空き容量を確認してください。
-
メッセージテキストは,英語でしか出力されません。
-
KAVE05213-Eメッセージが出力された場合,採取した保守資料のほかに,Performance Managementのインストール先ディレクトリに格納されているファイル一覧も採取してください。
-
ファイルの採取でエラーが発生した場合,採取中のファイルまたはディレクトリが次のディレクトリに残ります。この場合,残ったファイルやディレクトリを必要に応じて削除してください。
-
Windowsの場合
ディレクトリ名で指定したフォルダ
-
UNIXの場合
ディレクトリ名で指定したフォルダ/jpcwk*
-
-
コマンドの実行をCtrl+Cキーやシグナルで中断した場合,特定の戻り値が返りません。そのため,コマンドをCtrl+Cキーやシグナルで中断した場合は戻り値を無視してください。
-
このコマンドを実行するとPFMサービスの一覧取得と起動状態の確認のため「jpctool service list -id "*" -host "*"」が実行されます。コマンド実行ホストとほかのPFMシステム内のホストとの間にファイアウォールが設定されていたり,システム構成が大規模だったりすると,「jpctool service list -id "*" -host "*"」の実行に時間が掛かる場合があります。そのような場合は,環境変数「JPC_COLCTRLNOHOST」に1を設定することで「jpctool service list -id "*" -host "*"」の処理を抑止し,コマンドの実行時間を短縮できます。
-
UNIX環境でjpcrasコマンドを実行する場合,必要な空きディスク容量について次の点を考慮してください。
-
jpcrasコマンドで指定する格納先ディレクトリには,採取する容量の2倍の空きディスク容量が必要になります。
-
tarコマンドの処理のため/tmpまたは/var/tmpディレクトリを使用します。なお,使用するディレクトリはOS環境によって異なります。
jpcrasコマンドの実行例を次に示します。
jpcras /usr/ras all all
jpcrasコマンドで採取される容量が100メガバイトとします。この場合,/usr/rasディレクトリに必要な空きディスク容量は200メガバイトになります。また,tarコマンドの処理のため,/tmpまたは/var/tmpディレクトリには,一時的に100メガバイトの空きディスク容量が必要となります。
-
-
PFM - ManagerホストでAgentホストリモート操作制限オプションの設定が有効な環境で,このコマンドをPFM - Agent またはPFM - RMホストで実行する場合,ローカルホストの情報以外は採取できません。
-
PFMがクラスタ環境の場合,調査資料には共有Disk部分,および物理部分が必要となります。jpcrasコマンドでは共有DiskがOnになっている状態でlhost指定なしで実行すると,共有Diskと物理部分の両方を一度に採取できるようにしております。そのため,PFMがクラスタ環境の場合であってもlhost指定をせずに資料採取を実施してください。なお,lhostオプションは互換性のため残しているオプションとなります。
-
クラスタシステムで運用している場合は,クラスタシステムのすべてのノードで実行してください。また,監視二重化の環境で運用している場合は,プライマリー,セカンダリーそれぞれのホストでこのコマンドを実行してください。
-
jpcrasコマンドでは,OSのシステム情報を収集するためにOSコマンドを実行します。この際,「システム情報を更新しています」と表示されるダイアログが表示されることがありますが,情報の収集だけを実施するため,jpcrasコマンドの実行によるシステムへの影響はありません。
戻り値
0 |
正常終了した。 |
1 |
引数の指定に誤りがある。 |
2 |
コマンドの実行権限がない。 |
100 |
Performance Managementの環境が不正である。 |
102 |
指定された論理ホスト名またはインスタンスは,セットアップされていない。 |
210 |
ディスク容量が不足している。 |
211 |
採取先ディレクトリにアクセスできない。 |
255 |
予期しないエラーが発生した。 |
使用例1
UNIXホストで,すべての資料を採取し,/tmp/jp1pcディレクトリに格納する場合のコマンド実行例を次に示します。
jpcras /tmp/jp1pc all all
使用例2
UNIXホストで,PFM - Agent for Platform(UNIX)のダンプ情報を採取し,/tmp/jp1pcディレクトリに格納する場合のコマンド実行例を次に示します。
jpcras /tmp/jp1pc agtu dump