jr3alget

形式

jr3alget     [RFC接続情報
            [ターゲット情報
            [-lasttime タイムスタンプファイル名
            [出力先
            [-cnf 環境パラメーター設定ファイル名
            [-help]
            [-v]

機能

jr3algetコマンドは,SAPシステムのCCMSアラート情報を抽出します。

コマンドを実行できるホスト

PFM - Agent for Enterprise Applications

実行権限

Windowsの場合
なし
UNIXの場合
なし

格納先ディレクトリ

Windowsの場合

インストール先フォルダ¥agtm¥evtrap¥

UNIXの場合

/opt/jp1pc/agtm/evtrap/

引数

RFC接続情報
コマンド実行時に,SAPシステムとのRFC接続を確立するための情報を指定します。
環境パラメーター設定ファイルで,RFC接続情報(CONNECTセクション)が指定されている場合,これらの引数の指定を省略できます。環境パラメーター設定ファイルおよびコマンドの両方でRFC接続情報が指定された場合,コマンドでの指定が優先されます。環境パラメーター設定ファイルについては,「6.4.3 コマンドを実行してCCMSアラート情報を抽出する場合の環境パラメーター設定ファイル」を参照してください。
RFC情報の各引数について説明します。
-h アプリケーションサーバホスト名
接続先のアプリケーションサーバホスト名を指定します。指定できる値は,1~100バイトの半角英数字です。アプリケーションサーバホスト名は,次の形式で指定できます。
  • hostsファイルに指定されたホスト名
  • IPアドレス
  • SAPルーターアドレス
アプリケーションサーバホスト名は,トランザクションコードSM51で確認できます。
このオプションを指定する場合は,-sオプションも指定する必要があります。
-s システム番号
-hオプションで指定したアプリケーションサーバホストで識別するためのシステム番号を指定します。指定できる値は,0~99の数値です。
このオプションを指定する場合は,-hオプションも指定する必要があります。
-c クライアント名
接続に利用するユーザーのクライアント名を1~3バイトで指定します。指定できる値は,0~999の数値です。
このオプションを指定する場合は,-u,および-pまたは-p2オプションも指定する必要があります。
-u ユーザー名
接続に利用するユーザー名を指定します。指定できる値は,1~12バイトの半角英数字です。
このオプションを指定する場合は,-c,および-pまたは-p2オプションも指定する必要があります。
指定できるSAPユーザーについては「接続に使用するSAPユーザー」を参照してください。
-p パスワード
-uオプションで指定したユーザーのパスワードを指定します。指定できる値は,1~8バイトの半角文字列です。
このオプションは,-p2オプションと同時に指定できません。
このオプションを指定する場合は,-c,および-uオプションも指定する必要があります。
パスワードに指定できる文字については「接続に使用するSAPユーザー」を参照してください。
-p2 拡張パスワード
SAP NetWeaver 7.0以降をベースシステムとした拡張パスワード対応のSAPシステムへ接続する場合,-uオプションで指定したユーザーの拡張パスワードを指定します。指定できる値は,1~40バイトの半角文字列です。英字の大文字と小文字は区別されます。
このオプションは,-pオプションと同時に指定できません。
このオプションを指定する場合は,-c,および-uオプションも指定する必要があります。
拡張パスワードに指定できる文字については「接続に使用するSAPユーザー」を参照してください。
-l 言語
-uオプションで指定したユーザーの言語を指定します。指定できる値は,SAPシステムで使用されている,2バイトのISO IDまたは1バイトの言語キーです。例えば,次のように指定します。
  • 日本語の場合:JA
  • 英語の場合:EN
このオプションの指定を省略した場合,接続先システムで定義されているユーザーの言語が仮定されます。
このオプションを指定する場合は,-c,-u,および-pまたは-p2オプションも指定する必要があります。
-codepage コードページ
接続先のUnicode版SAPシステムで文字コードを変換するときに使用するコードページを指定します。コードページは,-lオプションの言語と組み合わせて指定する必要があります。
次の組み合わせで設定してください。次の組み合わせ以外の言語とコードページを指定した場合,SAPシステムから取得した情報が文字化けする可能性があります。

表10-3 言語とコードページの指定内容の組み合わせ

接続先SAPシステム接続言語言語(-l)コードページ(-codepage)
Unicode版日本語JA8000
英語EN指定する必要はありません。指定する場合は,1100を指定してください。
非Unicode版日本語JA指定する必要はありません。指定する場合は,8000を指定してください。
英語EN指定する必要はありません。指定する場合は,1100を指定してください。
接続先のUnicode版SAPシステムで文字コードを変換するときに使用するコードページは,SAPシステムが提供する環境変数SAP_CODEPAGEでも設定することができます。環境変数SAP_CODEPAGEとこのオプションの両方でコードページが指定された場合は,このオプションの指定が有効となります。
このオプションの指定を省略した場合,接続先システムのデフォルトコードページが仮定されます。このオプションを指定する場合は,-c,-u,および-pまたは-p2オプションも指定する必要があります。
ターゲット情報
抽出対象のCCMSアラート情報を特定するための情報を指定します。
環境パラメーター設定ファイルでターゲット情報(TARGETセクション)が指定されている場合は,これらの引数の指定を省略できます。環境パラメーター設定ファイルおよびコマンドの両方でターゲット接続情報が指定された場合,コマンドでの指定が優先されます。環境パラメーター設定ファイルについては,「6.4.3 コマンドを実行してCCMSアラート情報を抽出する場合の環境パラメーター設定ファイル」を参照してください。
ターゲット情報の各引数について説明します。
-ms モニターセット名
モニターセット名を指定します。指定できる値は,1~60バイトの半角英数字です。モニターセット名とは,SAPシステムの警告モニター(トランザクションコードRZ20)で,「CCMS監視セット」として表示される名称です。
このオプションを指定する場合は,-mnオプションも指定する必要があります。
-mn モニター名
モニターセット内に定義されているモニター名を指定します。指定できる値は,1~60バイトの半角英数字です。モニター名とは,SAPシステムの警告モニター(トランザクションコードRZ20)で,CCMS監視セットのツリーに表示される名称です。
このオプションを指定する場合は,-msオプションも指定する必要があります。
-lasttime タイムスタンプファイル名
前回のコマンド実行時以降に出力されたCCMSアラート情報だけを抽出する場合に,前回の抽出時刻を管理するためのタイムスタンプファイル名を指定します。
指定できる値は,1~255バイトです。
相対パスで指定する場合,コマンドの作業ディレクトリからの相対パスを指定してください。ただし,環境パラメーター設定ファイルのCOMMANDセクションのWORKDIRラベルで,コマンドの作業ディレクトリを指定していない場合,カレントディレクトリからの相対パスを指定してください。
このオプションの指定を省略した場合,コマンド実行日の0時0分0秒から23時59分59秒までの期間が仮定されます。
このオプションの初回実行時に,指定したタイムスタンプファイルが存在しない場合,新規に作成されます。初回実行時は,CCMSアラート情報が出力されません。
出力先
CCMSアラート情報の出力先を指定します。このオプションの指定を省略した場合,CCMSアラート情報は,改行コードで区切られてコマンドの標準出力に出力されます。
出力先の各引数について説明します。
-x 出力ファイル名
CCMSアラート情報を出力するファイル名を指定します。指定できる値は,1~255バイトです。
相対パスで指定する場合,コマンドの作業ディレクトリからの相対パスを指定してください。ただし,環境パラメーター設定ファイルのCOMMANDセクションのWORKDIRラベルで,コマンドの作業ディレクトリを指定していない場合,カレントディレクトリからの相対パスを指定してください。
このファイルは,一定の容量に達すると先頭から再びデータを上書きする形式のラップアラウンドファイルであり,ファイルの先頭に管理情報として1行のヘッダーがあります。
ファイルサイズのデフォルトは1024KBです。ファイルサイズを変更する場合は,環境パラメーター設定ファイルのEXTRACTFILEセクションのSIZEラベルで指定してください。
なお,指定の出力ファイルと同じディレクトリに,出力ファイル名.ofsという名称で管理ファイルが作成されます。(例:出力ファイル名としてALERT を指定したときALERTファイルとは別にALERT.ofsファイルが管理ファイルとして作成されます)出力ファイルを削除する場合は,この管理ファイルも合わせて削除してください。
-xオプションと-x2オプションは,同時に指定できません。
-x2
環境パラメーター設定ファイルのEXTRACTFILEセクションのX2PATHパラメーターで設定したファイルに,CCMSアラート情報を出力する場合に指定します。
-xオプションと-x2オプションは,同時に指定できません。
-cnf 環境パラメーター設定ファイル名
コマンドが参照する環境パラメーター設定ファイル名を指定します。指定できる値は,1~255バイトです。
相対パスで指定する場合,コマンドのカレントディレクトリからの相対パスを指定してください。
このオプションの指定を省略した場合,カレントディレクトリ下のデフォルト環境パラメーター設定ファイルjr3alget.iniが仮定されます。デフォルト環境パラメーター設定ファイルが存在しない場合,PFM - Agent for Enterprise Applicationsでのデフォルトの設定値が仮定されます。
環境パラメーター設定ファイルおよびデフォルトの設定値については,「6.4.3 コマンドを実行してCCMSアラート情報を抽出する場合の環境パラメーター設定ファイル」を参照してください。
-help
jr3algetコマンドの使用方法を標準出力に出力します。
-v
標準出力にjr3algetコマンドの処理状況を示すメッセージを出力します。このオプションの指定を省略した場合,コマンドの処理状況を示すメッセージは出力されません。

接続に使用するSAPユーザー

jr3algetコマンドはCCMSアラート情報を収集するために,SAP社の通信プロトコルであるRFCを使用して,SAPシステム側に定義されている外部管理インターフェースを実行します。そのため,jr3algetコマンドが接続に使用するユーザーをあらかじめSAPシステム側に用意しておく必要があります。

ここでは,SAPシステム側に作成するSAPユーザーのユーザータイプ,パスワード,権限について説明します。

ユーザータイプ
PFM - Agent for Enterprise Applicationsで使用するSAPユーザーには,次のタイプのユーザーが使用できます。
  • ダイアログ(Dialog)
  • システム(System)
  • 通信(Communication)
  • サービス(Service)
パスワードに指定できる文字
SAPユーザーのパスワードは,半角数字(0~9),半角英字(a~z, A~Z),および次の半角記号で定義してください。
 
 !"@△$%&/()=?'`*+~#-_.,;:{[]}¥<>|
 △は,空白文字を示します。
必要な権限
SAPユーザーには次の権限(権限オブジェクト)を設定する必要があります。
  • ユーザーが汎用モジュールにRFC接続するための権限(S_RFC)
  • 外部管理インターフェースを使用するための権限(S_XMI_PROD)
各権限の値として,次の表に示す値またはすべての項目に「XAL」を指定したビルトイン権限値(S_RFC_ALLやS_XMI_ADMIN)を割り当ててください。

表10-4 ユーザーが汎用モジュールにRFC接続するための権限(S_RFC)

権限項目説明
RFC_TYPE保護されるRFCオブジェクトのタイプFUGR(汎用グループ)
RFC_NAME保護されるRFC名*
ACTVTアクティビティ16(実行)

表10-5 外部管理インターフェースを使用するための権限(S_XMI_PROD)

権限項目説明
EXTCOMPANY外部管理ツールの会社名HITACHI
EXTPRODUCT外部管理ツールのプログラム名JP1
INTERFACEインターフェースIDXAL

注意事項

CCMSアラート情報は,SAPシステム内で一つのリソースとして扱われていて,どのアプリケーションサーバからも参照できるため,接続先のアプリケーションサーバは,任意です。一つのSAPシステムにつき,一つだけコマンドを実行するようにしてください。

出力形式および内容

CCMSアラート情報は,デフォルトでは次の形式で出力されます。< >は,フィールドIDを示します。

[図データ]

CCMSアラート情報の各値が,各フィールドに対して決められた長さに満たない場合,半角の空白で埋められます。出力される各値について次に説明します。

表10-6 出力されるCCMSアラート情報の内容

フィールドID意味参照元長さ(単位:バイト)
<ALSYSID>SAPシステムの名称アラートID(AID)
(BAPIAID)
8
<MSEGNAME>監視セグメント名40
<ALUNIQNUM>AIDで使用される一意のID10
<ALERTDATE>アラート発生日付(YYYYMMDD)8
<ALERTTIME>アラート発生時刻(HHMMSS)6
<MTSYSID>SAPシステムの名称アラートに関連づけられているMTEのID(TID)
(BAPITID)
8
<MTCLASS>MTEタイプ3
<MTNUMRANGE>番号範囲(常駐,一時など)3
<MTMCNAME>監視コンテキスト名40
<MTUID>TIDで使用される一意のID10
<VALUE>警告値(トランザクションコードRZ20で見るCCMSアラートエントリーの色に対応)
  • 0:灰(無効情報)
  • 1:緑(OK)
  • 2:黄(警告)
  • 3:赤(問題またはエラー)
アラートの重要度(BAPIALDATA)11
<SEVERITY>重大度(0~255。数値が大きいほど重大)11
<FIELDNAME>MTE略称一般プロパティ(BAPIALERT)40
<STATUS>アラートステータス11
<OBJECTNAME>監視オブジェクト名40
<MANDT>クライアント3
<USERID>SAPユーザー12
<REPORTEDBY>報告者(論理名)16
<STATCHGDAT>ステータス最終変更日付8
<STATCHGBY>ステータス最終変更者(論理名)16
<STATCHGTIM>ステータス最終変更時間6
<MSCGLID>ログ属性のメッセージがアラートを発生させたときのメッセージ識別50
<MSGCLASS>メッセージ記録者メッセージ16
<MSGID>メッセージID30
<MSGARG1>メッセージの挿入語句1の文字列128
<ARGTYPE1>メッセージの挿入語句1のタイプ1
<MSGARG2>メッセージの挿入語句2の文字列128
<ARGTYPE2>メッセージの挿入語句2のタイプ1
<MSGARG3>メッセージの挿入語句3の文字列128
<ARGTYPE3>メッセージの挿入語句3のタイプ1
<MSGARG4>メッセージの挿入語句4の文字列128
<ARGTYPE4>メッセージの挿入語句4のタイプ1
<MSGTEXT>メッセージテキスト128
<MSG>翻訳済みメッセージ255

戻り値

0正常終了した。
1以上異常終了した。

使用例

モニターセット名としてSAP CCMS Monitor Templates,モニター名をEntire SystemとしてCCMSアラート情報を出力する場合のコマンド実行例を次に示します。RFC接続情報は,環境パラメーター設定ファイルで定義済みであることを前提としています。

jr3alget -ms "SAP CCMS Monitor Templates" -mn "Entire System"

このコマンドの出力例を次に示します。

[図データ]