JP1/Cm2/SNMP System Observer

7.3.14　ユーザリソース定義ファイル

ユーザリソース定義ファイルは，ユーザ任意のリソースを収集する場合に定義します。ユーザリソース定義ファイルには，一つのリソースカテゴリの定義が記述できます。

＜この項の構成＞

(1)　書式

(2)　リソースカテゴリに関する定義内容

(3)　リソースに関する定義内容

(4)　サブリソースに関する定義内容

(5)　定義例

(6)　注意事項

(1)　書式

ユーザリソース定義ファイルの書式を，次に示します。

(2)　リソースカテゴリに関する定義内容

リソースカテゴリに関する定義内容を次の表に示します。

キー名値

rsc_category《USER》((32バイト以内の英数字および「-（ハイフン）」)) リソースカテゴリ名称を指定します。

リソースカテゴリ名称は「USER」で始める必要があります。また，「USER」を含め32バイト以内で記述する必要があります。

大文字と小文字は区別されません^※。ただし，名称の先頭の「USER」は大文字で記述してください。

注※　コマンド，GUIなどでカテゴリ名称を表示する場合は，大文字と小文字は区別されます。

リソースカテゴリに関する定義の注意事項を次に示します。

このフィールドは，ユーザリソース定義ファイルの先頭に記述してください。

このフィールドは，一つのユーザリソース定義ファイルで一つだけ記述することができます。

このフィールドを省略する場合は，キー名を含めて省略してください。

キー名	値
rsc_category《USER》((32バイト以内の英数字および「-（ハイフン）」))	リソースカテゴリ名称を指定します。リソースカテゴリ名称は「USER」で始める必要があります。また，「USER」を含め32バイト以内で記述する必要があります。大文字と小文字は区別されません^※。ただし，名称の先頭の「USER」は大文字で記述してください。

(3)　リソースに関する定義内容

リソースに関する定義内容を次の表に示します。各フィールドは，次の表の記載順序に従って記述してください。

キー名値

rsc_id
((10000～19999)) リソースIDを指定します。

rsc_label_j
《英語リソース名》((リソースグループとリソース，それぞれのラベル名称は32バイト以内)) 日本語リソース名を指定する場合に指定します。リソースグループのラベル名称とリソースのラベル名称を，「;（セミコロン）」で区切って指定します。リソース名に英語を使用する場合は省略します。マルチバイト文字のほか，半角の英数字，記号が使用できます。半角カタカナは使用できません。また，途中にタブ，スペース，「，（コンマ）」，「:（コロン）」，「;（セミコロン）」は指定できません。

rsc_label_e
((リソースグループとリソース，それぞれのラベル名称は32バイト以内)) リソースグループおよびリソースの英語ラベル名称を，「;（セミコロン）」で区切って指定します。
英語ラベル名称に使用できる文字は，タブ，スペース，「,（コンマ）」，「:（コロン）」，「;（セミコロン）」，「/（スラント）」，「\（エスケープ文字）」を除くASCII文字です。

rsc_units
《単位表示なし》リソースの単位を指定します。使用できる文字は，32バイト以内の英数字，「%（パーセント）」，「/（スラント）」，「_（アンダーバー）」，「-（ハイフン）」です。

rsc_threshold_MODE
《1》((1または2)) しきい値のモードを指定します。

正常＜警戒＜危険：1

危険＜警戒＜正常：2

リソースに関する定義の注意事項を次に示します。

該当するリソースカテゴリに関する定義に続けて，リソースの数だけ繰り返し記述してください。

項目を省略する場合は，値の記述だけを省略し，キー名と「=（イコール）」は必ず記述してください。

一つの定義ファイル内に同じリソースIDが複数定義されている場合，先に記述されているリソースの定義を有効とし，以降に記述されている定義は無視します。

「rsc_label_j」および「rsc_label_e」の値は，定義ファイル内でユニークな値を指定してください。

サマリリソース（String型MIBをデータ値とするサブリソースを含むリソース）の場合，「rsc_units」および「rsc_threshold_MODE」の定義は無視します。

キー名	値
rsc_id ((10000～19999))	リソースIDを指定します。
rsc_label_j 《英語リソース名》((リソースグループとリソース，それぞれのラベル名称は32バイト以内))	日本語リソース名を指定する場合に指定します。リソースグループのラベル名称とリソースのラベル名称を，「;（セミコロン）」で区切って指定します。リソース名に英語を使用する場合は省略します。マルチバイト文字のほか，半角の英数字，記号が使用できます。半角カタカナは使用できません。また，途中にタブ，スペース，「，（コンマ）」，「:（コロン）」，「;（セミコロン）」は指定できません。
rsc_label_e ((リソースグループとリソース，それぞれのラベル名称は32バイト以内))	リソースグループおよびリソースの英語ラベル名称を，「;（セミコロン）」で区切って指定します。英語ラベル名称に使用できる文字は，タブ，スペース，「,（コンマ）」，「:（コロン）」，「;（セミコロン）」，「/（スラント）」，「\（エスケープ文字）」を除くASCII文字です。
rsc_units 《単位表示なし》	リソースの単位を指定します。使用できる文字は，32バイト以内の英数字，「%（パーセント）」，「/（スラント）」，「_（アンダーバー）」，「-（ハイフン）」です。
rsc_threshold_MODE 《1》((1または2))	しきい値のモードを指定します。正常＜警戒＜危険：1 危険＜警戒＜正常：2

(4)　サブリソースに関する定義内容

サブリソースに関する定義は，一つ以上のインスタンスMIBオブジェクトの定義（省略可），一つ以上のサブリソースMIBオブジェクトの定義，および一つ以上のサブリソースの定義から構成されています。
［インスタンスMIBオブジェクトの定義］
　サブリソースMIBオブジェクトの定義
          ：
　サブリソースの定義
          ：
サブリソースに関する定義の注意事項を次に示します。

該当するリソースに関する定義に続けて，サブリソースの数だけ繰り返し記述してください。

(a)　インスタンスMIBオブジェクトに関する定義

インスタンスMIBオブジェクトに関する定義内容を，次の表に示します。各フィールドは，次の表の記載順序に従って記述してください。

キー名値

instance_mib_oid

subrsc_mib_oidに記述したMIBオブジェクトの接尾辞と接尾辞が一致するほかのMIBオブジェクトの値に置き換える場合にMIBオブジェクトIDを記述します。

MIBオブジェクトID，MIBオブジェクトの接尾辞を構成するオブジェクトに対して比較する番号（番号1;番号2），および置き換える番号（番号3）を，「;（セミコロン）」で区切って記述します。

MIBオブジェクトID には，subrsc_mib_oidに記述したMIBオブジェクトの接尾辞を置き換える，MIB値を取得するMIBオブジェクトIDを記述します。

番号1には，MIBオブジェクトIDに記述したMIBオブジェクトの接尾辞を構成するオブジェクトの何番目を，subrsc_mib_oidに記述したMIBオブジェクトの接尾辞と比較するかを記述します。番号1には1から32までの数値が記述できます。複数指定することもできます。その場合は昇順に「，（コンマ）」で区切って記述するか，先頭と末尾を「，（コンマ）」で区切って記述します。

番号2には，subrsc_mib_oidに記述したMIBオブジェクトの接尾辞を構成するオブジェクトの何番目を，MIBオブジェクトIDに記述したMIBオブジェクトの接尾辞と比較するかを記述します。番号2には1から32までの数値が記述できます。複数指定することもできます。その場合は昇順に「，（コンマ）」で区切って記述するか，先頭と末尾を「，（コンマ）」で区切って記述します。

番号3には，MIBオブジェクトID で記述したMIBオブジェクトのMIB値を，subrsc_mib_oidに記述したMIBオブジェクトの接尾辞を構成するオブジェクトの何番目と置き換えるかを記述します。番号3には1から32までの数値が記述できます。複数指定することもできます。その場合は昇順に「，（コンマ）」で区切って記述するか，先頭と末尾を「，（コンマ）」で区切って記述します。

MIBオブジェクトIDは必ず「.（ピリオド）」で始めてください。

instance_mib_type

instance_mib_oidに記述したMIBオブジェクトのオブジェクトタイプを記述します。「Counter」，「Gauge」，「Integer」，または「String」のどれかを指定してください。ただし，「Counter」を指定した場合のデータの扱いは「Gauge」を指定した場合と同等になります。オブジェクトタイプに対応するデータの扱いについては，「2.3.1　定義できるユーザリソース」の「表2-5　取得できるMIBオブジェクトのタイプ」を参照してください。

instance_mib_oidに記述したMIBオブジェクトのデータタイプがSNMPバージョン2のCounter64である場合は，SNMP設定ファイルで該当するリソースカテゴリに対応するSNMPバージョンを2に設定してください。SNMP設定ファイルについては，「7.3.6　SNMP定義ファイル（ssosnmp.conf）」を参照してください。

インスタンスMIBオブジェクトに関する注意事項を次に示します。

インスタンスMIBオブジェクトの定義全体を省略する場合は，キー名を含めて省略してください。

(b)　サブリソースMIBオブジェクトに関する定義内容

サブリソースMIBオブジェクトに関する定義内容を，次の表に示します。各フィールドは，次の表の記載順序に従って記述してください。

キー名値

subrsc_mib_oid MIBオブジェクトIDを指定します。

「.（ピリオド）」で始めてください。

ノードオブジェクトのMIBオブジェクトID（インスタンスを含まないMIBオブジェクトID）を指定します。

テーブル形式のMIBオブジェクトは，全インスタンスのMIB値を取得します。

subrsc_mib_type

subrsc_mib_oidに記述したMIBオブジェクトのオブジェクトタイプを記述します。「Counter」，「Gauge」，「Integer」，または「String」のどれかを指定してください。オブジェクトタイプに対応するデータの扱いについては，「2.3.1　定義できるユーザリソース」の「表2-5　取得できるMIBオブジェクトのタイプ」を参照してください。

subrsc_mib_oidに記述したMIBオブジェクトのデータタイプがSNMPバージョン2のCounter64である場合は，SNMP設定ファイルで該当するリソースカテゴリに対応するSNMPバージョンを2に設定してください。SNMP設定ファイルについては，「7.3.6　SNMP定義ファイル（ssosnmp.conf）」を参照してください。

subrsc_mib_typeに「Counter」を指定した場合，リソース値はこのサブリソースMIBオブジェクトの前回値からの増分によって計算されるため，収集開始直後（収集初回）はリソース値が算出されません。したがってこのリソースについては，収集データの保存，およびリソース状態変更イベントの発行は，収集開始から収集間隔時間経過後（収集2回目）から開始されます。

サブリソースMIBオブジェクトに関する定義の注意事項を次に示します。

該当するインスタンスMIBオブジェクトに関する定義に続けて，取得するMIBオブジェクトの数だけ繰り返し定義してください。

項目を省略する場合は，値だけを省略し，キー名と「=（イコール）」は必ず記述してください。

一つのリソース定義内に，同じ「subrsc_mib_oid」が複数定義されている場合，先に記述されているリソースの定義を有効とし，以降に記述されている定義は無視します。

一つのリソース定義内に，複数のサブリソースに関する定義を記述する場合は，サブリソースMIBオブジェクトの定義に記述する「subrsc_mib_oid」には，同じ接尾辞を持つMIBオブジェクトIDを記述してください。

サブリソースMIBオブジェクトは，最大26個定義できます。27個以上定義されている場合は，最初の26個の定義を有効とし，以降に記述されている定義は無視します。

(c)　サブリソースに関する定義内容

サブリソースに関する定義内容を，次の表に示します。各フィールドは，次の表の記載順序に従って記述してください。

キー名値

subrsc_label_j
《英語サブリソース名》((32バイト以内)) 日本語サブリソース名を指定します。マルチバイト文字のほか，半角の英数字，記号が使用できます。半角カタカナは使用できません。また，途中にタブ，スペース，「，（コンマ）」，「:（コロン）」，「;（セミコロン）」は使用できません。

subrsc_label_e
((32バイト以内)) 英語サブリソース名を指定します。
英語サブリソース名に使用できる文字は，タブ，スペース，「,（コンマ）」，「:（コロン）」，「;（セミコロン）」，「/（スラント）」，「\（エスケープ文字）」を除くASCII文字です。

subrsc_mib_data
(({ a～z }，演算子記号{ + , - , * , / }^※1，整数値，SamplingTime)) subrsc_mib_oidで指定した，どのMIB値をデータとするかを，subrsc_mib_oidで指定した順に割り振られる予約済みキーワードa～zと演算子記号で指定します。ただし，オブジェクトタイプがStringであるMIBを含む場合，予約済みキーワードは，単体で指定しなくてはなりません。そのため，演算子記号は記述できません。

MIB式^※2を指定する場合，表記記法は後置記法で指定します。なお，値と演算子の間には，一つ以上のスペースを入れてください。

収集間隔をMIB式に含めることもできます。この場合"SamplingTime"変数を指定します。実際の収集間隔（秒）がSamplingTimeに自動的に代入されます。^※3

注※1　ユーザリソースで使用できる演算方法は，四則演算だけです。

注※2　MIB式とは，値と演算子を後置記法で組み合わせたものです。中置記法によるMIB式"((a-b)/(a-b+c))＊100"は，後置記法では"a b - a b - c + / 100 ＊"となります。一つのMIB式に使用できる変数および定数の数は128個以内です。

注※3　"SamplingTime"を使った中置記法によるMIB式"(a-b)/SamplingTime"は，後置記法では"a b - SamplingTime /"となります。

サブリソースに関する定義を記述する場合の注意事項を次に示します。

該当するサブリソースMIBオブジェクトに関する定義に続けて，サブリソースの数だけ繰り返し記述してください。

項目を省略する場合は，値の記述だけを省略し，キー名と「=（イコール）」は必ず記述してください。

一つのユーザリソース定義ファイル内に，「subrsc_label_j」または「subrsc_label_e」の値が複数定義されている場合，先に記述されているリソースの定義を有効とし，以降に記述されている定義は無視します。

サブリソースは，最大32個定義できます。

String型MIBをデータ値とするサブリソースが一つでも含まれているリソースは，サマリリソース（単独の照会だけでき，収集（定期照会）ができないリソース）として取り扱われます。

キー名	値
instance_mib_oid	subrsc_mib_oidに記述したMIBオブジェクトの接尾辞と接尾辞が一致するほかのMIBオブジェクトの値に置き換える場合にMIBオブジェクトIDを記述します。 MIBオブジェクトID，MIBオブジェクトの接尾辞を構成するオブジェクトに対して比較する番号（番号1;番号2），および置き換える番号（番号3）を，「;（セミコロン）」で区切って記述します。 MIBオブジェクトID には，subrsc_mib_oidに記述したMIBオブジェクトの接尾辞を置き換える，MIB値を取得するMIBオブジェクトIDを記述します。番号1には，MIBオブジェクトIDに記述したMIBオブジェクトの接尾辞を構成するオブジェクトの何番目を，subrsc_mib_oidに記述したMIBオブジェクトの接尾辞と比較するかを記述します。番号1には1から32までの数値が記述できます。複数指定することもできます。その場合は昇順に「，（コンマ）」で区切って記述するか，先頭と末尾を「，（コンマ）」で区切って記述します。番号2には，subrsc_mib_oidに記述したMIBオブジェクトの接尾辞を構成するオブジェクトの何番目を，MIBオブジェクトIDに記述したMIBオブジェクトの接尾辞と比較するかを記述します。番号2には1から32までの数値が記述できます。複数指定することもできます。その場合は昇順に「，（コンマ）」で区切って記述するか，先頭と末尾を「，（コンマ）」で区切って記述します。番号3には，MIBオブジェクトID で記述したMIBオブジェクトのMIB値を，subrsc_mib_oidに記述したMIBオブジェクトの接尾辞を構成するオブジェクトの何番目と置き換えるかを記述します。番号3には1から32までの数値が記述できます。複数指定することもできます。その場合は昇順に「，（コンマ）」で区切って記述するか，先頭と末尾を「，（コンマ）」で区切って記述します。 MIBオブジェクトIDは必ず「.（ピリオド）」で始めてください。
instance_mib_type	instance_mib_oidに記述したMIBオブジェクトのオブジェクトタイプを記述します。「Counter」，「Gauge」，「Integer」，または「String」のどれかを指定してください。ただし，「Counter」を指定した場合のデータの扱いは「Gauge」を指定した場合と同等になります。オブジェクトタイプに対応するデータの扱いについては，「2.3.1　定義できるユーザリソース」の「表2-5　取得できるMIBオブジェクトのタイプ」を参照してください。 instance_mib_oidに記述したMIBオブジェクトのデータタイプがSNMPバージョン2のCounter64である場合は，SNMP設定ファイルで該当するリソースカテゴリに対応するSNMPバージョンを2に設定してください。SNMP設定ファイルについては，「7.3.6　SNMP定義ファイル（ssosnmp.conf）」を参照してください。

キー名	値
subrsc_mib_oid	MIBオブジェクトIDを指定します。「.（ピリオド）」で始めてください。ノードオブジェクトのMIBオブジェクトID（インスタンスを含まないMIBオブジェクトID）を指定します。テーブル形式のMIBオブジェクトは，全インスタンスのMIB値を取得します。
subrsc_mib_type	subrsc_mib_oidに記述したMIBオブジェクトのオブジェクトタイプを記述します。「Counter」，「Gauge」，「Integer」，または「String」のどれかを指定してください。オブジェクトタイプに対応するデータの扱いについては，「2.3.1　定義できるユーザリソース」の「表2-5　取得できるMIBオブジェクトのタイプ」を参照してください。 subrsc_mib_oidに記述したMIBオブジェクトのデータタイプがSNMPバージョン2のCounter64である場合は，SNMP設定ファイルで該当するリソースカテゴリに対応するSNMPバージョンを2に設定してください。SNMP設定ファイルについては，「7.3.6　SNMP定義ファイル（ssosnmp.conf）」を参照してください。 subrsc_mib_typeに「Counter」を指定した場合，リソース値はこのサブリソースMIBオブジェクトの前回値からの増分によって計算されるため，収集開始直後（収集初回）はリソース値が算出されません。したがってこのリソースについては，収集データの保存，およびリソース状態変更イベントの発行は，収集開始から収集間隔時間経過後（収集2回目）から開始されます。

キー名	値
subrsc_label_j 《英語サブリソース名》((32バイト以内))	日本語サブリソース名を指定します。マルチバイト文字のほか，半角の英数字，記号が使用できます。半角カタカナは使用できません。また，途中にタブ，スペース，「，（コンマ）」，「:（コロン）」，「;（セミコロン）」は使用できません。
subrsc_label_e ((32バイト以内))	英語サブリソース名を指定します。英語サブリソース名に使用できる文字は，タブ，スペース，「,（コンマ）」，「:（コロン）」，「;（セミコロン）」，「/（スラント）」，「\（エスケープ文字）」を除くASCII文字です。
subrsc_mib_data (({ a～z }，演算子記号{ + , - , * , / }^※1，整数値，SamplingTime))	subrsc_mib_oidで指定した，どのMIB値をデータとするかを，subrsc_mib_oidで指定した順に割り振られる予約済みキーワードa～zと演算子記号で指定します。ただし，オブジェクトタイプがStringであるMIBを含む場合，予約済みキーワードは，単体で指定しなくてはなりません。そのため，演算子記号は記述できません。 MIB式^※2を指定する場合，表記記法は後置記法で指定します。なお，値と演算子の間には，一つ以上のスペースを入れてください。収集間隔をMIB式に含めることもできます。この場合"SamplingTime"変数を指定します。実際の収集間隔（秒）がSamplingTimeに自動的に代入されます。^※3

(5)　定義例

ユーザリソース定義ファイルの定義例を次に示します。

(6)　注意事項

(a)　互換性

SSOでは，ユーザリソース定義ファイルおよびユーザリソース設定ファイルがバージョンによって使用できません。各バージョンでの互換性について次に示します。

ユーザリソース定義ファイルの互換性

SSO 07-00，07-10，07-50，および08-00で使用されていたユーザリソース定義ファイルは，変更や修正をしなくても，SSO 09-00で使用できます（ユーザリソース設定ファイルを作成できます）。

SSO 09-00で作成したユーザリソース定義ファイルの，SSO 07-00，07-10，07-50，および08-00での使用可否を次に示します。

String型のサブリソースMIBオブジェクトの定義を含む場合

SSO 07-00では使用できません（ユーザリソース設定ファイルを作成できない）。

SSO 07-10以降08-00以前では使用できます（ユーザリソース設定ファイルを作成できる）。

String型のサブリソースMIBオブジェクトの定義を含まない場合

SSO 07-00，07-10，07-50，および08-00で使用できます（ユーザリソース設定ファイルを作成できる）。

ユーザリソース設定ファイルの互換性

SSO 07-00，07-10，07-50，および08-00で使用されていたユーザリソース設定ファイルは，変更，修正，およびコンバートしなくても，SSO 09-00で使用できます。

SSO 09-00で作成したユーザリソース設定ファイルを，SSO 07-00，07-10，07-50，および08-00で使用する場合，次に示す動作となります。

SSO 07-00で使用する場合

String型のサブリソースMIBオブジェクトの定義を利用している場合，設定ファイルを無視します（読み込まない）。

String型のサブリソースMIBオブジェクトの定義を利用していない場合，問題なく使用できます（読み込み可能）。

SSO 07-10以降で使用する場合

問題なく使用できます。

(b)　ユーザリソース定義ファイルの格納場所

ユーザリソース設定ファイル格納ディレクトリ（UNIXの場合：$SSO_CONF/rsc，Windowsの場合：$SSO_CONF\sso\rsc）下にユーザリソース設定ファイル以外のファイルを配置しないでください。ユーザリソース設定ファイル格納ディレクトリ下にユーザリソース設定ファイル以外のファイル（ユーザリソース定義ファイル，そのほかのワークファイルなど）を配置すると，ssocolmngデーモンプロセスが不当にCPUを占有，または不当にメモリを消費することがあります。

(c)　ユーザリソース定義の変更手順

ユーザリソース定義の追加・変更・削除に当たっては，「2.3.2　ユーザリソースの定義方法」を参照してください。

(d)　リソース値算出時の0除算の扱い

リソース参照およびリソース収集時のリソース値算出の際，分母が0となる除算の結果は0として計算をします。

(e)　サブリソースIDについて

ユーザリソースのサブリソースに付与されるサブリソースIDは，自動的に割り当てられます。

「リソースに関する定義内容」中の「サブリソースに関する定義内容」の順番に，1から1ずつカウントアップし，サブリソースIDとして割り当てます。

例

リソースに関する定義内容の5番目に定義したサブリソースには，サブリソースID5が割り当てられます。

[目次][前へ][次へ]

[他社商品名称に関する表示]

7.3.14 ユーザリソース定義ファイル

7.3.14　ユーザリソース定義ファイル