7.3.7　ssoapmon動作定義ファイル（ssoapmon.def）

ssoapmon動作定義ファイルには，ssoapmonデーモンプロセスの機能を定義します。この定義ファイルの内容を変更した場合，次のどちらかを実行して変更した内容を有効にしてください。

ssoapcom -rコマンドを実行する。

ただし，変更したキーによっては有効にならないものがあります。
ssoapmonデーモンプロセスを再起動する。

〈この項の構成〉

(1)　書式
(2)　定義内容

(1)　書式

ssoapmon動作定義ファイルの書式を，次に示します。

[図データ]

ページの先頭へ

(2)　定義内容

ssoapmon動作定義ファイルの定義内容を，次の表に示します。

キー名	値
threshold-event: 《on》	NNMiに対して，プロセス状態変更イベント，サービス状態変更イベントおよびアプリケーション状態変更イベントを発行するかどうか設定します。イベントを発行する場合は「on」，発行しない場合は「off」を指定します。ただし，「on」を指定した場合でも，イベントフィルタ定義ファイル（ssoevtfilter.conf）でフィルタリングされたインシデントは発行されません。また，「off」を指定した場合，イベント送信先定義ファイル（ssodest.conf）に送信先を定義してもイベントは発行されません。
status-event: 《on》	NNMiに対して，監視状態変更イベントを発行するかどうか設定します。イベントを発行する場合は「on」，発行しない場合は「off」を指定します。ただし，「on」を指定した場合でも，イベントフィルタ定義ファイル（ssoevtfilter.conf）でフィルタリングされたインシデントは発行されません。また，「off」を指定した場合，イベント送信先定義ファイル（ssodest.conf）に送信先を定義してもイベントは発行されません。
nnm-urlaction-coop:^※1 《on》	NNMiマップ連携機能（アクション連携）を使用するかどうか設定します。使用する場合は「on」，使用しない場合は「off」を指定します。
nnm-map-coop:^※1 《on》	NNMiマップ連携機能（シンボル連携）を使用するかどうか設定します。使用する場合は「on」，使用しない場合は「off」を指定します。
map-status-warning:^※1 《minor》	NNMiマップ連携機能（シンボル連携）で，警戒域のアプリケーション状態に対応するNNMiのノードステータスを指定します。対応するノードステータスを注意域とする場合は「warning」，警戒域とする場合は「minor」，重要警戒域とする場合は「major」，危険域とする場合は「critical」を指定します。SSOのアプリケーション状態とNNMiのノードステータスの対応については，「2.6.3(2)　SSOの監視状態とNNMiに登録するステータスの対応」を参照してください。
map-status-critical:^※1 《major》	NNMiマップ連携機能（シンボル連携）で，危険域のアプリケーション状態に対応するNNMiのノードステータスを指定します。対応するノードステータスを重要警戒域とする場合は「major」，危険域とする場合は「critical」を指定します。SSOのアプリケーション状態とNNMiのノードステータスの対応については，「2.6.3(2)　SSOの監視状態とNNMiに登録するステータスの対応」を参照してください。
max-client:^※1 《16》((1〜99))	ssoapmonデーモンプロセスに接続するGUI，およびコマンド^※2との最大同時接続数を指定します。
change-my-address:^※1 《none》	監視マネージャに複数のIPアドレスがある場合やクラスタシステムで運用する場合に，SSOの動作IPアドレスを「n.n.n.n」の形式で指定します（nは0〜255の整数）。これ以外の場合は「none」を指定します。監視マネージャに複数のIPアドレスがある場合監視サーバと通信可能なIPアドレスを指定します。ただし，通信可能なIPアドレスが複数あるときは，監視マネージャの任意のIPアドレスを指定します。 SSOをクラスタシステムで運用する場合論理IPアドレスを指定します。 ssoapmon動作定義ファイルでのSSOの動作IPアドレスとは，監視サーバ側のAPMが監視マネージャに対して発行するイベントの送信先IPアドレスです。
snmp-address: 《default》	クラスタシステムで運用する場合に，論理IPアドレスを「n.n.n.n」の形式で指定します（nは0〜255の整数）。この指定によって，監視マネージャと監視サーバの間に存在するファイアウォールを通過させる監視マネージャのIPアドレスを，論理IPアドレスに固定できます。論理IPアドレスが複数存在する場合，すべての監視サーバと通信できる論理IPアドレスを指定してください。これ以外の場合は「default」を指定します。「default」を指定した場合，ファイアウォールを通過させる監視マネージャのIPアドレスは，監視サーバと通信できる自ホストのIPアドレスとなります。複数のIPアドレスが該当する場合は，不定となります。このキーの指定は，TCPヘルスチェックに対しては無効です。
max-snmp-session:^※1 《32》((1〜99))	監視マネージャから同時接続する監視サーバの数を指定します。
max-logfile-size: 《4》((1〜32メガバイト))	一つのログファイルの最大サイズを指定します。
logfile-num: 《3》((1〜10面))	ログファイルの面数を指定します。
trace: 《off》	障害発生時の調査用としてトレースファイルを出力するかどうかを設定します。出力する場合は「on」，出力しない場合は「off」を指定します。
max-tracefile-size: 《4》((1〜32メガバイト))	一つのトレースファイルの最大サイズを指定します。
tracefile-num: 《3》((1〜10面))	トレースファイルの面数を指定します。
event-lost-limit: 《50》((3〜160秒))	APMが発行したSNMPトラップイベントが消失したと判断するまでの待ち時間を指定します。イベントが遅延する場合の最大間隔を指定してください。^※3
event-lost-retry: 《1》((0〜5回))	イベント消失時のリトライ回数を指定します。ここで設定した回数リトライを繰り返しても監視を再開できない場合，イベントが消失したと判断します。
omit-unknown-event: 《off》	APMとの通信不能（通信エラー発生，停止イベント受信，イベント消失発生）を検出したときに発行する認識不能イベント^※4を抑止し，プロセス/サービス監視障害通知イベントを発行するかどうか設定します。通信不能検出時に認識不能イベント（状態変更イベントのうち，認識不能に変化したイベント）を発行する場合は「off」を指定します。通信不能検出時に認識不能イベントは発行しないで，代わりにプロセス/サービス監視障害通知イベントを発行する場合は「on」を指定します。認識不能イベントはプロセスの数だけ発行されますが，認識不能イベントをまとめて管理したい場合，プロセス/サービス監視障害通知イベントを発行します。
snmp-dump: 《off》	障害発生時の調査用としてSNMPパケットダンプを出力するかどうかを指定します。出力する場合は「on」，出力しない場合は「off」を指定します。
max-dumpfile-size: 《8》((0〜99メガバイト))	SNMPパケットダンプトレースファイルの最大サイズを指定します。 0を指定した場合は上限サイズなくトレースを取得します。
sso-start-hcheck-interval:^※1 《0》((0〜60秒))	SSO起動時のシステムヘルスチェックを，sso-start-hcheck-unitで指定した監視サーバ数の単位で実行する間隔を指定します。
sso-start-hcheck-delay:^※1 《0》((0〜600秒))	SSO起動時のシステムヘルスチェック開始遅延時間を指定します。
sso-start-hcheck-unit:^※1 《1》((1〜32))	SSO起動時のシステムヘルスチェックを，sso-start-hcheck-intervalで指定した間隔で順次実行する監視サーバ数を指定します。
apm-start-hcheck-delay: 《0》((0〜600秒))	APM起動イベント受信時のシステムヘルスチェック開始遅延時間を指定します。
hcheck-retry-count:^※5 《2》((0〜10回))	SSOがAPMとのヘルスチェックに失敗した場合のリトライ回数を指定します。0を指定した場合はリトライしません。
hcheck-retry-interval:^※5 《30》((0〜3,600秒))	SSOがAPMとのヘルスチェックに失敗した場合のリトライ間隔（秒）を指定します。0を指定した場合は各エージェントのヘルスチェック間隔の値を使用します。
max-apmevtfile-size: 《4》((1〜32メガバイト))	TCPイベントログファイルの最大サイズを指定します。
apmevtfile-num: 《3》((1〜10面))	TCPイベントログファイルの面数を指定します。
max-apm-session:^※1 《40》((1〜99))	APMから通知されるTCPイベントの同時接続数を指定します。
connect-retry-interval: 《10》((3〜60秒))	SSOがAPMへのTCP接続に失敗した場合のリトライ間隔を指定します。
apm-incident-check-interval:^※6 《5》((0〜60秒))	APMインシデントの有無をチェックする間隔を指定します。0を指定した場合，インシデントをチェックしません。
apm-incident-delete:^{※6 ※7}《on》	APMインシデントを削除するかどうかを指定します。APMインシデントチェックの場合に，その間隔に発生したインシデントを削除するときは「on」，削除しないときは「off」を指定します。なお，このキーが「on」の場合，ssoapmonデーモンプロセス起動時にNNMi上にあるすべてのAPMインシデントを削除します。
max-incident-logfile-size: 《4》((1〜32メガバイト))	一つのインシデントログファイルの最大サイズを指定します。
incident-logfile-num: 《3》((1〜10面))	インシデントログファイルの面数を指定します。
func-trace: 《on》	障害発生時の調査用として関数トレースを出力するかどうかを設定します。出力する場合は「on」，出力しない場合は「off」を指定します。func-trace:キーに「on」を指定した場合，ssoapmonプロセスのメモリが5メガバイト増加し，また関数トレースダンプファイルのサイズも5メガバイトになります。
nnm-start-policy:^※1 《0》((0または1))	SSO起動時にNNMi連携情報（ノード情報）の取得に失敗した場合の，ssoapmonデーモンプロセスの動作を0または1で指定します。 0の場合：デーモンプロセスを停止しない。 1の場合：デーモンプロセスを停止する。
tcpevent-select-time: 《800》((1〜600,000ミリ秒))	APMからのTCPイベント受信待ち時間を指定します。

キー名

値

threshold-event:

《on》

NNMiに対して，プロセス状態変更イベント，サービス状態変更イベントおよびアプリケーション状態変更イベントを発行するかどうか設定します。イベントを発行する場合は「on」，発行しない場合は「off」を指定します。ただし，「on」を指定した場合でも，イベントフィルタ定義ファイル（ssoevtfilter.conf）でフィルタリングされたインシデントは発行されません。また，「off」を指定した場合，イベント送信先定義ファイル（ssodest.conf）に送信先を定義してもイベントは発行されません。

status-event:

《on》

NNMiに対して，監視状態変更イベントを発行するかどうか設定します。イベントを発行する場合は「on」，発行しない場合は「off」を指定します。ただし，「on」を指定した場合でも，イベントフィルタ定義ファイル（ssoevtfilter.conf）でフィルタリングされたインシデントは発行されません。また，「off」を指定した場合，イベント送信先定義ファイル（ssodest.conf）に送信先を定義してもイベントは発行されません。

nnm-urlaction-coop:^※1

《on》

NNMiマップ連携機能（アクション連携）を使用するかどうか設定します。使用する場合は「on」，使用しない場合は「off」を指定します。

nnm-map-coop:^※1

《on》

NNMiマップ連携機能（シンボル連携）を使用するかどうか設定します。使用する場合は「on」，使用しない場合は「off」を指定します。

map-status-warning:^※1

《minor》

NNMiマップ連携機能（シンボル連携）で，警戒域のアプリケーション状態に対応するNNMiのノードステータスを指定します。対応するノードステータスを注意域とする場合は「warning」，警戒域とする場合は「minor」，重要警戒域とする場合は「major」，危険域とする場合は「critical」を指定します。SSOのアプリケーション状態とNNMiのノードステータスの対応については，「2.6.3(2)　SSOの監視状態とNNMiに登録するステータスの対応」を参照してください。

map-status-critical:^※1

《major》

NNMiマップ連携機能（シンボル連携）で，危険域のアプリケーション状態に対応するNNMiのノードステータスを指定します。対応するノードステータスを重要警戒域とする場合は「major」，危険域とする場合は「critical」を指定します。SSOのアプリケーション状態とNNMiのノードステータスの対応については，「2.6.3(2)　SSOの監視状態とNNMiに登録するステータスの対応」を参照してください。

max-client:^※1

《16》((1〜99))

ssoapmonデーモンプロセスに接続するGUI，およびコマンド^※2との最大同時接続数を指定します。

change-my-address:^※1

《none》

監視マネージャに複数のIPアドレスがある場合やクラスタシステムで運用する場合に，SSOの動作IPアドレスを「n.n.n.n」の形式で指定します（nは0〜255の整数）。これ以外の場合は「none」を指定します。

監視マネージャに複数のIPアドレスがある場合

監視サーバと通信可能なIPアドレスを指定します。ただし，通信可能なIPアドレスが複数あるときは，監視マネージャの任意のIPアドレスを指定します。
SSOをクラスタシステムで運用する場合

論理IPアドレスを指定します。

ssoapmon動作定義ファイルでのSSOの動作IPアドレスとは，監視サーバ側のAPMが監視マネージャに対して発行するイベントの送信先IPアドレスです。

snmp-address:

《default》

クラスタシステムで運用する場合に，論理IPアドレスを「n.n.n.n」の形式で指定します（nは0〜255の整数）。この指定によって，監視マネージャと監視サーバの間に存在するファイアウォールを通過させる監視マネージャのIPアドレスを，論理IPアドレスに固定できます。

論理IPアドレスが複数存在する場合，すべての監視サーバと通信できる論理IPアドレスを指定してください。

これ以外の場合は「default」を指定します。「default」を指定した場合，ファイアウォールを通過させる監視マネージャのIPアドレスは，監視サーバと通信できる自ホストのIPアドレスとなります。複数のIPアドレスが該当する場合は，不定となります。このキーの指定は，TCPヘルスチェックに対しては無効です。

max-snmp-session:^※1

《32》((1〜99))

監視マネージャから同時接続する監視サーバの数を指定します。

max-logfile-size:

《4》((1〜32メガバイト))

一つのログファイルの最大サイズを指定します。

logfile-num:

《3》((1〜10面))

ログファイルの面数を指定します。

trace:

《off》

障害発生時の調査用としてトレースファイルを出力するかどうかを設定します。出力する場合は「on」，出力しない場合は「off」を指定します。

max-tracefile-size:

《4》((1〜32メガバイト))

一つのトレースファイルの最大サイズを指定します。

tracefile-num:

《3》((1〜10面))

トレースファイルの面数を指定します。

event-lost-limit:

《50》((3〜160秒))

APMが発行したSNMPトラップイベントが消失したと判断するまでの待ち時間を指定します。イベントが遅延する場合の最大間隔を指定してください。^※3

event-lost-retry:

《1》((0〜5回))

イベント消失時のリトライ回数を指定します。ここで設定した回数リトライを繰り返しても監視を再開できない場合，イベントが消失したと判断します。

omit-unknown-event:

《off》

APMとの通信不能（通信エラー発生，停止イベント受信，イベント消失発生）を検出したときに発行する認識不能イベント^※4を抑止し，プロセス/サービス監視障害通知イベントを発行するかどうか設定します。

通信不能検出時に認識不能イベント（状態変更イベントのうち，認識不能に変化したイベント）を発行する場合は「off」を指定します。通信不能検出時に認識不能イベントは発行しないで，代わりにプロセス/サービス監視障害通知イベントを発行する場合は「on」を指定します。

認識不能イベントはプロセスの数だけ発行されますが，認識不能イベントをまとめて管理したい場合，プロセス/サービス監視障害通知イベントを発行します。

snmp-dump:

《off》

障害発生時の調査用としてSNMPパケットダンプを出力するかどうかを指定します。出力する場合は「on」，出力しない場合は「off」を指定します。

max-dumpfile-size:

《8》((0〜99メガバイト))

SNMPパケットダンプトレースファイルの最大サイズを指定します。

0を指定した場合は上限サイズなくトレースを取得します。

sso-start-hcheck-interval:^※1

《0》((0〜60秒))

SSO起動時のシステムヘルスチェックを，sso-start-hcheck-unitで指定した監視サーバ数の単位で実行する間隔を指定します。

sso-start-hcheck-delay:^※1

《0》((0〜600秒))

SSO起動時のシステムヘルスチェック開始遅延時間を指定します。

sso-start-hcheck-unit:^※1

《1》((1〜32))

SSO起動時のシステムヘルスチェックを，sso-start-hcheck-intervalで指定した間隔で順次実行する監視サーバ数を指定します。

apm-start-hcheck-delay:

《0》((0〜600秒))

APM起動イベント受信時のシステムヘルスチェック開始遅延時間を指定します。

hcheck-retry-count:^※5

《2》((0〜10回))

SSOがAPMとのヘルスチェックに失敗した場合のリトライ回数を指定します。0を指定した場合はリトライしません。

hcheck-retry-interval:^※5

《30》((0〜3,600秒))

SSOがAPMとのヘルスチェックに失敗した場合のリトライ間隔（秒）を指定します。0を指定した場合は各エージェントのヘルスチェック間隔の値を使用します。

max-apmevtfile-size:

《4》((1〜32メガバイト))

TCPイベントログファイルの最大サイズを指定します。

apmevtfile-num:

《3》((1〜10面))

TCPイベントログファイルの面数を指定します。

max-apm-session:^※1

《40》((1〜99))

APMから通知されるTCPイベントの同時接続数を指定します。

connect-retry-interval:

《10》((3〜60秒))

SSOがAPMへのTCP接続に失敗した場合のリトライ間隔を指定します。

apm-incident-check-interval:^※6

《5》((0〜60秒))

APMインシデントの有無をチェックする間隔を指定します。0を指定した場合，インシデントをチェックしません。

apm-incident-delete:^{※6 ※7}《on》

APMインシデントを削除するかどうかを指定します。APMインシデントチェックの場合に，その間隔に発生したインシデントを削除するときは「on」，削除しないときは「off」を指定します。なお，このキーが「on」の場合，ssoapmonデーモンプロセス起動時にNNMi上にあるすべてのAPMインシデントを削除します。

max-incident-logfile-size:

《4》((1〜32メガバイト))

一つのインシデントログファイルの最大サイズを指定します。

incident-logfile-num:

《3》((1〜10面))

インシデントログファイルの面数を指定します。

func-trace:

《on》

障害発生時の調査用として関数トレースを出力するかどうかを設定します。出力する場合は「on」，出力しない場合は「off」を指定します。func-trace:キーに「on」を指定した場合，ssoapmonプロセスのメモリが5メガバイト増加し，また関数トレースダンプファイルのサイズも5メガバイトになります。

nnm-start-policy:^※1

《0》((0または1))

SSO起動時にNNMi連携情報（ノード情報）の取得に失敗した場合の，ssoapmonデーモンプロセスの動作を0または1で指定します。

0の場合：デーモンプロセスを停止しない。
1の場合：デーモンプロセスを停止する。

tcpevent-select-time:

《800》((1〜600,000ミリ秒))

APMからのTCPイベント受信待ち時間を指定します。

注※1　値を変更した場合，ssoapmonデーモンプロセスを再起動する必要があります。

注※2　ssoapmonデーモンプロセスと接続するGUI，およびコマンドを次に示します。

プロセスモニタウィンドウ
プロセス監視条件参照ウィンドウ
プロセス監視条件設定ウィンドウ
ssoapcomコマンド
ssopschkコマンド
ssopssetコマンド
ssopsshowコマンド
ssopsstartコマンド
ssopsstopコマンド

注※3　event-lost-limit:キーの設定値は，次の計算式で算出した値を指定してください。

event-lost-limit:キーの設定値 = A × 2 + 40

A：次に示す定義ファイル内のキー値のうち，設定値の大きい方

・イベント遅延定義ファイル（apmdelay.conf）のDINTERVAL:キー

・ssoapmon動作定義ファイル（ssoapmon.def）のapm-incident-check-interval:キー

注※4　認識不能イベントの抑止契機を次の表に示します。

契機	内容
APM停止イベント受信時	APMからAgent for Process停止イベントを受信したとき。
ヘルスチェック失敗時	APMに対するヘルスチェックに失敗したとき。
通信エラー発生時	APMに対する要求処理（監視条件変更，監視間隔変更，最新の状態に更新など）に失敗したとき。
イベントロスト検出時	APMからのイベントが消失したとき。

注※5　ヘルスチェックのリトライは，以下の契機で実施します。

APMからの起動イベントを受信した場合
ヘルスチェック間隔が満了し，かつ前回のヘルスチェックが成功している場合
SSOが停止中と認識しているAPMから停止イベント以外のイベントを受信した場合
ssoapcom -Hコマンドを実行した場合
APMからのイベント通知でTCPを使用している際のTCP接続およびイベント送受信で何らかのエラーを検知した場合

注※6　APMインシデントとは，APMがSNMPトラップによって通知したイベントがNNMiで受信されてインシデントに変換されたものです。

注※7　NNMiが受信可能なSNMPトラップ数には上限があります。上限付近になるとAPMからのSNMPトラップイベントがインシデントに変換されなくなるため，プロセス監視できなくなります。このため，NNMiの受信トラップ数が上限付近にならないように注意してください。NNMiのSNMPトラップ受信および受信SNMPトラップのインシデント変換仕様については，NNMiのオンラインヘルプを参照してください。

ssoapmon動作定義ファイルを記述する場合の注意事項を次に示します。

ファイル内に同じ項目に対する定義がある場合，あとに記述されている定義を有効とし，先に記述されている定義は無視します。
キーの指定を省略する場合は，その行全体を省略してください。
ssoapmonデーモンプロセスが同時にオープンするファイル数の上限は，次の計算式で求められます。
```
(max-clientの値) + (max-snmp-sessionの値) + (max-apm-sessionの値) +20
```
max-client:キーの値は次の計算式で求められます。
```
max-client ≧
         (同時起動ウィンドウ数^※1+同時実行コマンド数^※2)×監視マネージャ数
```
注※1　同時起動ウィンドウとは以下のウィンドウを指します。

プロセスモニタウィンドウ，プロセス監視設定ウィンドウ，プロセス監視条件参照ウィンドウ

注※2　同時実行コマンドとは以下のコマンドを指します。

ssopsset，ssopsstart，ssopsstop，ssopschk，ssoapcom，ssopscvt，ssopsshow
max-snmp-session:キーの値は次の計算式で求められます。
```
max-snmp-session＞監視マネージャと通信できない監視サーバ数
```
注

監視マネージャと通信できない監視サーバの数がmax-snmp-session:キーの値を超えた場合，ヘルスチェックが遅延し設定値どおりとならないことがあります。その場合，上記見積もり式に合うよう調整するか，ヘルスチェック間隔を広げてください。
max-apm-session:キーの値は次の計算式で求められます。

注

APMのリトライ回数を上限値で算出し，max-apm-session:キーの値が設定可能な最大値99を超える場合は，設定値を99にして，定期ヘルスチェック機能を有効にしてください。

なおAPMのリトライ回数設定については，「7.4.7　イベントTCP通知定義ファイル（apmtcpsend.conf）」を参照してください。

ページの先頭へ

7.3.7 ssoapmon動作定義ファイル（ssoapmon.def）

(1) 書式

(2) 定義内容

7.3.7　ssoapmon動作定義ファイル（ssoapmon.def）

(1)　書式

(2)　定義内容