Embedded Event Manager コマンド リファレンス、Cisco IOS XE Release 3SE(Catalyst 3850 スイッチ)
event mat から R までのコマンド
event mat から R までのコマンド
発行日;2013/07/19   |   ドキュメントご利用ガイド   |   ダウンロード ;   この章 pdf   ,   ドキュメント全体 pdf    |   フィードバック

event mat から R までのコマンド

event mat から R までのコマンド

event mat

MAC アドレスが MAC アドレス テーブルで学習されたときにイベントをパブリッシュするには、アプレット コンフィギュレーション モードで event mat コマンドを使用します。 イベントのパブリッシュをディセーブルにするには、このコマンドの no 形式を使用します。

event [ tag event-tag ] mat { interface { type number | regexp interface-name } [ mac-address mac-address ] | mac-address mac-address [ interface { type number | regexp interface-name } ] } [ maxrun maxruntime-number ] [ hold-down seconds ] [ type { add | delete } ]

no event mat

構文の説明

tag

(任意)trigger コマンドで使用できる event-tag 引数を使用してタグを指定し、アプレットの複数のイベント文をサポートします。

event-tag

(任意)タグを識別するストリング。

interface

インターフェイスを指定します。

type number

インターフェイスのタイプと番号。

regexp interface-name

インターフェイス名と照合する正規表現パターンを指定します。

mac-address

MAC アドレスを指定します。

mac-address

MAC アドレス。

maxrun

(任意)アプレットの最大実行時間を指定します。 maxrun キーワードが指定されている場合、maxruntime-number 値を指定する必要があります。 maxrun キーワードが指定されていない場合、デフォルトのアプレット ランタイムは 20 秒です。

maxruntime-number

(任意)ssssssss[.mmm] 形式で指定される秒数。ssssssss は、0 ~ 31536000 の秒数を表す整数で、mmm は 0 ~ 999 のミリ秒数を表す整数である必要があります。

hold-down

(任意)イベント処理を遅延する時間を指定します。

seconds

(任意)秒数およびオプションのミリ秒数を ssssssssss [.mmm] 形式で表した数字。 秒数の範囲は 1 ~ 4294967295 です。 ミリ秒の範囲は 0 ~ 999 です。 ミリ秒だけを使用する場合は、0.mmm の形式でミリ秒を指定します。

type

(任意)MAC アドレス テーブルのイベントをモニタします。 次のオプションのいずれかのオプションを指定する必要があります。

  • add:MAC アドレス テーブルの追加イベントだけをモニタします。
  • delete:MAC アドレス テーブルの削除イベントだけをモニタします。

コマンド デフォルト

デフォルトでは、イベントはパブリッシュされません。

コマンド モード


アプレット コンフィギュレーション(config-applet)

コマンド履歴

リリース

変更内容

12.2(52)SE

このコマンドが導入されました。

12.2(54)SG

このコマンドが、Cisco IOS Release 12.2(54)SG に統合されました。

使用上のガイドライン

インターフェイスまたは MAC アドレスを指定する必要があります。 そのいずれかが指定されている場合、残り 1 つは任意です。 すべてのキーワードは任意の組み合わせで使用できます。

次に、MAC アドレスが MAC アドレス テーブルで学習されたときにイベントをパブリッシュする例を示します。

Router(config)# event manager applet mat
Router(config-applet)# event mat interface fastethernet0 hold-down 34 type delete
Router(config-applet)#

関連コマンド

コマンド

説明

event manager applet

Embedded Event Manager にイベント アプレットを登録し、アプレット コンフィギュレーション モードを開始します。

event neighbor-discovery

Cisco Discovery Protocol(CDP)またはリンク層検出プロトコル(LLDP)のキャッシュ エントリが変更されるか、Embedded Event Manager(EEM)アプレットでインターフェイス リンク ステータスが変更されたときにイベントをパブリッシュするには、アプレット コンフィギュレーション モードで event neighbor-discovery コマンドを使用します。 イベントをパブリッシュするアクションをディセーブルにするには、このコマンドの no 形式を使用します。

event [ tag event-tag ] neighbor-discovery interface { type number | regexp interface-name } [ maxrun maxruntime-number ] event-to-monitor

no event neighbor-discovery

構文の説明

tag

(任意)trigger コマンドで使用できる event-tag 引数を使用してタグを指定し、アプレットの複数のイベント文をサポートします。

event-tag

(任意)タグを識別するストリング。

interface

インターフェイスを指定します。

type number

インターフェイスのタイプと番号。

regexp interface-name

インターフェイス名と照合する正規表現パターンを指定します。

maxrun

(任意)アプレットの最大実行時間を指定します。 maxrun キーワードが指定されている場合、maxruntime-number 値を指定する必要があります。 maxrun キーワードが指定されていない場合、デフォルトのアプレット ランタイムは 20 秒です。

maxruntime-number

(任意)ssssssss[.mmm] 形式で指定される秒数。ssssssss は、0 ~ 31536000 の秒数を表す整数で、mmm は 0 ~ 999 のミリ秒数を表す整数である必要があります。

event-to-monitor

インターフェイス上でモニタするイベントを指定します。 次のいずれかの値を指定できます。 複数の値を指定できます。

  • cdp:CDP のマッチング イベント発生時にイベントをトリガーします。 次のオプションのいずれかのオプションを指定する必要があります。
    • add:新しい CDP キャッシュ エントリが CDP テーブルに作成された場合にイベントをトリガーします。
    • all:CDP キャッシュ エントリが CDP キャッシュ テーブルに追加された場合、または削除された場合、および CDP キャッシュ エントリをアップデートするためにリモート CDP デバイスがキープアライブを送信した場合にイベントをトリガーします。
    • delete:CDP キャッシュ エントリが CDP テーブルから削除された場合だけイベントをトリガーします。
    • update:CDP キャッシュ エントリが CDP キャッシュ テーブルに追加された場合、または CDP キャッシュ エントリをアップデートするためにリモート CDP デバイスが CDP キープアライブを送信した場合にイベントをトリガーします。
  • lldp:LLDP のマッチング イベント発生時にイベントをトリガーします。 次のオプションのいずれかのオプションを指定する必要があります。
    • add:新しい CDP キャッシュ エントリが CDP テーブルに作成された場合にイベントをトリガーします。
    • all:CDP キャッシュ エントリが CDP キャッシュ テーブルに追加された場合、または削除された場合、および CDP キャッシュ エントリをアップデートするためにリモート CDP デバイスがキープアライブを送信した場合にイベントをトリガーします。
    • delete:CDP キャッシュ エントリが CDP テーブルから削除された場合だけイベントをトリガーします。
    • update:CDP キャッシュ エントリが CDP キャッシュ テーブルに追加された場合、または CDP キャッシュ エントリをアップデートするためにリモート CDP デバイスが CDP キープアライブを送信した場合にイベントをトリガーします。
  • line-event:インターフェイス回線プロトコルのステータスが変わった場合にイベントをトリガーします。
  • link-event:インターフェイス リンクのステータスが変わった場合にイベントをトリガーします。 次のオプションのいずれかのオプションを指定する必要があります。
    • admindown:リンクの admin-down イベントをモニタします。
    • all:すべてのリンク イベントをモニタします。
    • deleted:リンク削除イベントをモニタします。
    • down:リンク ダウン イベントをモニタします。
    • goingdown:リンクの going-down イベントをモニタします。
    • init:リンクの初期化イベントをモニタします。
    • reset:リンクのリセット イベントをモニタします。
    • testing:リンクのテスト イベントをモニタします。
    • up:リンクのアップ イベントをモニタします。

コマンド デフォルト

デフォルトでは、イベントはパブリッシュされません。

コマンド モード


アプレット コンフィギュレーション(config-applet)

コマンド履歴

リリース

変更内容

12.2(52)SE

このコマンドが導入されました。

12.2(54)SG

このコマンドが、Cisco IOS Release 12.2(54)SG に統合されました。

使用上のガイドライン

イベントの指定が受け入れられるようにするには、インターフェイスと、cdp、lldp、link-event、line-event から 1 つ以上を指定する必要があります。 interface および maxrun キーワードと、event-trigger-criteria 引数は任意の順序で使用できます。

次に、CDP キャッシュ エントリが変更されたときにイベントをパブリッシュする例を示します。

Router(config)# event manager applet discovery
Router(config-applet)# event neighbhor-discovery interface fastethernet0 cdp all
Router(config-applet)#

関連コマンド

コマンド

説明

event manager applet

Embedded Event Manager にイベント アプレットを登録し、アプレット コンフィギュレーション モードを開始します。

event nf

Embedded Event Manager(EEM)のアプレットに対して NetFlow 操作がトリガーされたときにイベントをパブリッシュするには、アプレット コンフィギュレーション モードで event nf コマンドを使用します。 NetFlow 操作がトリガーされたときにイベントをパブリッシュするアクションをディセーブルにするには、このコマンドの no 形式を使用します。

event [ tag event-tag ] nf monitor-name name event-type { create | delete | update } [exit-event-type] { create | delete | update } subevent field field-type entry-value value-string [ exit-value value-string ] entry-op operator-value [ exit-op operator-value ] [ rate-interval seconds ] [ exit-rate-interval seconds ] [ maxrun maxruntime-number ]

no event [ tag event-tag ] nf

構文の説明

tag

(任意)trigger コマンドで使用できる event-tag 引数を使用してタグを指定し、アプレットの複数のイベント文をサポートします。

event-tag

(任意)タグを識別するストリング。

monitor-name name

NetFlow モニタの名前を指定します。

event-type

モニタするイベントのタイプを指定します(キャッシュまたはフィールド)。

create

NetFlow イベントを作成します。

delete

NetFlow イベントを削除します。

update

NetFlow イベントを更新します。

exit-event-type

監視のためにイベントが再準備されるイベント タイプ(create、delete、update)。

subevent

監視するイベントとその属性を指定します。 有効な値は、event1event2event3event4 です。

(注)     

サブイベント キーワードは、単独でも、一緒でも、それぞれの任意の組み合わせでも使用できますが、各キーワードは 1 回のみ使用できます。

field field-type

監視されるキャッシュまたはフィールド属性を指定します。 次の属性の 1 つを指定できます。

  • counter {bytes | packets}:counter フィールドを指定します。
  • datalink {dot1q | mac}:datalink (layer2) フィールドを指定します。
  • flow {direction | sampler}:flow 識別フィールドを指定します。
  • interface {input | output}:interface フィールドを指定します。
  • ipv4 field-type:IPv4 フィールドを指定します。
  • ipv6 field-type:IPv6 フィールド
  • routing routing-attrribute ルーティング属性を指定します。
  • timestamp sysuptime {first | last}timestamp フィールドを指定します。
  • transport field-type:Transport layer フィールドを指定します。

詳細については、疑問符(?)オンライン ヘルプ機能を使用します。

entry-value value-string

比較する開始値を指定します。

exit-value string

(任意)イベントが再度モニタされるように設定される値。

rate-interval sec

レート インターバル値を秒単位で指定します。 有効範囲は 1 ~ 4294967295 です。

exit-rate-interval sec

(任意)キャッシュ レートとキャッシュ エントリのインターバル値を指定します。 有効値は 0 ~ 4294967295 です。

entry-op

収集された使用率サンプルと指定した値との比較で使用する演算子を指定します。 有効な値は次のとおりです。

operator-value

比較演算子。 次の値が有効です。

  • eq:等しい
  • ge:以上
  • gt:より大きい
  • le:以下
  • lt:より小さい
  • wc:ワイルドカード

exit-op

(任意)現在のイベント属性値と終了値を比較するために使用する演算子。

maxrun

(任意)アプレットの最大実行時間を指定します。 maxrun キーワードが指定されている場合、maxruntime-number 値を指定する必要があります。 maxrun キーワードが指定されていない場合、デフォルトのアプレット ランタイムは 20 秒です。

maxruntime-number

(任意)ssssssss[.mmm] 形式で指定される秒数。ssssssss は、0 ~ 31536000 の秒数を表す整数で、mmm は 0 ~ 999 のミリ秒数を表す整数である必要があります。

コマンド デフォルト

デフォルトでは、イベントは NetFlow 動作がトリガーされたときにパブリッシュされません。

コマンド モード


アプレット コンフィギュレーション(config-applet)

コマンド履歴

リリース

変更内容

12.4(22)T

このコマンドが導入されました。

12.2(33)SRE

このコマンドが、Cisco IOS Release 12.2(33)SRE に統合されました。

使用上のガイドライン

event nf コマンドを使用して、NetFlow イベントをモニタします。 複数のイベントを一緒に指定して、複数のイベントに対し追加のフィルタリングを行うことができます。

次に、NetFlow イベントをモニタするようにアプレットを設定する例を示します。

Router(config)# event manager applet EventNF
Router(config-applet)# event nf event-type create monitor-name mon1 event1 entry-op eq entry-val val1 field counter bytes long rate-interval 12
Router(config-applet)#

関連コマンド

コマンド

説明

event manager applet

EEM にイベント アプレットを登録し、アプレット コンフィギュレーション モードを開始します。

event none

Embedded Event Manager(EEM)ポリシーを EEM に登録し、手動で実行できるように指定するには、アプレット コンフィギュレーション モードで event none コマンドを使用します。 コンフィギュレーション ファイルから event none コマンドを削除するには、このコマンドの no 形式を使用します。

event [ tag event-tag ] none [ sync { yes | no } ] [default] [ maxrun maxruntime-number ]

no event none

構文の説明

tag

(任意)trigger コマンドで使用できる event-tag 引数を使用してタグを指定し、アプレットの複数のイベント文をサポートします。

event-tag

(任意)タグを識別するストリング。

synch

CLI コマンドを実行する前にポリシーを同期的に実行するかどうかを示します。

  • yes キーワードが指定されている場合、ポリシーは、CLI コマンドと同期的に実行されます。
  • no キーワードが指定されている場合、ポリシーは CLI コマンドと非同期的に実行されます。

default

(任意)CLI イベント ディテクタがポリシーの終了を待つ時間(ssssssssss[.mmm] 形式で指定します。ssssssssss は、0 ~ 4294967295 の秒数を表す整数で、mmm は 0 ~ 999 のミリ秒数を表す整数である必要があります)。 ポリシーが終了する前にデフォルトの時間の期限が切れると、デフォルト アクションが実行されます。 デフォルト アクションによって、コマンドが実行されます。 この引数が指定されない場合、デフォルトの時間は 30 秒に設定されます。

maxrun

(任意)アプレットの最大実行時間を指定します。 maxrun キーワードが指定されている場合、maxruntime-number 値を指定する必要があります。 maxrun キーワードが指定されていない場合、デフォルトのアプレット ランタイムは 20 秒です。

maxruntime-number

(任意)ssssssss[.mmm] 形式で指定される秒数。ssssssss は、0 ~ 31536000 の秒数を表す整数で、mmm は 0 ~ 999 のミリ秒数を表す整数である必要があります。

コマンド デフォルト

EEM イベントは、Cisco IOS システム モニタ カウンタに基づいてトリガーされません。

コマンド モード


アプレット コンフィギュレーション(config-applet)。

コマンド履歴

リリース

変更内容

12.3(14)T

このコマンドが導入されました。

12.2(28)SB

このコマンドが、Cisco IOS Release 12.2(28)SB に統合されました。

12.2(18)SXF4

このコマンドが Cisco IOS Release 12.2(18)SXF4 に統合され、ソフトウェア モジュラリティ イメージだけをサポートするようになりました。

12.2(33)SRA

このコマンドが、Cisco IOS Release 12.2(33)SRA に統合されました。

12.2(18)SXF5

このコマンドが、Cisco IOS Release 12.2(18)SXF5 に統合されました。

12.2SX

このコマンドは、Cisco IOS Release 12.2SX トレインでサポートされます。 このトレインの特定の 12.2SX リリースにおけるサポートは、フィーチャ セット、プラットフォーム、およびプラットフォーム ハードウェアによって異なります。

12.4(20)T

tag および maxrun キーワードが、アプレット内の複数のイベント文をサポートするために追加されました。

使用上のガイドライン

EEM は、通常、ポリシーそのものに含まれるイベント仕様に基づいてポリシーをスケジューリングし、実行します。 event none コマンドを使用することで、EEM ポリシーが手動で実行できるものか、または EEM アプレットがトリガーされたときに実行されるものかを EEM が識別できるようになります。 ポリシーを実行するには、アプレット コンフィギュレーション モードで action policy コマンドを使用するか、またはグローバル コンフィギュレーション モードで event manager run コマンドを使用します。

次に、手動で実行する manual-policy という名前のポリシーを登録し、ポリシーを実行する例を示します。

Router(config)# event manager applet manual-policy
Router(config-applet)# event none
Router(config-applet)# exit
Router(config)# event manager run manual-policy

関連コマンド

コマンド

説明

action policy

EEM ポリシーを EEM に登録します。

event manager applet

EEM に EEM アプレットを登録し、アプレット コンフィギュレーション モードを開始します。

event manager run

登録された EEM ポリシーを手動で実行します。

show event manager policy registered

登録されている EEM ポリシーを表示します。

event routing

ルート エントリがルーティング情報ベース(RIB)インフラストラクチャで変更されたときにイベントをパブリッシュするには、アプレット コンフィギュレーション モードで event routing コマンドを使用します。 ルート エントリが RIB で変更されたときのイベントのパブリッシュを停止するには、このコマンドの no 形式を使用します。

event [ tag event-tag ] routing network ip-address/length [ ge ge-length ] [ le le-length ] [ protocol protocol-value ] [ type { add | all | modify | remove } ] [ maxrun maxruntime-number ]

no event [ tag event-tag ] routing

構文の説明

tag

(任意)trigger コマンドで使用できる event-tag 引数を使用してタグを指定し、アプレットの複数のイベント文をサポートします。

event-tag

(任意)タグを識別するストリング。

network

ルートをモニタするネットワーク IP アドレスと長さを指定します。

ip-address / length

モニタするネットワークの IP アドレスと長さ。 たとえば、192.0.2.4/8 です。

ge ge-length

(任意)照会されるプレフィックスの最小の長さを指定します。

le le-length

(任意)照会されるプレフィックスの最大の長さを指定します。

ne ne-length

(任意)プレフィックスの長さを照会しない指定をします。

protocol

(任意)監視されているネットワークのプロトコルの値を指定します。

protocol-value

ネットワーク プロトコル値。 allbgpconnectedeigrpisisiso-igrpmobileodrospfrip、および static のプロトコルの 1 つを使用できます。 デフォルトは、all です。

type

(任意)必要なポリシーのトリガーを指定します。 デフォルトは、all です。

add

エントリがルーティング テーブルに追加されることを指定します。

all

ルーティング テーブル エントリが追加、削除または変更されることを指定します。

modify

ルーティング テーブルのエントリが変更されることを指定します。

remove

エントリがルーティング テーブルから削除されることを指定します

maxrun

(任意)アプレットの最大実行時間を指定します。 maxrun キーワードが指定されている場合、maxruntime-number 値を指定する必要があります。 maxrun キーワードが指定されていない場合、デフォルトのアプレット ランタイムは 20 秒です。

maxruntime-number

(任意)ssssssss[.mmm] 形式で指定される秒数。ssssssss は、0 ~ 31536000 の秒数を表す整数で、mmm は 0 ~ 999 のミリ秒数を表す整数である必要があります。

コマンド デフォルト

デフォルトでは、ルート エントリが RIB インフラストラクチャで変更されたときにイベントはパブリッシュされません。

コマンド モード


アプレット コンフィギュレーション(config-applet)

コマンド履歴

リリース

変更内容

12.4(22)T

このコマンドが導入されました。

12.2(33)SRE

このコマンドが、Cisco IOS Release 12.2(33)SRE に統合されました。

使用上のガイドライン

RIB インフラストラクチャでルート エントリの変更が検出されると EEM イベントがパブリッシュされます。 監視されるルートのネットワーク IP アドレスを指定する必要があります。 照合されるネットワーク プレフィックス、プロトコル値、およびタイプはオプションのパラメータです。


(注)  


既存のスタティック ルートの変更は、Cisco IOS リリースに応じて、remove イベントとそれに続く古い API(v1.0)の add イベントか、または新しい API(v2.0)の modify イベントという結果になります。


次に、多数のパラメータがモニタされている場合に、特定のルート エントリがどのように変わるかの例を示します。

Router(config
)# event manager applet EventRouting
Router(config-applet)# event routing 192.0.2.4/8 protocol static type add ge 5 maxrun 56
Router(config-applet)#

次に、古いルーティング API(v1.0)を使用する Cisco IOS バージョンの出力例を示します。

Router# show event manager detector routing
No. Name 				Version   		Node        Type    
1 	routing 			 01.00     node0/0     RP      

次に、新しいルーティング API(v2.0)を使用する Cisco IOS バージョンの出力例を示します。

Router# show event manager detector routing
No. Name 				Version   		Node        Type    
1 	routing 			 02.00     node0/0     RP 

関連コマンド

コマンド

説明

event manager applet

EEM にイベント アプレットを登録し、アプレット コンフィギュレーション モードを開始します。

event snmp

簡易ネットワーク管理プロトコル(SNMP)オブジェクト識別子の値をサンプリングすることによって起動される Embedded Event Manager(EEM)アプレットのイベント条件を指定するには、アプレット コンフィギュレーション モードで event snmp コマンドを使用します。 SNMP イベント条件を削除するには、このコマンドの no 形式を使用します。

event [ tag event-tag ] snmp oid oid-value get-type { exact | next } entry-op operator entry-val entry-value entry-type { value | increment | rate } [ exit-comb { or | and } ] [ exit-op operator ] [ exit-val exit-value ] [ exit-type { value | increment | rate } ] [ exit-time exit-time-value ] [ exit-event { true | false } ] [ average-factor average-factor-value ] poll-interval poll-int-value [ maxrun maxruntime-number ]

no event [ tag event-tag ] snmp oid oid-value get-type { exact | next } entry-op operator entry-val entry-value entry-type { value | increment | rate } [ exit-comb { or | and } ] [ exit-op operator ] [ exit-val exit-value ] [ exit-type { value | increment | rate } ] [ exit-time exit-time-value ] [ exit-event { true | false } ] [ average-factor average-factor-value ] poll-interval poll-int-value [ maxrun maxruntime-number ]

構文の説明

tag

(任意)trigger コマンドで使用できる event-tag 引数を使用してタグを指定し、アプレットの複数のイベント文をサポートします。

event-tag

(任意)タグを識別するストリング。

oid

oid-value 引数に SNMP オブジェクト識別子(オブジェクト ID)をイベント条件として指定します。

oid-value

SNMP ドット付き表記でのデータ エレメントのオブジェクト ID 値。 OID は、関連する MIB(CISCO-EMBEDDED-EVENT-MGR-MIB)内にタイプとして定義され、各タイプはオブジェクト値を保持します。 一部の OID 型のモニタリングが可能です。 oid キーワードを使用すると、OID が次のいずれでもない場合にエラー メッセージが返されます。

  • INTEGER_TYPE
  • COUNTER_TYPE
  • GAUGE_TYPE
  • TIME_TICKS_TYPE
  • COUNTER_64_TYPE
  • OCTET_PRIM_TYPE
  • OPAQUE_PRIM_TYPE

get-type

oid-value 引数で指定したオブジェクト ID に適用する SNMP get 操作のタイプを指定します。

exact

oid-value 引数で指定したオブジェクト ID を検索します。

next

oid-value 引数で指定したオブジェクト ID の英数字順で取得します。

entry-op

指定した演算子を使用して、現在のオブジェクト ID の内容と開始値を比較します。 マッチが見つかると、イベントがトリガーされ、終了条件が満たされるまでイベント モニタリングがディセーブルになります。

operator

2 文字のストリング。 operator 引数には、次のいずれかの値を指定できます。

  • gt:より大きい。
  • ge:以上。
  • eq:等しい。
  • ne:等しくない。
  • lt:より小さい。
  • le:以下。

entry-val

SNMP イベントを発生させるかどうかを決定するために、現在のオブジェクト ID の内容と比較する値を指定します。

entry-value

データ要素のエントリ オブジェクト ID 値。

entry-type

entry-value 引数によって指定されたオブジェクト ID に適用される操作のタイプを指定します。

value

値は、entry-value または exit-value 引数の実際の値として定義されます。

increment

増分では、entry-value または exit-value フィールドは増分差異として使用され、entry-value または exit-value は、現在のカウンタの値と、イベントが最後にトリガーされたとき(またはこれが新しいイベントの場合は最初にポーリングされたサンプル)の値との間の差と比較されます。 負の値によって、減少しているカウンタの増分差異がチェックされます。

rate

レートは、ある期間の変更の平均レートとして定義されます。 期間は、average-factor-value に、poll-int-value を乗じたものです。 ポーリング間隔ごとに、現在のサンプルと前のサンプルとの間の差が取得され、絶対値として記録されます。 前の average-factor-value サンプルの平均は、変更のレートとして取得されます。

exit-comb

(任意)イベント モニタリングを再度イネーブルにするために満たす必要のある終了条件の組み合わせを示します。

or

(任意)終了比較演算子、終了オブジェクト ID 値、または終了時間値を指定する必要があります。

and

(任意)終了比較演算子、終了オブジェクト ID 値、および終了時間値を指定する必要があります。

exit-op

(任意)指定された演算子を使用して、現在のオブジェクト ID の内容と終了値を比較します。 マッチが見つかるとイベントが起動され、イベント モニタリングが再イネーブルされます。

exit-val

(任意)終了条件が満たされているかどうかを決定するために、現在のオブジェクト ID の内容と比較する値を指定します。

exit-value

(任意)データ要素の終了オブジェクト ID 値。

exit-type

(任意)exit-value 引数によって指定されたオブジェクト ID に適用される操作のタイプを指定します。 指定されない場合、値が仮定されます。

exit-time

(任意)この時間が経過した後に、イベント モニタリングが再度イネーブルになる時間を指定します。 タイミングは、イベントがトリガーされた後に開始します。

exit-time-value

(任意)秒数およびオプションのミリ秒数を ssssss[.mmm] 形式で表した数字。 秒数の範囲は 0 ~ 4294967295 です。 ミリ秒の範囲は 0 ~ 999 です。 ミリ秒だけを使用する場合、形式は 0.mmm です。

exit-event

(任意)最初のイベントがトリガーされた後に、イベント モニタリングがイネーブルになった場合、別の終了イベントがトリガーされるかどうかを示します。

true

(任意)別の終了イベントがトリガーされることを指定します。

false

(任意)別の終了イベントがトリガーされないことを指定します。 これはデフォルトです。

average-factor

(任意)レートベースの計算に使用される期間の計算に使用される数値を指定します。 average-factor-valuepoll-int-value を乗じて、ミリ秒単位で期間を算出します。

average-factor-value

(任意)1 ~ 64 の範囲の番号。 最少平均係数値は 1 です。

poll-interval

連続するポーリング操作間の時間間隔を指定します。

poll-int-value

秒数およびオプションのミリ秒数を ssssss[.mmm] 形式で表した数字。 秒数の範囲は 1 ~ 4294967295 です。 ミリ秒の範囲は 0 ~ 999 です。 最小ポーリング間隔は 1 秒です。

maxrun

(任意)アプレットの最大実行時間を指定します。 maxrun キーワードが指定されている場合、maxruntime-number 値を指定する必要があります。 maxrun キーワードが指定されていない場合、デフォルトのアプレット ランタイムは 20 秒です。

maxruntime-number

(任意)SSSSSSSSSS[.MMM] 形式で指定される秒数。SSSSSSSSSS は、0 ~ 4294967295 の秒数を表す整数で、MMM は 0 ~ 999 のミリ秒数を表す整数である必要があります。

コマンド デフォルト

EEM イベントは SNMP オブジェクト ID 値に基づいてトリガーされません。

コマンド モード


アプレット コンフィギュレーション(config-applet)

コマンド履歴

リリース

変更内容

12.0(26)S

このコマンドが導入されました。

12.3(4)T

このコマンドが Cisco IOS Release 12.3(4)T に統合されました。

12.3(2)XE

このコマンドが、Cisco IOS Release 12.3(2)XE に統合されました。

12.2(25)S

このコマンドが、Cisco IOS Release 12.2(25)S に統合されました。

12.3(14)T

SNMP レートベースのイベントをサポートするオプションのキーワードが追加されました。

12.2(28)SB

このコマンドが、Cisco IOS Release 12.2(28)SB に統合されました。

12.2(18)SXF4

このコマンドが Cisco IOS Release 12.2(18)SXF4 に統合され、ソフトウェア モジュラリティ イメージだけをサポートするようになりました。

12.2(33)SRA

このコマンドが、Cisco IOS Release 12.2(33)SRA に統合されました。

12.2(18)SXF5

このコマンドが、Cisco IOS Release 12.2(18)SXF5 に統合されました。

12.2SX

このコマンドは、Cisco IOS Release 12.2SX トレインでサポートされます。 このトレインの特定の 12.2SX リリースにおけるサポートは、フィーチャ セット、プラットフォーム、およびプラットフォーム ハードウェアによって異なります。

12.4(20)T

tag および maxrun キーワードと、関連する引数が追加されました。

使用上のガイドライン

EEM イベントは、SNMP オブジェクト ID によって指定されたフィールドのいずれか 1 つが定義されたしきい値を超えたときにトリガーされます。 複数の条件が存在する場合、すべての条件が満たされたときに、SNMP イベントがトリガーされます。

終了基準は任意です。 終了基準を指定しない場合、イベント モニタリングがすぐに再イネーブル化されます。 終了基準が(値または期間に基づいて)指定されている場合、イベント モニタリングは条件が満たされるまで再イネーブル化されません。

entry-op キーワードが使用されている場合に一致が見つかると、イベントがトリガーされ、終了条件が満たされるまでイベント モニタリングがディセーブルになります。

exit-op キーワードが使用されている場合に一致が見つかると、イベントがトリガーされ、イベント モニタリングが再イネーブル化されます。

entry-type キーワードは、次のいずれかのアクションをトリガーします。

  • value キーワードが指定されている場合、entry-value は実際の値で、絶対値が発生するたびに SNMP イベントが発生します。
  • increment キーワードが指定されている場合、entry-value は増分で、増分値に到達するたびに SNMP イベントが発生します。
  • rate キーワードが指定されている場合、entry-value は変化率で、変化率の値に到達するたびに SNMP イベントが発生します。

オプションの exit-type キーワードが使用される場合、次が発生します。

  • value キーワードが指定されている場合、exit-value は実際の値で、絶対値が発生するたびにイベント モニタリングが再イネーブル化されます。 これはデフォルトです。
  • increment キーワードが指定されている場合、exit-value は増分で、増分値に到達するたびにイベント モニタリングが再イネーブル化されます。
  • rate キーワードが指定されている場合、exit-value は変化率で、変化率の値に到達するたびにイベント モニタリングが再イネーブル化されます。

increment および rate タイプは、INTEGER_TYPE、COUNTER_TYPE、および COUNTER_64_TYPE の OID タイプに対してだけサポートされます。

次に、現在のプロセス メモリ量を表す、指定された SNMP オブジェクト ID の値との完全一致がある場合に、memory-fail と呼ばれる EEM アプレットがどのように実行されるかの例を示します。 プロセス メモリが不足していること、および現在使用可能なメモリを示すメッセージが syslog に送信されます。

Router(config)# event manager applet memory-fail
Router(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.48.1.1.1.6.1 get-type exact entry-op lt entry-val 5120000 poll-interval 10
Router(config-applet)# action 1.0 syslog msg "Memory exhausted; current available memory is $_snmp_oid_val bytes"

次に、IPSLAping1 という名前の EEM アプレットが登録され、指定された SNMP オブジェクト ID の値と完全一致する(正常な IP SLA ICMP エコー動作を表す)場合に実行される例を示します(これは ping コマンドに相当します)。 エコー操作が失敗した場合は 4 つのアクションがトリガーされ、イベント モニタリングは 2 回目の失敗後までディセーブルにされます。

サーバへの ICMP エコー動作が失敗したことを示すメッセージが syslog に送信され、SNMP トラップが生成され、EEM はアプリケーション固有のイベントをパブリッシュし、IPSLA1F というカウンタが値 1 で増分されます。

Router(config)# event manager applet IPSLAping1
Router(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.42.1.2.9.1.6.4 get-type exact
entry-op eq entry-val 1 exit-op eq exit-val 2 poll-interval 5
Router(config-applet)# action 1.0 syslog priority critical msg "Server IP echo failed:
OID=$_snmp_oid_val"
Router(config-applet)# action 1.1 snmp-trap strdata "EEM detected server reachability
failure to 10.1.88.9"
Router(config-applet)# action 1.2 publish-event sub-system 88000101 type 1 arg1 10.1.88.9
arg2 IPSLAEcho arg3 fail

関連コマンド

コマンド

説明

event manager applet

Embedded Event Manager にイベント アプレットを登録し、アプレット コンフィギュレーション モードを開始します。

event snmp-notification

簡易ネットワーク管理プロトコル(SNMP)通知をサンプリングすることによって実行される Embedded Event Manager(EEM)アプレットのイベント条件を登録するには、アプレット コンフィギュレーション モードで event snmp-notification コマンドを使用します。 SNMP 通知イベント条件を削除するには、このコマンドの no 形式を使用します。

event [ tag event-tag ] snmp-notification oid oid-string oid-val comparison-value op operator [ maxrun maxruntime-number ] [ src-ip-address ip-address ] [ dest-ip-address ip-address ] [ default seconds ] [ direction { incoming | outgoing } ] [ msg-op { drop | send } ]

no event [ tag event-tag ] snmp-notification

構文の説明

tag

(任意)trigger コマンドで使用できる event-tag 引数を使用してタグを指定し、アプレットの複数のイベント文をサポートします。

event-tag

(任意)タグを識別するストリング。

oid

oid-val 引数に SNMP オブジェクト識別子(オブジェクト ID)値をイベント条件として指定します。

oid-string

SNMP ドット付き表記でのデータ エレメントのオブジェクト ID 値。 OID は、関連する MIB(CISCO-EMBEDDED-EVENT-MGR-MIB)内にタイプとして定義され、各タイプはオブジェクト値を保持します。 一部の OID 型のモニタリングが可能です。 oid キーワードを使用すると、OID が次のいずれでもない場合にエラー メッセージが返されます。

  • COUNTER_TYPE
  • COUNTER_64_TYPE
  • GAUGE_TYPE
  • INTEGER_TYPE
  • OCTET_PRIM_TYPE
  • OPAQUE_PRIM_TYPE
  • TIME_TICKS_TYPE

oid-val comparison-value

OID の比較値を指定します。

op

指定した演算子を使用して、現在のオブジェクト ID の内容と SNMP プロトコル データ ユニット(PDU)の開始値を比較します。 マッチが見つかると、イベントがトリガーされ、終了条件が満たされるまでイベント モニタリングがディセーブルになります。

operator

2 文字のストリング。 operator 引数には、次のいずれかの値を指定できます。

  • gt:より大きい。
  • ge:以上。
  • eq:等しい。
  • ne:等しくない。
  • lt:より小さい。
  • le:以下。

maxrun

(任意)アプレットの最大実行時間を指定します。 maxrun キーワードが指定されていない場合、デフォルトのアプレット ランタイムは 20 秒です。

maxruntime-number

(任意)ssssssss[.mmm] 形式で指定される秒数。ssssssss は、0 ~ 31536000 の秒数を表す整数で、mmm は 0 ~ 999 のミリ秒数を表す整数である必要があります。 デフォルト値は 20 秒です。

src-ip-address

(任意)SNMP 通知トラップが発信される送信元 IP アドレスを指定します。 デフォルトは all です。すべての IP アドレスから SNMP 通知トラップを受信するよう、設定されます。

ip-address

(任意)送信元 IP アドレス。

dest-ip-address

(任意)SNMP 通知トラップを送信する宛先 IP アドレスを指定します。 デフォルトは all です。すべての宛先 IP アドレスから SNMP トラップを受信するよう、設定されます。

dest-ip-address

(任意)宛先 IP アドレス。

default seconds

(任意)SNMP 通知イベント ディテクタがポリシーの終了を待つ時間を指定します。 time 時間は、ssssssssss[.mmm] 形式で指定します。ssssssssss は、0 ~ 4294967295 の秒数を表す整数で、mmm は 0 ~ 999 のミリ秒数を表す整数である必要があります。

direction

(任意)SNMP トラップの方向、または通知 PDU がフィルタリングする方向を決定します。 デフォルトは incoming です。

incoming:SNMP トラップの着信方向、または通知 PDU がフィルタリングする方向を決定します。

outgoing:SNMP トラップの発信方向、または通知 PDU がフィルタリングする方向を決定します。

msg-op

(任意)イベントがトリガーされたときに、SNMP PDU で行われるアクション(ドロップまたは送信)を示します。

drop:メッセージをドロップするように指定します。

send:メッセージを送信するように指定します。

コマンド デフォルト

EEM イベントは SNMP 通知オブジェクト ID 値に基づいてトリガーされません。

コマンド モード


アプレット コンフィギュレーション(config-applet)

コマンド履歴

リリース

変更内容

12.4(20)T

このコマンドが導入されました。

15.0(1)M

このコマンドが変更されました。 次のキーワードと引数が追加されました。defaultsecondsdirectionincomingoutgoingmsg-opdrop、および send

使用上のガイドライン

SNMP 通知イベント ディテクタには、ルータが受信した SNMP トラップおよび SNMP インフォーム メッセージを代行受信する機能があります。 SNMP 通知イベントは、受信 SNMP トラップまたは SNMP インフォーム メッセージが指定された値に一致するか、指定されたしきい値を超えたときに生成されます。

SNMP および SNMP サーバ マネージャは SNMP 通知イベント ディテクタの使用前に設定され、イネーブルにされている必要があります。

EEM イベントは、SNMP 通知オブジェクト ID によって指定されたフィールドのいずれか 1 つが定義されたしきい値を超えたときにトリガーされます。 複数の条件が存在する場合、すべての条件が満たされたときに、SNMP 通知イベントがトリガーされます。

OID は、関連する MIB(CISCO-EMBEDDED-EVENT-MGR-MIB)内にタイプとして定義され、各タイプはオブジェクト値を保持します。 一部の OID 型のモニタリングが可能です。 oid キーワードを使用すると、OID が次のいずれでもない場合にエラー メッセージが返されます。

  • INTEGER_TYPE
  • COUNTER_TYPE
  • GAUGE_TYPE
  • TIME_TICKS_TYPE
  • COUNTER_64_TYPE
  • OCTET_PRIM_TYPE
  • OPAQUE_PRIM_TYPE

op キーワードが使用されている場合に一致が見つかると、イベントがトリガーされ、終了条件が満たされるまでイベント モニタリングがディセーブルになります。

operator 引数には、次のいずれかの値を指定できます。

  • gt:より大きい。
  • ge:以上。
  • eq:等しい。
  • ne:等しくない。
  • lt:より小さい。
  • le:以下。

次に、event snmp-notification が設定される前に、snmp-server community public RW コマンド、および snmp-server manager コマンドを設定する例を示します。

Router(config)# snmp-server community public RW
Router(config)# snmp-server manager

次に、値が 10 であるオブジェクト OID 1 の宛先 IP アドレス 192.168.1.1 でルータが SNMP 通知を受け取ったときに、EEM スクリプトを実行するように SNMP_Notification という名前の EEM アプレットを登録する例を示します。

Router(config)# event manager applet SNMP_Notification
Router(config-applet)# event snmp-notification dest-ip-address 192.168.1.1 oid 1 op eq oid-val 10
Router(config-applet)# action 1 policy eem_script

次に、OID が 1.3.6.1.4.1.318.2.3.3 で OID 値が「UPS: Returned from battery backup power」の SNMP トラップを代行受信し、メッセージをドロップして別のメッセージを送信する例を示します。

Router(config)# event manager applet SNMP_Notification
Router(config-applet)# event snmp-notification dest_ip_address 192.168.1.1 oid 1.3.6.1.4.1.318.2.3.3 op eq oid-value "UPS: Returned from battery backup power" direction outgoing msg-op drop

関連コマンド

コマンド

説明

event manager applet

EEM にイベント アプレットを登録し、アプレット コンフィギュレーション モードを開始します。

event snmp-object

SNMP オブジェクトのサンプリングによって実行される Embedded Event Manager(EEM)アプレットの簡易ネットワーク管理プロトコル(SNMP)オブジェクト イベントを登録するには、アプレット コンフィギュレーション モードで event snmp-object コマンドを使用します。 SNMP オブジェクト イベント条件を削除するには、このコマンドの no 形式を使用します。

event snmp-object oid oid-value type value sync { yes | no } skip { yes | no } istable { yes | no } [ default seconds ] [ maxrun maxruntime-number ]

no event snmp-object

構文の説明

oid

SNMP オブジェクト識別子(オブジェクト ID)を指定します。

oid-value

SNMP ドット付き表記でのデータ エレメントのオブジェクト ID 値。 OID は、関連する MIB(CISCO-EMBEDDED-EVENT-MGR-MIB)内にタイプとして定義され、各タイプはオブジェクト値を保持します。

type value

オブジェクトのタイプを指定します。 次の値が有効です。

  • counter:最小値が 0 の 32 ビットの数値。 最大値に到達すると、カウンタが 0 にリセットされます。
  • counter64:最小値が 0 の 64 ビットの数値。 最大値に到達すると、カウンタが 0 にリセットされます。
  • gauge:最小値が 0 の 32 ビットの数値。 たとえば、gauge オブジェクト タイプを使用して、ルータ上のインターフェイスの速度を測定できます。
  • int:管理対象オブジェクトのコンテキスト内の番号が付けられたタイプを指定する場合は、32 ビットの数字が使用されます。 たとえば、ルータ インターフェイスの動作ステータスを 1 に設定した場合はアップ、2 に設定した場合はダウンを示します。
  • ipv4:IP バージョン 4 アドレス。
  • octet:物理アドレスを表すために使用される、16 進表記のオクテット文字列。
  • oid:オブジェクト ID 値。
  • string:テキスト文字列を表すために使用される、テキスト表記のオクテット文字列。
  • uint:10 進数の値を表すために使用される、32 ビット番号。

sync

SNMP および EEM ポリシー実行を指定します。

  • no:ポリシーと SNMP は非同期で実行されます。
  • yes:ポリシーを実行し、その結果により SNMP 要求を実行するかどうかが決まります。

skip

syncno に設定されている場合は必須で、syncyes の場合は使用できません。 CLI コマンドの実行をスキップするかどうかを指定します。

  • no:CLI コマンドを実行する必要があります。
  • yes:CLI コマンドを実行しません。

istable

(任意)OID が SNMP テーブルかどうかを指定します。

  • yes:OID は、SNMP テーブルです。
  • no:IOD は SNMP テーブルではありません。

default

(任意)SNMP オブジェクト イベント ディテクタがポリシーの終了を待つ時間。

seconds

(任意)秒数およびオプションのミリ秒数を ssssssssss [.mmm] 形式で表した数字。 秒数の範囲は 0 ~ 4294967295 です。 ミリ秒の範囲は 0 ~ 999 です。 ミリ秒だけを使用する場合は、0.mmm の形式でミリ秒を指定します。

maxrun

(任意)アプレットの最大実行時間を指定します。

maxruntime-number

(任意)ssssssss[.mmm] 形式で指定される秒数。ssssssss は、0 ~ 31536000 の秒数を表す整数で、mmm は 0 ~ 999 のミリ秒数を表す整数である必要があります。 デフォルト値は 20 秒です。

コマンド モード


アプレット コンフィギュレーション(config-applet)

コマンド履歴

リリース

変更内容

15.0(1)M

このコマンドが導入されました。

15.0(1)M1

このコマンドが変更されました。 counter64 および oid 値が type キーワードに追加されました。

使用上のガイドライン

event snmp-object コマンドを使用して、SNMP オブジェクトをサンプリングすることで実行される EEM アプレットの SNMP オブジェクト イベントを登録します。

次に、 event snmp-object コマンドの使用例を示します。

Router(config)# event manager applet test
Router(config-applet)# event snmp-object

関連コマンド

コマンド

説明

action syslog

EEM アプレットがトリガーされたときに、syslog にメッセージを書き込むアクションを指定します。

event manager applet

EEM にイベント アプレットを登録し、アプレット コンフィギュレーション モードを開始します。

event track

指定したオブジェクト番号の Cisco IOS Object Tracking サブシステム レポートに基づいて起動される Embedded Event Manager(EEM)アプレットのイベント条件を指定するには、アプレット コンフィギュレーション モードで event track コマンドを使用します。 レポート イベント条件を削除するには、このコマンドの no 形式を使用します。

event [label] [ tag event-tag ] track object-number [ state { up | down | any } ] [ maxrun maxruntime-number ]

no event [label] [ tag event-tag ] track object-number [ state { up | down | any } ] [ maxrun maxruntime-number ]

構文の説明

tag

(任意)trigger コマンドで使用できる event-tag 引数を使用してタグを指定し、アプレットの複数のイベント文をサポートします。

event-tag

(任意)タグを識別するストリング。

label

(任意)一意な識別子(任意のストリングを指定できます)。 ストリングに空白が含まれる場合は二重引用符で囲みます。

object-number

1 から 500 の範囲のトラッキング対象オブジェクトの番号。 番号は、track stub コマンドを使用して定義されます。

state

(任意)トラックされるオブジェクトの状態遷移によってイベントが発生するよう、指定します。

up

(任意)トラッキング対象オブジェクトがダウン状態からアップ状態に移行したときにイベントが発生するよう、指定します。

down

(任意)トラッキング対象オブジェクトがアップ状態からダウン状態に移行したときにイベントが発生するよう、指定します。

any

(任意)トラッキング対象オブジェクトが任意の状態から任意の状態に移行したときにイベントが発生するよう、指定します。 これはデフォルトです。

maxrun

(任意)アプレットの最大実行時間を指定します。 maxrun キーワードが指定されている場合、maxruntime-number 値を指定する必要があります。 maxrun キーワードが指定されていない場合、デフォルトのアプレット ランタイムは 20 秒です。

maxruntime-number

(任意)ssssssss[.mmm] 形式で指定される秒数。ssssssss は、0 ~ 31536000 の秒数を表す整数で、mmm は 0 ~ 999 のミリ秒数を表す整数である必要があります。

コマンド デフォルト

EEM イベント基準は指定されていません。

コマンド モード


アプレット コンフィギュレーション(config-applet)

コマンド履歴

リリース

変更内容

12.4(2)T

このコマンドが導入されました。

12.2(31)SB3

このコマンドが、Cisco IOS Release 12.2(31)SB3 に統合されました。

12.2(33)SRB

このコマンドが、Cisco IOS Release 12.2(33)SRB に統合されました。

12.4(20)T

tag および maxrun キーワードが、アプレット内の複数のイベント文をサポートするために追加されました。

12.2(33)SXI

このコマンドが、Cisco IOS Release 12.2(33)SXI に統合されました。

使用上のガイドライン

このコマンドに関連付けられた 2 つのエントリ変数があります。

  • _track_number:イベントがトリガーされる原因となるトラックされるオブジェクトの番号。
  • _track_state:イベントがトリガーされたときのトラックされるオブジェクトの状態。有効な値は「up」または「down」です。

このコマンドは、EEM を使用したオブジェクトのトラッキングを支援するために使用されます。 各トラッキング対象オブジェクトは、トラッキング コマンドライン インターフェイス(CLI)で指定された一意の番号で識別されます。 EEM などのクライアント プロセスは、この番号を使用して特定のオブジェクトをトラッキングします。 トラッキング プロセスは定期的に、トラッキング対象オブジェクトをポーリングし、値の変更を確認します。 トラッキング対象オブジェクトの変更は、すぐに、または指定された遅延後に、対象のクライアント プロセスに通知されます。 オブジェクトの値は、アップまたはダウンとして報告されます。

次に、トラッキング対象オブジェクトに基づいてイベント基準を指定する例を示します。

event manager applet track-ten
 event track 10 state any
 action 1.0 track set 10 state up
 action 2.0 track read 10

関連コマンド

コマンド

説明

action track read

EEM アプレットがトリガーされたときに、トラッキング対象オブジェクトの状態を読み取るアクションを指定します。

action track set

EEM アプレットがトリガーされたときに、トラッキング対象オブジェクトの状態を設定するアクションを指定します。

event manager applet

Embedded Event Manager にイベント アプレットを登録し、アプレット コンフィギュレーション モードを開始します。

show track

トラッキング情報を表示します。

track stub

トラッキング対象のスタブ オブジェクトを作成します。