jcfallogdef
機能
指定した監視対象ホストに,リモート監視ログファイルトラップのプロファイルを追加または削除します。-fオプションを指定した場合はプロファイルを追加し,-dオプションを指定した場合はプロファイルを削除します。
プロファイルを追加するときに,指定した監視対象ホストに同じ監視名のプロファイルがすでにある場合は,そのプロファイルが稼働中か停止中かに関係なく,動作定義ファイルを上書きします。
プロファイルを削除するときは,指定したプロファイルが停止中のときだけ,このコマンドを実行できます。
一括リロードをする場合は,jcfallogdefコマンドで複数の稼働中のリモート監視ログファイルトラップを上書きしたあと,jcfallogreloadコマンドで複数のプロファイルを一括でリロードします。
なお,同時に実行できるコマンドの数は5個までです。
このコマンドを実行するための条件を次に示します。
-
IM構成管理サービスが起動している
-
リモートの監視対象ホストが,リモート監視構成下にある
-
リモートの監視対象ホストが,ホスト情報を収集済みである
形式
jcfallogdef -a 監視名 -o 監視対象ホスト名 [-h 論理ホスト名] {-f リモート監視ログファイルトラップ動作定義ファイル名 -c 文字コード [-filter フィルター] [-m イベント化するデータの最大長(バイト)] [-p ログデータ出力元プログラム名] [-r] [-t ファイル監視間隔(秒)] ログファイル名1 […ログファイル名32] | -d} [-q]
実行権限
Windowsの場合:Administrators権限
UNIXの場合:スーパーユーザー権限
格納先ディレクトリ
- Windowsの場合
-
Managerパス\bin\imcf\
- UNIXの場合
-
/opt/jp1imm/bin/imcf/
引数
- -a 監視名
-
リモート監視ログファイルトラップを識別する監視名を指定します。
監視名は30バイト以内の文字列で指定します。使用できる文字は英数字,ハイフン,およびアンダーラインで,先頭の文字は必ず英数字を指定します。大文字,小文字は区別されません。
なお,監視名と監視対象ホストの組は一意である必要があり,jcfallogstartで指定したほかの監視名と監視対象の組との重複はできません。ただし,JP1/Baseのjevlogstartで指定される監視名との重複はできます。
- -o 監視対象ホスト名
-
プロファイルを追加または削除したいリモート監視ログファイルトラップの監視対象ホスト名を指定します。
- -h 論理ホスト名
-
このコマンドを実行させたい論理ホスト名を指定します。省略した場合は,環境変数JP1_HOSTNAMEに指定されている論理ホスト名が設定されます。JP1_HOSTNAMEに論理ホスト名が設定されていない場合は,物理ホスト名が設定されます。
- -f リモート監視ログファイルトラップ動作定義ファイル名
-
動作定義ファイルの名称を指定します。
動作定義ファイル名は,フルパスまたはカレントディレクトリからの相対パスで,256バイト以下で指定します。相対パスを指定する場合は,ディレクトリ名を補ったフルパス名が256バイト以下になるように指定してください。
動作定義ファイルは任意のディレクトリに配置し,任意のファイル名を指定できます。
- -c 文字コード
-
ログファイルの文字コードを指定します。-fオプションを指定したときだけ指定できます。
指定できる文字コードは次のとおりです。
表1‒8 文字コード 監視対象OS
日本語の場合
英語の場合
中国語の場合
AIX
-
SJIS
SJISを指定した場合,SJIS/Ja_JPが設定されます。
-
SJIS/Ja_JP
-
SJIS/Ja_JP.IBM-932
-
EUC
EUCを指定した場合,EUC/ja_JPが設定されます。
-
EUC/ja_JP
-
EUC/ja_JP.IBM-eucJP
-
UTF-8
UTF-8を指定した場合,UTF-8/JA_JPが設定されます。
-
UTF-8/JA_JP
-
UTF-8/JA_JP.UTF-8
-
C
-
C
-
GB18030
GB18030を指定した場合,GB18030/Zh_CN.GB18030が設定されます。
-
GB18030/Zh_CN.GB18030
-
GB18030/Zh_CN
-
UTF-8
UTF-8を指定した場合,UTF-8/ZH_CNが設定されます。
-
UTF-8/ZH_CN
-
UTF-8/ZH_CN.UTF-8
-
C
HP-UX
-
SJIS
SJISを指定した場合,SJIS/ja_JP.SJISが設定されます。
-
SJIS/ja_JP.SJIS
-
SJIS/japanese
-
EUC
EUCを指定した場合,EUC/ja_JP.eucJPが設定されます。
-
EUC/ja_JP.eucJP
-
EUC/japanese.euc
-
UTF-8
UTF-8を指定した場合,UTF-8/ja_JP.utf8が設定されます。
-
UTF-8/ja_JP.utf8
-
C
-
C
-
GB18030
GB18030を指定した場合,GB18030/zh_CN.gb18030が設定されます。
-
GB18030/zh_CN.gb18030
-
UTF-8
UTF-8を指定した場合,UTF-8/zh_CN.utf8が設定されます。
-
UTF-8/zh_CN.utf8
-
C
Linux
-
UTF-8
UTF-8を指定した場合,UTF-8/ja_JP.UTF-8が設定されます。
-
UTF-8/ja_JP.UTF-8
-
UTF-8/ja_JP.utf8
-
SJIS※1
SJISを指定した場合,SJIS/ja_JP.sjisが設定されます。
-
SJIS/ja_JP.sjis※1
-
SJIS/ja_JP.SJIS※1
-
C
-
UTF-8
UTF-8を指定した場合,UTF-8/en_US.UTF-8が設定されます。
-
UTF-8/en_US.UTF-8
-
UTF-8/en_US.utf8
-
C
-
GB18030
GB18030を指定した場合,GB18030/zh_CN.gb18030が設定されます。
-
GB18030/zh_CN.gb18030
-
UTF-8
UTF-8を指定した場合,UTF-8/zh_CN.utf8が設定されます。
-
UTF-8/zh_CN.utf8
-
C
Solaris
-
EUC
EUCを指定した場合,EUC/jaが設定されます。
-
EUC/ja
-
EUC/japanese
-
EUC/ja_JP.eucJP
-
SJIS
SJISを指定した場合,SJIS/ja_JP.PCKが設定されます。
-
SJIS/ja_JP.PCK
-
UTF-8
UTF-8を指定した場合,UTF-8/ja_JP.UTF-8が設定されます。
-
UTF-8/ja_JP.UTF-8
-
C
-
C
-
GB18030
GB18030を指定した場合,GB18030/zh_CN.GB18030が設定されます。
-
GB18030/zh_CN.GB18030
-
GB18030/zh_CN.GB18030@pinyin
-
GB18030/zh_CN.GB18030@radical
-
GB18030/zh_CN.GB18030@stroke
-
UTF-8
UTF-8を指定した場合,UTF-8/zh.UTF-8が設定されます。
-
UTF-8/zh.UTF-8
-
UTF-8/zh_CN.UTF-8
-
UTF-8/zh_CN.UTF-8@pinyin
-
UTF-8/zh_CN.UTF-8@radical
-
UTF-8/zh_CN.UTF-8@stroke
-
C
Windows
-
SJIS
-
SJIS※2
-
C
-
GB18030
- 注※1
-
監視対象OSがSUSE Linuxの場合だけ有効です。
- 注※2
-
英語OSの場合,文字コードにSJISを指定してもCで動作します。
-
- -filter フィルター
-
事前フィルターによって,リモートの監視対象ホスト側で取得したログファイルをフィルタリングする場合に,フィルターを正規表現で指定します。
このオプションを指定すると,指定した正規表現と一致したログデータだけがマネージャーに転送されます。これによって,リモートの監視対象ホストからマネージャーに転送されるログファイルのデータ量を抑制できます。
このオプションは,-fオプションを指定したときだけ指定できます。
このオプションは,リモートの監視対象ホストがUNIXの場合だけ有効です。前提条件として,SSH接続でgrepコマンドが実行できる必要があります。リモートの監視対象ホストがWindowsの場合は,このオプションを指定しても無視されます。
指定できる正規表現の形式は,リモートの監視対象ホストのgrepコマンドの-Eオプションに指定できる拡張正規表現の形式と同一です。環境変数は使用できません。
正規表現は128バイト以内の文字列で指定します。使用できる文字列は,「'」,「"」,「<」,「>」,および制御文字を除く半角英数字,半角スペース,記号です。文字列に半角スペースが含まれている場合は,前後をダブルクォーテーション「"」で囲む必要があります。
grepコマンドのパス例を次に示します。詳細は,各OSのgrepコマンドのマニュアルを参照してください。
-
Linuxの場合:/bin/grep
-
Solarisの場合:/usr/xpg4/bin/grep
-
Linux,Solaris以外の場合:/usr/bin/grep
-
- -m イベント化するデータの最大長(バイト)
-
ログファイルの1行を,先頭から何バイト読み込むかを指定します。指定できるバイト数は1〜1,024です。このオプションを省略した場合は512が設定されます。
行の終了文字は終了記号「\0」に変更されます。ログファイルの1行がこのオプションで指定されたバイト数を超える場合,最後の1バイトが「\0」に変更されます。
このオプションで指定した値は,入力したログファイルの1行の有効範囲を示します。したがって,リモート監視ログファイルトラップ動作定義ファイルのMARKSTRパラメーターの正規表現とACTDEFパラメーターの正規表現をチェックするのは,ここで指定した範囲内です。つまり,有効範囲を超えたカラムに対応する正規表現があっても,それらはチェックの対象にはなりません。
- -p ログデータ出力元プログラム名
-
ログデータを出力するプログラム名を指定します。指定した名前はJP1/IM - Viewの[イベントコンソール]画面に表示されます。
表示される名称は次のとおりです。
- Windowsの場合
-
/HITACHI/JP1/NT_LOGTRAP/ログデータ出力元プログラム名
- UNIXの場合
-
/HITACHI/JP1/UX_LOGTRAP/ログデータ出力元プログラム名
このオプションを省略すると,Windowsの場合は「/HITACHI/JP1/NT_LOGTRAP」,UNIXの場合は「/HITACHI/JP1/UX_LOGTRAP」と表示されます。
- -r
-
このオプションを指定すると,次の場合に,ログが収集できるようになるまで,-tオプションで指定した間隔で収集を試みます。
-
リモート監視ログファイルトラップの起動時に,リモートの監視対象ホストにアクセスできない場合
-
リモート監視ログファイルトラップの稼働中に,リモートの監視対象ホストにアクセスできなくなった場合
-
リモート監視ログファイルトラップの起動時に,監視対象のログファイルにアクセスできない場合
-
リモート監視ログファイルトラップの稼働中に,監視対象のログファイルにアクセスできなくなった場合
-rオプションは,次の場合に指定してください。
-
リモート監視ログファイルトラップの起動後に,リモートの監視対象ホストにアクセスできるようになる場合
-
リモート監視ログファイルトラップの起動後に,監視対象のログファイルが作成される場合
-
リモートの監視対象ホストにアクセスできなくでも監視を継続したい場合
このオプションを省略した場合,次の動作となります。
-
リモート監視ログファイルトラップを起動した時点で,監視対象のログファイルの収集ができない場合,起動を中止し処理を終了します。
-
稼働中に監視対象のログファイルの収集ができなくなった場合,リモート監視ログファイルトラップ動作定義ファイルに指定したリトライ回数および間隔でリトライします。
-
- -t ファイル監視間隔(秒)
-
ファイルの監視間隔を指定します。指定できる値は60〜86,400(単位:秒)です。省略した場合は300が設定されます。
- WRAP2形式のログファイルを監視する場合
-
ラップアラウンドする頻度が高い場合や監視間隔を長く指定した場合に,リモート監視ログファイルトラップがデータを読み込む前に上書きされてしまい,データの読み込み漏れが発生するおそれがあります。データの読み込み漏れの予防策として,次の監視間隔の見積もり式を参考にしてください。
ログファイルサイズ(バイト)×ログファイル数>1秒当たりの出力サイズ(バイト)×監視間隔(秒)
- ログファイル名1 […ログファイル名32]
-
監視するログファイル名を指定します。ログファイル名は256バイト以内の文字列で指定します。監視対象ホストがWindowsの場合は,ホスト名を除いたネットワークパス名で指定します。UNIXの場合はフルパスで指定します。なお,ワイルドカードを使用して,監視するログファイルを指定することはできません。
監視対象ホストがUNIXの場合,監視対象ファイルパスに半角英数字および「-」,「_」,「.」,「/」を含むログファイルを監視できます。それ以外の文字を含むファイルパスについては,正常に監視できないときがあります。
指定できるファイル数は32以下で,指定できるファイル形式は次の形式です。
-
シーケンシャルファイル(SEQ)
-
シーケンシャルファイル(SEQ2)
-
ラップアラウンドファイル(WRAP2)
-
- -d
-
リモート監視ログファイルトラップのプロファイルを削除します。
リモート監視ログファイルトラップをプロファイルツリーから削除することになるため,問題ないかを確認するためのメッセージが表示されます。
- -q
-
このオプションを指定すると,-dオプション指定時でも確認メッセージが表示されません。-dオプションを指定していない場合は,指定しても無視されます。
注意事項
-
このコマンドは実行系ホストでだけ実行してください。コマンドの実行時は共有ディスクをマウントした状態で実行してください。
-
このコマンドは待機系ホストでは実行しないでください。
UNIX/Linux環境の待機系ホストで実行した場合,待機系ホストのローカルディスクのルート直下に「/共有ディレクトリ名」という不要なディレクトリが作成され,その配下にも次の不要なディレクトリとファイルが作成されます。
-
/共有ディレクトリ名/jp1imm
-
/共有ディレクトリ名/jp1imm/log
-
/共有ディレクトリ名/jp1imm/log/imcf
上記のローカルディスクにあるルート直下の「/共有ディレクトリ名」およびそのディレクトリ配下のファイルは不要であるため削除してください。削除する際は誤って共有ディスク上のディレクトリおよびファイルを削除しないように,必ず待機系ホスト上で共有ディスクがマウントされていないことを確認して実施してください。
-
戻り値
0 |
追加成功/削除成功 |
4 |
引数不正 |
6 |
サーバに接続できない |
7 |
ホスト情報が不正 |
8 |
指定した監視名は稼働済み(-dオプション指定時) |
9 |
プロファイルの各種制限値を超過 |
10 |
排他編集権取得エラー |
14 |
DB不正 |
17 |
権限が不正 |
18 |
I/Oエラー |
21 |
同時実行数の上限に達した |
255 |
内部エラー |
その他の値 |
その他のエラー |
使用例1
host1にプロファイルを追加する場合
jcfallogdef -a name1 -o host1 -f actionDefinition.conf -c SJIS -filter ".*-E" /log/sample.log
使用例2
host1のプロファイルを削除する場合
jcfallogdef -a name1 -o host1 -d -q