Embedded Event Manager（EEM）アプリケーションの揮発性データを読み取ります。この Tcl コマンド拡張では、EEM アプリケーションの揮発性データの読み取りがサポートされます。EEM アプリケーションの揮発性データは、API をパブリッシュする EEM アプリケーションが使用される Cisco ソフトウェア プロセスによってパブリッシュすることができます。EEM アプリケーションの揮発性データは、EEM ポリシーによってパブリッシュできません。

Note	現在、アプリケーション揮発性データをパブリッシュする Cisco ソフトウェアはありません。

構文

appl_read name ? length ?

引数

結果文字列

data %s

data は、読み取られる、アプリケーションによってパブリッシュされた文字列データです。

_cerrno を設定

対応

(_cerr_sub_err =  2)    FH_ESYSERR  (generic/unknown error from OS/system)

このエラーは、オペレーティング システムによってレポートされたエラーを意味します。エラーとともにレポートされる POSIX errno 値を使用して、オペレーティング システム エラーの原因を調べます。

(_cerr_sub_err =  7)    FH_ENOSUCHKEY  (could not find key)

このエラーは、アプリケーション イベント ディテクタ情報キーまたはその他の ID が見つからなかったことを意味します。

(_cerr_sub_err =  9)    FH_EMEMORY  (insufficient memory for request)

このエラーは、メモリの内部 EEM 要求に障害が発生したことを意味します。

Embedded Event Manager（EEM）から、前に保存された情報が取得されます。この Tcl コマンド拡張によって、一意のキーで前に保存された EEM からの情報の取得がサポートされます。これは、情報を取得するために指定する必要があります。情報の取得によって、その情報が EEM から削除されることに、注意してください。再度取得できるようにするには、再保存する必要があります。

構文

appl_reqinfo key ?

引数

結果文字列

data %s

data は、取得されるアプリケーション文字列データです。

_cerrno を設定

対応

(_cerr_sub_err =  2)    FH_ESYSERR  (generic/unknown error from OS/system)

このエラーは、オペレーティング システムによってレポートされたエラーを意味します。エラーとともにレポートされる POSIX errno 値を使用して、オペレーティング システム エラーの原因を調べます。

(_cerr_sub_err =  7)    FH_ENOSUCHKEY  (could not find key)

このエラーは、アプリケーション イベント ディテクタ情報キーまたはその他の ID が見つからなかったことを意味します。

Embedded Event Manager（EEM）に情報を保存します。この Tcl コマンド拡張によって、同じポリシーまたは別のポリシーによって、後で取得できる Embedded Event Manager への情報の保存がサポートされます。一意のキーを指定する必要があります。このキーを使用すると、情報を後で取得することができます。

構文

appl_setinfo key ? data ?

引数

結果文字列

なし

_cerrno を設定

対応

(_cerr_sub_err =  2)    FH_ESYSERR  (generic/unknown error from OS/system)

このエラーは、オペレーティング システムによってレポートされたエラーを意味します。エラーとともにレポートされる POSIX errno 値を使用して、オペレーティング システム エラーの原因を調べます。

(_cerr_sub_err =  8)    FH_EDUPLICATEKEY  (duplicate appl info key)

このエラーは、アプリケーション イベント ディテクタ情報キーまたはその他の ID が重複していたことを意味します。

(_cerr_sub_err =  9)    FH_EMEMORY  (insufficient memory for request)

このエラーは、メモリの内部 EEM 要求に障害が発生したことを意味します。

(_cerr_sub_err = 34)    FH_EMAXLEN  (maximum length exceeded)

このエラーは、オブジェクト長またはオブジェクト数が、最大値を超えたことを意味します。

(_cerr_sub_err = 43)    FH_EBADLENGTH  (bad API length)

このエラーは、API メッセージ長が無効であったことを意味します。

カウンタの値を変更します。

構文

counter_modify event_id ? val ? op nop|set|inc|dec

引数

結果文字列

val_remain %d

val_remain は、カウンタの現在の値です。

_cerrno を設定

対応

(_cerr_sub_err =  2)    FH_ESYSERR  (generic/unknown error from OS/system)

このエラーは、オペレーティング システムによってレポートされたエラーを意味します。エラーとともにレポートされる POSIX errno 値を使用して、オペレーティング システム エラーの原因を調べます。

(_cerr_sub_err = 11)    FH_ENOSUCHESID  (unknown event specification ID)

このエラーは、イベントが登録されたときか、またはイベント ディテクタの内部イベント構造が破損したときに、イベント指定 ID を照会できなかったことを意味します。

(_cerr_sub_err = 22)    FH_ENULLPTR  (event detector internal error - ptr is null)

このエラーは、内部 EEM イベント ディテクタ ポインタに値が含まれている必要があったときに、ヌルであったことを意味します。

(_cerr_sub_err = 30)    FH_ECTBADOPER  (bad counter threshold operator)

このエラーは、カウンタ イベント ディテクタの設定演算子または変更演算子が、無効であったことを意味します。

記録されたポリシーの簡単な説明を記述します。

構文

description ? 

引数

結果文字列

なし

_cerrno を設定

対応

使用例

説明文は、ポリシーの作成者によって入力されます。Tcl のイベント登録文の前または後に表示できます。ポリシーには、1 つの説明のみ使用できます。

Note	1 つのポリシーに複数の説明文を登録した場合、障害が発生します。

次に、event_register_syslog ポリシーに簡単な説明が指定される例を示します。

::cisco::eem::description "This Tcl command looks for the word count in syslog messages."
::cisco::eem::event_register_syslog tag 1 ...
::cisco::eem::event_register_snmp_object tag 2 ...
::cisco::eem::trigger {
       ::cisco::eem::correlate event 1 and event 2
       ::cisco::eem::attribute tag 1 occurs 1
       ::cisco::eem::attribute tag 2 occurs 1
}

最後にソフトウェアがブートされて以来の経過時間を返します。この Tcl コマンド拡張を使用すると、配列「nsec nnnn」に、ブート以降のナノ秒数が返されます。ここで、nnnn はナノ秒数です。

構文

fts_get_stamp

引数

なし

結果文字列

nsec %d

nsec は、ブート以降のナノ秒数です。

_cerrno を設定

非対応

カウンタを登録し、カウンタ イベント ID を返します。この Tcl コマンド拡張は、カウンタのパブリッシャによって使用され、イベント ID を使用してカウンタを操作する前に、この登録が実行されます。

構文

register_counter name ?

引数

結果文字列

event_id %d 
event_spec_id %d

event_id は、指定されたカウンタのカウンタイベント ID です。unregister_counter または counter_modify Tcl コマンド拡張によって、カウンタの操作に使用されます。event_spec_id 引数は、指定されたカウンタのイベント指定 ID です。

_cerrno を設定

対応

(_cerr_sub_err =  2)    FH_ESYSERR  (generic/unknown error from OS/system)

このエラーは、オペレーティング システムによってレポートされたエラーを意味します。エラーとともにレポートされる POSIX errno 値を使用して、オペレーティング システム エラーの原因を調べます。

(_cerr_sub_err =  4)    FH_EINITONCE  (Init() is not yet done, or done twice.)

このエラーは、EEM イベント ディテクタがその初期化を完了する前に、特定のイベントを登録する要求が行われたことを意味します。

(_cerr_sub_err =  6)    FH_EBADEVENTTYPE  (unknown EEM event type)

このエラーは、内部イベント指定で指定されたイベント タイプが無効であったことを意味します。

(_cerr_sub_err =  9)    FH_EMEMORY  (insufficient memory for request)

このエラーは、メモリの内部 EEM 要求に障害が発生したことを意味します。

(_cerr_sub_err = 10)    FH_ECORRUPT  (internal EEM API context is corrupt)

このエラーは、内部 EEM API コンテキスト構造が破損したことを意味します。

(_cerr_sub_err = 11)    FH_ENOSUCHESID  (unknown event specification ID)

このエラーは、イベントが登録されたときか、またはイベント ディテクタの内部イベント構造が破損したときに、イベント指定 ID を照会できなかったことを意味します。

(_cerr_sub_err = 12)    FH_ENOSUCHEID  (unknown event ID)

このエラーは、イベントが登録されたときか、またはイベント ディテクタの内部イベント構造が破損したときに、イベント ID を照会できなかったことを意味します。

(_cerr_sub_err = 16)    FH_EBADFMPPTR  (bad ptr to fh_p data structure)

このエラーは、各 EEM API コールで使用されるコンテキスト ポインタが不正確であったことを意味します。

(_cerr_sub_err = 17)    FH_EBADADDRESS  (bad API control block address)

このエラーは、EEM API に渡された制御ブロック アドレスが不正確であったことを意味します。

(_cerr_sub_err = 22)    FH_ENULLPTR  (event detector internal error - ptr is null)

このエラーは、内部 EEM イベント ディテクタ ポインタに値が含まれている必要があったときに、ヌルであったことを意味します。

(_cerr_sub_err = 25)    FH_ESUBSEXCEED  (number of subscribers exceeded)

このエラーは、タイマーまたはカウンタのサブスクライバの数が、最大値を超えたことを意味します。

(_cerr_sub_err = 26)    FH_ESUBSIDXINV  (invalid subscriber index)

これは、サブスクライバの索引が無効であったことを意味します。

(_cerr_sub_err = 54)    FH_EFDUNAVAIL  (connection to event detector unavailable)

このエラーは、イベント ディテクタが使用できなかったことを意味します。

(_cerr_sub_err = 56)    FH_EFDCONNERR  (event detector connection error)

このエラーは、この要求を処理する EEM イベント ディテクタは使用できないことを意味します。

タイマーを登録し、タイマー イベント ID を返します。この Tcl コマンド拡張は、カウンタのパブリッシャによって使用され、パブリッシャまたはサブスクライバとしての登録に、event_register_timer コマンド拡張が使用されなかった場合に、イベント ID を使用してタイマーを操作する前に、この登録が実行されます。

構文

register_timer watchdog|countdown|absolute|cron name ?

引数

結果文字列

event_id %u

event_id は指定したタイマーのタイマーイベント ID です（これを使用して、timer_arm または timer_cancel コマンド拡張によってタイマーを操作するために使用されます）。

_cerrno を設定

対応

(_cerr_sub_err =  2)    FH_ESYSERR  (generic/unknown error from OS/system)

このエラーは、オペレーティング システムによってレポートされたエラーを意味します。エラーとともにレポートされる POSIX errno 値を使用して、オペレーティング システム エラーの原因を調べます。

(_cerr_sub_err =  4)    FH_EINITONCE  (Init() is not yet done, or done twice.)

このエラーは、EEM イベント ディテクタがその初期化を完了する前に、特定のイベントを登録する要求が行われたことを意味します。

(_cerr_sub_err =  6)    FH_EBADEVENTTYPE  (unknown EEM event type)

このエラーは、内部イベント指定で指定されたイベント タイプが無効であったことを意味します。

(_cerr_sub_err =  9)    FH_EMEMORY  (insufficient memory for request)

このエラーは、メモリの内部 EEM 要求に障害が発生したことを意味します。

(_cerr_sub_err = 10)    FH_ECORRUPT  (internal EEM API context is corrupt)

このエラーは、内部 EEM API コンテキスト構造が破損したことを意味します。

(_cerr_sub_err = 11)    FH_ENOSUCHESID  (unknown event specification ID)

このエラーは、イベントが登録されたときか、またはイベント ディテクタの内部イベント構造が破損したときに、イベント指定 ID を照会できなかったことを意味します。

(_cerr_sub_err = 16)    FH_EBADFMPPTR  (bad ptr to fh_p data structure)

このエラーは、各 EEM API コールで使用されるコンテキスト ポインタが不正確であったことを意味します。

(_cerr_sub_err = 17)    FH_EBADADDRESS  (bad API control block address)

このエラーは、EEM API に渡された制御ブロック アドレスが不正確であったことを意味します。

(_cerr_sub_err = 22)    FH_ENULLPTR  (event detector internal error - ptr is null)

このエラーは、内部 EEM イベント ディテクタ ポインタに値が含まれている必要があったときに、ヌルであったことを意味します。

(_cerr_sub_err = 25)    FH_ESUBSEXCEED  (number of subscribers exceeded)

このエラーは、タイマーまたはカウンタのサブスクライバの数が、最大値を超えたことを意味します。

(_cerr_sub_err = 26)    FH_ESUBSIDXINV  (invalid subscriber index)

これは、サブスクライバの索引が無効であったことを意味します。

(_cerr_sub_err = 54)    FH_EFDUNAVAIL  (connection to event detector unavailable)

このエラーは、イベント ディテクタが使用できなかったことを意味します。

(_cerr_sub_err = 56)    FH_EFDCONNERR  (event detector connection error)

このエラーは、この要求を処理する EEM イベント ディテクタは使用できないことを意味します。

タイマーを搭載します。タイプは、CRON、ウォッチドッグ、カウントダウン、または絶対の場合があります。

構文

timer_arm event_id ? cron_entry ?|time ?

引数

結果文字列

sec_remain %ld msec_remain %ld

sec_remain および msec_remain は、タイマーの次の期限切れまでの残り時間です。

Note	タイマー タイプが CRON の場合、sec_remain 引数および msec_remain 引数には 0 が返されます。

_cerrno を設定

対応

(_cerr_sub_err =  2)    FH_ESYSERR  (generic/unknown error from OS/system)

このエラーは、オペレーティング システムによってレポートされたエラーを意味します。エラーとともにレポートされる POSIX errno 値を使用して、オペレーティング システム エラーの原因を調べます。

(_cerr_sub_err =  6)    FH_EBADEVENTTYPE  (unknown EEM event type)

このエラーは、内部イベント指定で指定されたイベント タイプが無効であったことを意味します。

(_cerr_sub_err =  9)    FH_EMEMORY  (insufficient memory for request)

このエラーは、メモリの内部 EEM 要求に障害が発生したことを意味します。

(_cerr_sub_err = 11)    FH_ENOSUCHESID  (unknown event specification ID)

このエラーは、イベントが登録されたときか、またはイベント ディテクタの内部イベント構造が破損したときに、イベント指定 ID を照会できなかったことを意味します。

(_cerr_sub_err = 12)    FH_ENOSUCHEID  (unknown event ID)

このエラーは、イベントが登録されたときか、またはイベント ディテクタの内部イベント構造が破損したときに、イベント ID を照会できなかったことを意味します。

(_cerr_sub_err = 22)    FH_ENULLPTR  (event detector internal error - ptr is null)

このエラーは、内部 EEM イベント ディテクタ ポインタに値が含まれている必要があったときに、ヌルであったことを意味します。

(_cerr_sub_err = 27)    FH_ETMDELAYZR  (zero delay time)

このエラーは、タイマーの搭載に指定された時間がゼロであったことを意味します。

(_cerr_sub_err = 42)    FH_ENOTREGISTERED  (request for event spec that is unregistered)

このエラーは、イベント検出が登録できなかったことを意味します。

(_cerr_sub_err = 54)    FH_EFDUNAVAIL  (connection to event detector unavailable)

このエラーは、イベント ディテクタが使用できなかったことを意味します。

(_cerr_sub_err = 56)    FH_EFDCONNERR  (event detector connection error)

このエラーは、この要求を処理する EEM イベント ディテクタは使用できないことを意味します。

タイマーを取り消します。

構文

timer_cancel event_id ? 

引数

結果文字列

sec_remain %ld msec_remain %ld

sec_remain および msec_remain は、タイマーの次の期限切れまでの残り時間です。

Note	タイマー タイプが CRON の場合、sec_remain および msec_remain には 0 が返されます。

_cerrno を設定

対応

(_cerr_sub_err =  2)    FH_ESYSERR  (generic/unknown error from OS/system)

このエラーは、オペレーティング システムによってレポートされたエラーを意味します。エラーとともにレポートされる POSIX errno 値を使用して、オペレーティング システム エラーの原因を調べます。

(_cerr_sub_err =  6)    FH_EBADEVENTTYPE  (unknown EEM event type)

このエラーは、内部イベント指定で指定されたイベント タイプが無効であったことを意味します。

(_cerr_sub_err =  7)    FH_ENOSUCHKEY  (could not find key)

このエラーは、アプリケーション イベント ディテクタ情報キーまたはその他の ID が見つからなかったことを意味します。

(_cerr_sub_err = 11)    FH_ENOSUCHESID  (unknown event specification ID)

このエラーは、イベントが登録されたときか、またはイベント ディテクタの内部イベント構造が破損したときに、イベント指定 ID を照会できなかったことを意味します。

(_cerr_sub_err = 12)    FH_ENOSUCHEID  (unknown event ID)

このエラーは、イベントが登録されたときか、またはイベント ディテクタの内部イベント構造が破損したときに、イベント ID を照会できなかったことを意味します。

(_cerr_sub_err = 22)    FH_ENULLPTR  (event detector internal error - ptr is null)

このエラーは、内部 EEM イベント ディテクタ ポインタに値が含まれている必要があったときに、ヌルであったことを意味します。

(_cerr_sub_err = 54)    FH_EFDUNAVAIL  (connection to event detector unavailable)

このエラーは、イベント ディテクタが使用できなかったことを意味します。

(_cerr_sub_err = 56)    FH_EFDCONNERR  (event detector connection error)

このエラーは、この要求を処理する EEM イベント ディテクタは使用できないことを意味します。

カウンタの登録を解除します。この Tcl コマンド拡張は、以前に register_counter Tcl コマンド拡張に登録されていたカウンタの登録を解除するために、カウンタパブリッシャによって使用されます。

構文

unregister_counter event_id ? event_spec_id ?

引数

結果文字列

なし

_cerrno を設定

対応

(_cerr_sub_err =  2)    FH_ESYSERR  (generic/unknown error from OS/system)

このエラーは、オペレーティング システムによってレポートされたエラーを意味します。エラーとともにレポートされる POSIX errno 値を使用して、オペレーティング システム エラーの原因を調べます。

(_cerr_sub_err =  9)    FH_EMEMORY  (insufficient memory for request)

このエラーは、メモリの内部 EEM 要求に障害が発生したことを意味します。

(_cerr_sub_err = 11)    FH_ENOSUCHESID  (unknown event specification ID)

このエラーは、イベントが登録されたときか、またはイベント ディテクタの内部イベント構造が破損したときに、イベント指定 ID を照会できなかったことを意味します。

(_cerr_sub_err = 22)    FH_ENULLPTR  (event detector internal error - ptr is null)

このエラーは、内部 EEM イベント ディテクタ ポインタに値が含まれている必要があったときに、ヌルであったことを意味します。

(_cerr_sub_err = 26)    FH_ESUBSIDXINV  (invalid subscriber index)

これは、サブスクライバの索引が無効であったことを意味します。

(_cerr_sub_err = 54)    FH_EFDUNAVAIL  (connection to event detector unavailable)

このエラーは、イベント ディテクタが使用できなかったことを意味します。

(_cerr_sub_err = 56)    FH_EFDCONNERR  (event detector connection error)

このエラーは、この要求を処理する EEM イベント ディテクタは使用できないことを意味します。