JP1/Integrated Management - Manager コマンド・定義ファイルリファレンス
形式
[@encode 文字コード] @file type="定義ファイルタイプ", version="定義フォーマットバージョン"; @product name="プロダクト名"; @define-block type="event-attr-def"; block lang = "言語種別", platform="プラットフォーム種別" attr name="属性名", title="表示項目名"[, type="属性表示タイプ"]; ・・・ @define-block-end; @define-block type="event-attr-group-def"; block platform="プラットフォーム種別" group name="グループ名", attrs="属性名並び"; ・・・ @define-block-end; @define-block type="event-attr-order-def"; block platform="プラットフォーム種別" order id="イベントID定義文字列", attrs="属性名並び"; ・・・ @define-block-end;
ファイル
default.conf(デフォルトのイベント拡張属性定義ファイル)
hitachi_xxxx.conf(連携製品のイベント拡張属性定義ファイル)
会社名_製品名_attr.conf(ユーザー定義のイベント拡張属性定義ファイル)
なお,「製品名」は,「シリーズ名_製品名」とすることもできます。JP1イベント発行時の「PRODUCT_NAME」に指定する値の「/」を「_」に変更してファイル名に使用することをお勧めします。また,標準提供ファイル名称用に「hitachi」を使用しているため,「会社名」には「hitachi」以外の名称を使用してください。
格納先ディレクトリ
- Windowsの場合
- 物理ホストのとき
Consoleパス\conf\console\attribute\
- 論理ホストのとき
共有フォルダ\JP1Cons\conf\console\attribute\
- UNIXの場合
- 物理ホストのとき
/etc/opt/jp1cons/conf/console/attribute/
- 論理ホストのとき
共有ディレクトリ/jp1cons/conf/console/attribute/
説明
イベント拡張属性定義ファイルは,[イベント詳細]画面に表示するイベント属性の並び順や表示する属性名を定義します。
イベント拡張属性定義ファイルには,次の3種類のファイルがあります。
表2-22 イベント拡張属性定義ファイルの種類
項番 種類 説明 1 標準ファイル すべてのイベントに共通の基本属性,および拡張属性の共通情報に対するイベント詳細情報定義 2 連携製品提供ファイル JP1イベントを発行する連携製品の拡張属性の固有情報定義 3 ユーザー定義ファイル ユーザー定義の拡張属性の固有情報 上記表の項番1と項番2の2種類のファイルは,JP1/IMの定義ファイル格納先ディレクトリに格納されています。この2種類のファイルは,システム標準の定義情報であり,ユーザーの追加・変更・削除はできません。
新たにJP1イベントに対する拡張属性の固有情報を追加する場合,ユーザーは,項番3の定義ファイルを作成し,格納先ディレクトリに格納します。
作成契機
イベント拡張属性定義ファイルの作成契機を次に示します。
項番 ファイル 作成契機 1 default.conf JP1/IM - Manager インストール時に作成する。 2 hitachi_xxxx.conf JP1/IM - Manager インストール時に作成する。 3 会社名_製品名_attr.conf ユーザーが追加して個別に作成する。
定義の反映時期
JP1/IM - Managerを再起動したあとに有効になります。
記述内容
イベント拡張属性定義ファイルは,[イベント詳細]画面に表示するイベント属性の並び順や表示する属性名を定義します。
イベント拡張属性定義ファイルには,次の3種類のファイルがあります。
- すべてのイベントに共通の基本属性,および拡張属性の共通情報に対するイベント詳細情報定義(標準提供:default.conf)
- JP1イベントを発行する連携製品の拡張属性の固有情報定義(標準提供:hitachi_xxxx.conf)
- ユーザー定義の拡張属性の固有情報(ユーザーが個別作成)
標準提供される2種類のファイルはJP1/IM - Managerの定義ファイル格納ディレクトリに格納されています。この2種類のファイルはシステム標準定義情報であるため,ユーザーが追加,変更,削除できません。
新たにJP1イベントに対する拡張属性の固有情報を追加する場合は,この定義ファイル格納ディレクトリに「表2-2 定義ファイルの命名規則」の名称基準に従って作成した定義ファイルを格納してください。
この定義ファイルを作成する場合,次のことに注意してください。
- Linux版のJP1/IM - ManagerではUTF-8コード,Linux版以外のJP1/IM - ManagerではシフトJIS,またはEUCコードで定義する必要があります。
- 定義ファイルに誤って基本属性や拡張属性の共通情報を定義すると,[イベント詳細]画面を表示したときに標準提供の定義と重複して表示されます。
なお,JP1/IMには,イベント拡張属性定義ファイルの記述内容をチェックするためのコマンド「jcoattrfcheck」が用意されています。このコマンドの詳細については,「1. コマンド」を参照してください。
イベント拡張属性定義ファイルには,次のステートメントとブロックを記述できます。
表2-23 イベント拡張属性定義ファイルに記述できるステートメントおよびブロック
ステートメントまたはブロック 意味 @fileステートメント 定義ファイルタイプおよびバージョンを宣言する @productステートメント 定義中のプログラム情報を宣言する イベント拡張属性定義ブロック イベント属性の表示について定義する 属性グループ定義ブロック イベント属性のグループを定義する 属性表示順序定義ブロック [イベント詳細]画面表示時の順序をIDごとに定義する
記述内容(文字コードの指定)
- @encode
- イベント拡張属性定義ファイルで使用する文字コードを指定します。この項目は省略できます。
- 指定できる文字コードは,使用するOSの種類によって次のように異なります。
表2-24 指定できる文字コード
文字コード OSの種類 Windows Server 2003,Windows Server 2008 Solaris,AIX,HP-UX (IPF) Linux C ○ ○ ○ EUCJIS ○ ○ × SJIS ○ ○ × UTF-8 × × ○
- (凡例)
- ○:指定できる
- ×:指定できない
- 次の場合,エラーが出力されます。
- C,EUCJIS,SJISおよびUTF-8以外の文字コードを指定した場合
- @encodeを定義ファイルの先頭以外に記述した場合
- @encodeのあとに文字コードを指定しなかった場合
記述内容(ファイル内ステートメントの生成規則)
- @fileステートメント
- この定義ファイルがイベント拡張属性定義ファイルであること,および定義記述フォーマットのバージョンが0300であることを宣言します。このステートメントは必須です。
- なお,このステートメントは,ファイルの先頭行に記述しなければなりません。記述しない場合,動作は保証できません。
- 構文
@file type="extended-attributes-definition", version="0300";
- @productステートメント
- ファイル内で定義する各ステートメントのプロダクト情報を定義します。
- なお,定義する際には次の内容に注意してください。
- 指定値は,JP1イベントの拡張属性「PRODUCT_NAME」と一致させる必要があります。記述しない場合,動作は保証できません。
- 解析処理では,使用禁止文字や形式はチェックされません。指定した文字列がそのまま使用されます。
- 構文
@product name="プロダクト名";
- name="プロダクト名"
- プロダクト名は,スラントで区切られた半角英数字列です。次のどちらかの形式になります。
- /会社名/シリーズ名/プロダクト名
- /会社名/プロダクト名
- 定義例
- 定義情報ヘッダー用ステートメントの定義例を次に示します。
@file type="extended-attributes-definition", version="0300"; @product name="/HITACHI/JP1/CentralConsole"; @define-block type="event-attr-def"; block lang="Japanese", platform="NT"; attr name="E.SAMPLE_TIME", title="サンプル時刻"; attr name="E.SAMPLE_HOST", title="サンプルホスト"; attr name="E.SAMPLE_USER", title="サンプルユーザー"; @define-block-end;
記述内容(イベント拡張属性定義ファイルのブロックの生成規則)
イベント拡張属性定義ファイルに記述できるブロックについて説明します。なお,それぞれのブロックに記述できるステートメント以外のステートメントを記述した場合は,エラー出力され,該当するステートメントだけが無視されます。
- イベント拡張属性定義ブロック
- [イベント詳細]画面で,イベント属性名とその表示項目名(日本語名と英語名の両方)を関連づけます。このブロックは,定義ファイル内に複数個記述できます。ただし,ブロックのキーとなる属性(後述のblockステートメントの指定値)が同じブロックは,複数個記述できません。
- なお,日本語と英語の両方を指定する場合は,後述のattrステートメントの属性名が日本語と英語ですべて対応している必要があります。
- 記述できるステートメント種別
- このブロックには,次のステートメントを記述できます。
- blockステートメント
- attrステートメント
- 属性グループ定義ブロック
- イベント拡張属性定義ブロックで定義したイベント属性をグループ化します。グループ化することにより,属性表示順序定義ブロック内のorderステートメントで属性を何度も定義する必要がなくなります。
- このブロックは省略できます。
- 記述できるステートメント種別
- このブロックには,次のステートメントを記述できます。
- blockステートメント
- groupステートメント
- 属性表示順序定義ブロック
- イベント単位でそのイベントが詳細表示されたときに表示するイベント属性の順序や属性の表示名の順序を定義します。
- 記述できるステートメント種別
- このブロックには,次のステートメントを記述できます。
- blockステートメント
- orderステートメント
記述内容(イベント拡張属性定義ブロック内のステートメント生成規則)
- blockステートメント
- ブロックの属性を定義します。このステートメントは,ブロックの先頭に1回だけ記述できます。
- 構文
block lang=言語種別, platform=プラットフォーム種別;
- lang
- イベント拡張属性定義ブロックの言語種別を宣言します。指定できる言語種別を次に示します。
- "Japanese"
日本語環境時の定義であることを示します。
- "English"
英語環境時の定義であることを示します。
- platform
- ブロック内の定義が有効になるプラットフォームを指定します。
- 定義できるプラットフォームを次に示します。
- "base"
すべてのプラットフォームで有効にする場合に使用します。
- "ユーザー定義"
ユーザー定義のプラットフォームで有効になります。「ユーザー定義」には,半角英数字列だけを使用できます。ただし,この文字列についてエラーチェックは実行されません。
- platformパラメーターで指定したプラットフォーム名称は,JP1イベントの拡張属性「PLATFORM」と比較され,一致した場合にだけ詳細情報の処理の対象になります。したがって,ここに指定するプラットフォーム名と同一の文字列がJP1イベントの拡張属性「PLATFORM」にない場合は,処理の対象になりません。ただし,JP1イベントの発行時に拡張属性「PLATFORM」を設定していない場合は,「"base"」が指定されたものとしてファイルの解析が実行されます。
- 定義例
- 次の「attrステートメント」の定義例を参照してください。
- attrステートメント
- [イベント詳細]画面の属性名欄に表示する項目名と,属性値のタイプを指定します。このステートメントはブロック内に複数個指定できます。
- なお,このステートメントで定義するのは,基本属性,および拡張属性の共通情報を除いた拡張属性の固有情報だけです。拡張属性の固有情報以外が指定された場合,エラーは出力されないで処理が続行されますが,表示時には標準提供の定義と重複して表示されます。標準提供の定義については,次の「定義例」を参照してください。
- 構文
attr name=属性名, title=表示項目名[,type="elapsed_time/ date_format:CLIENT"];
- name
- 拡張属性名を定義します。値の形式は次のとおりです。
"E.拡張属性名"
- title
- [イベント詳細]画面表示時の属性名欄に表示する文字列を指定します。その際には,blockステートメントで指定した言語種別が使用されます。指定文字列に半角仮名を含めることはできません。
- type="elapsed_time/date_format:CLIENT"
- 属性値のタイプと表示形式を指定します。属性値「elapsed_time」は,UTC 1970年1月1日00:00:00からの経過秒数を10進文字列で表記した値です。表示形式「date_format:CLIENT」は,表示するビューアーのローカルタイムゾーンで指定された時刻を使用して,時刻形式で書式化して表示することを示します。
- 定義例
- JP1イベントの拡張属性の固有情報定義例を示します。プラットフォームが"W2K"で下記表の四つの拡張属性(固有情報)を表示させたい場合の「イベント拡張属性定義ブロック」の定義例を示します。
表2-25 イベント拡張属性定義ブロックの定義例
画面表示名 拡張属性名(固有情報) SAMPLE共通属性1 COMMON_ATTR1 SAMPLE共通属性2 COMMON_ATTR2 SAMPLE開始属性1 START_ATTR1 SAMPLE開始属性2 START_ATTR2 @define-block type="event-attr-def"; block lang="Japanese", platform="w2k"; attr name="E.COMMON_ATTR1", title="SAMPLE共通属性1"; attr name="E.COMMON_ATTR2", title="SAMPLE共通属性2"; attr name="E.START_ATTR1", title="SAMPLE開始属性1"; attr name="E.START_ATTR2", title="SAMPLE開始属性2"; @define-block-end;
記述内容(属性グループ定義ブロック内のステートメント生成規則)
- blockステートメント
- ブロックの属性を定義します。このステートメントは,ブロックの先頭に1回だけ記述できます。
- なお,定義する際には次の内容に注意してください。
- このブロックにはlangパラメーターは使用できません。
- 構文
block platform=プラットフォーム種別;
- platform
- ブロック内の定義が有効になるプラットフォームを指定します。指定できる値を次に示します。
- "base"
すべてのプラットフォームで有効にする場合に使用します。
- "ユーザー定義"
ユーザー定義のプラットフォームで有効になります。「ユーザー定義」には,半角英数字列だけを使用できます。ただし,この文字列についてエラーチェックは実行されません。
- platformパラメーターで指定したプラットフォーム名称は,JP1イベントの拡張属性「PLATFORM」と比較され,一致した場合にだけ詳細情報の処理の対象となります。したがって,ここに指定するプラットフォーム名と同一の文字列がイベントの拡張属性「PLATFORM」にない場合は,処理の対象となりません。ただし,JP1イベントの発行時に拡張属性「PLATFORM」を設定していない場合は,「"base"」が指定されたものとしてファイルの解析が実行されます。
- 定義例
- 次の「groupステートメント」の定義例を参照してください。
- groupステートメント
- [イベント詳細]画面上に表示する属性の並び順に名称を付けてグループ化します。このステートメントはブロック内に複数個指定できます。
- 構文
group name=グループ名, attrs=属性名並び;
- name
- 属性名並びに付ける名称を指定します。名称は,32バイト以内の半角英数字で指定します。大文字と小文字は区別されません。ここで付けた名称は,定義ファイル内のorderブロック中で使用できます。
- attrs
- グループ化する属性を一つ以上並べて指定します。複数個並べた場合は,[イベント詳細]画面に上からその順序で表示されます。指定形式は次のとおりです。
- 一つの場合:attrs="E.A0"
- 複数の場合:attrs="E.A0|E.A1"
- なお,指定できる属性は拡張属性の固有情報だけです。基本属性または拡張属性の共通情報を指定した場合は,指定した属性値が[イベント詳細]画面上に複数個表示されます。
- 定義例
- JP1イベントの基本属性および拡張属性の共通情報の定義を示します。これらの定義は,イベント拡張属性定義ファイルに標準で提供されています。
@define-block type="event-attr-group-def"; block platform="base"; group name="BASE", attrs="B.GROUPID|B.GROUPNAME|B.IDBASE|B.PROCESSID|B.SEQNO|B.SOURCEIPADDR| B.SOURCESEQNO|B.SOURCESERVER|B.TIME|B.USERID|B.USERNAME|B.ARRIVEDTIME"; group name="COMMON", attrs="E.SEVERITY|E.USER_NAME|E.PRODUCT_NAME|E.OBJECT_TYPE|E.OBJECT_NAME| E.ROOT_OBJECT_TYPE|E.ROOT_OBJECT_NAME|E.OBJECT_ID|E.OCCURRENCE| E.START_TIME|E.END_TIME|E.RESULT_CODE"; @define-block-end;
記述内容(属性表示順序定義ブロック内のステートメント生成規則)
- blockステートメント
- 属性表示順序定義ブロックに依存するブロック属性を定義します。このステートメントは,ブロックの先頭に1回だけ記述できます。
- なお,定義する際には次の内容に注意してください。
- このブロックではlangパラメーターは使用できません。
- 構文
block platform=プラットフォーム種別;
- platform
- ブロック内の定義が有効になるプラットフォームを指定します。定義できるプラットフォームを次に示します。
- "base"
すべてのプラットフォームで有効にする場合に使用します。
- "ユーザー定義"
ユーザー定義のプラットフォームで有効になります。「ユーザー定義」には,半角英数字だけを使用できます。ただし,この文字列についてエラーチェックは実行されません。
- platformパラメーターで指定したプラットフォーム名称は,JP1イベントの拡張属性「PLATFORM」と比較され,一致した場合にだけ詳細情報の処理の対象となります。したがって,ここに指定するプラットフォーム名と同一の文字列がイベントの拡張属性「PLATFORM」にない場合は,処理の対象となりません。ただし,JP1イベントの発行時に拡張属性「PLATFORM」を設定していない場合は,「"base"」が指定されたものとしてファイルの解析が実行されます。
- 定義例
- 次の「orderステートメント」の定義例を参照してください。
- orderステートメント
- [イベント詳細]画面上に表示する属性とその並び順をIDごとに定義します。このステートメントはブロック内に複数個指定できます。
- 構文
order id=イベントID定義文字列, attrs=属性名並び;
- id
- attrsパラメーターで指定した順序で属性を表示するイベントIDを一つ以上指定します。
- 指定形式は次のとおりです。
- 一つの場合:id="200"
- 複数の場合:id="100|101|102"
- イベントIDは,8けた以内の16進数文字列で指定します。8けた未満の場合,先頭に0を補って8けたにする必要はありません。16進数文字列の英字(a〜f)は,大文字と小文字のどちらでもかまいません。
- IDの範囲指定はできません。
- attrs
- 表示する属性,グループ,またはその両方が混在したものを並べて指定します。複数個並べた場合は,[イベント詳細]画面に上からその順序で表示されます。
- 指定形式は次のとおりです。
- 一つの場合:attrs="E.A0"
- 複数の場合:attrs="E.A0|E.A1|GROUP1"
- groupステートメントの場合と同様に,指定できる属性は固有の拡張属性だけです。基本属性または共通の拡張属性を指定した場合は,指定した属性値が[イベント詳細]画面上に複数個表示されます。
- 定義例
- イベントIDが00001000の場合にBASEグループとCOMMONグループを表示する定義例を次に示します。
@define-block type="event-attr-order-def"; block platform="base"; order id=00001000, attrs="BASE|COMMON" @define-block-end;
イベント拡張属性定義ファイルの定義例
@file type="extended-attributes-definition",version="0300"; @product name="/HITACHI/JP1/SAMPLE"; @define-block type="event-attr-def"; block platform="base", lang="Japanese"; attr name="E.SAMPLE_CLUSTER_NAME", title="クラスタ名"; attr name="E.SAMPLE_PRINT_SERVER_NAME", title="プリントサーバ名"; attr name="E.SAMPLE_PRINTER_NAME", title="プリンタ名"; attr name="E.SAMPLE_PORT_NAME", title="ポート名"; @define-block-end; @define-block type="event-attr-group-def"; block platform="base"; group name="_PRINTER_INFO", attrs="E.SAMPLE_PRINT_SERVER_NAME|E.SAMPLE_PRINTER_NAME"; group name="_CLUSTER_INFO", attrs="E.SAMPLE_CLUSTER_NAME|E.SAMPLE_PORT_NAME"; @define-block-end; @define-block type="event-attr-order-def"; block platform="base"; order id="00003100",attrs="_PRINTER_INFO"; order id="00003101",attrs="_CLUSTER_INFO"; order id="00003102", attrs="_PRINTER_INFO|_CLUSTER_INFO"; @define-block-end;
標準提供されているイベント拡張属性定義ファイル
JP1イベントの基本属性および拡張属性の共通情報の定義を次に示します。これらの定義は,イベント拡張属性定義ファイルとして標準提供されています。
@define-block type="event-attr-def"; block lang="Japanese", platform="base"; attr name="B.GROUPID", title="発行元グループID"; attr name="B.GROUPNAME", title="発行元グループ名"; attr name="B.IDBASE", title="イベントID"; attr name="B.PROCESSID", title="発行元プロセスID"; attr name="B.SEQNO", title="イベントDB内通し番号"; attr name="B.SOURCEIPADDR", title="発行元IPアドレス"; attr name="B.SOURCESEQNO", title="発行元イベントDB内通し番号"; attr name="B.SOURCESERVER", title="発行元イベントサーバ名"; attr name="B.TIME", title="登録時刻", type="elapsed_time/date_format:CLIENT"; attr name="B.USERID", title="発行元ユーザーID"; attr name="B.USERNAME", title="発行元ユーザー名"; attr name="B.ARRIVEDTIME", title="到着時間", type="elapsed_time/date_format:CLIENT"; attr name="E.SEVERITY", title="重要度"; attr name="E.USER_NAME", title="ユーザー名"; attr name="E.PRODUCT_NAME", title="プロダクト名"; attr name="E.OBJECT_TYPE", title="オブジェクトタイプ"; attr name="E.OBJECT_NAME", title="オブジェクト名"; attr name="E.ROOT_OBJECT_TYPE", title="登録名タイプ"; attr name="E.ROOT_OBJECT_NAME", title="登録名"; attr name="E.OBJECT_ID", title="オブジェクトID"; attr name="E.OCCURRENCE", title="事象種別"; attr name="E.START_TIME", title="開始時刻", type="elapsed_time/date_format:CLIENT"; attr name="E.END_TIME", title="終了時刻",type="elapsed_time/date_format:CLIENT"; attr name="E.RESULT_CODE", title="終了コード"; @define-block-end;
All Rights Reserved. Copyright (C) 2009, 2011, Hitachi, Ltd.