この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
目次
この章は、次の内容で構成されています。
Cisco NX-OS システム内のクリティカル イベントを検出して処理する機能は、ハイ アベイラビリティにとって重要です。 Embedded Event Manager(EEM)は、デバイス上で発生するイベントをモニタし、設定に基づいてこれらのイベントを回復またはトラブルシューティングするためのアクションを実行することによってシステム内のイベントを検出して処理する、中央のポリシー駆動型のフレームワークを提供します。
EEM は次の 3 種類の主要コンポーネントからなります。
何らかのアクション、回避策、または通知が必要になる可能性のある、別の Cisco NX-OS コンポーネントからモニタするイベント。
電子メールの送信やインターフェイスのディセーブル化などの、イベントから回復するために EEM が実行できるアクション。
イベントのトラブルシューティングまたはイベントからの回復を目的とした 1 つまたは複数のアクションとペアになったイベント。
EEM を使用しない場合は、個々のコンポーネントが独自のイベントの検出および処理を行います。 たとえば、ポートでフラップが頻繁に発生する場合は、「errDisable ステートにする」のポリシーが ETHPM に組み込まれます。
EEM ポリシーは、イベント文および 1 つまたは複数のアクション文からなります。 イベント文では、探すイベントとともに、イベントのフィルタリング特性を定義します。 アクション文では、イベントの発生時に EEM が実行するアクションを定義します。
たとえば、いつカードがデバイスから取り外されたかを識別し、カードの取り外しに関する詳細を記録する EEM ポリシーを設定できます。 カードの取り外しのインスタンスすべてを探すようにシステムに指示するイベント文および詳細を記録するようにシステムに指示するアクション文を設定します。
コマンドライン インターフェイス(CLI)または VSH スクリプトを使用して EEM ポリシーを設定できます。
EEM からデバイス全体のポリシー管理ビューが得られます。 EEM ポリシーが設定されると、対応するアクションがトリガーされます。 トリガーされたイベントのすべてのアクション(システムまたはユーザ設定)がシステムによって追跡され、管理されます。
Cisco NX-OS には、設定済みのさまざまなシステム ポリシーがあります。 これらのシステム ポリシーでは、デバイスに関連する多数の一般的なイベントおよびアクションが定義されています。 システム ポリシー名は、2 個の下線記号(__)から始まります。
一部のシステム ポリシーは上書きできます。 このような場合、イベントまたはアクションに対する上書きを設定できます。 設定した上書き変更がシステム ポリシーの代わりになります。
(注) |
上書きポリシーにはイベント文を含める必要があります。 イベント文が含まれていない上書きポリシーは、システム ポリシーで想定されるすべてのイベントを上書きします。 |
設定済みのシステム ポリシーを表示し、上書きできるポリシーを決定するには、show event manager system-policy コマンドを使用します。
ユーザ作成ポリシーを使用すると、ネットワークの EEM ポリシーをカスタマイズできます。 ユーザ ポリシーがイベントに対して作成されると、ポリシーのアクションは、EEM が同じイベントに関連するシステム ポリシー アクションをトリガーした後にのみトリガーされます。
EEM ポリシーの一致に関連するデータが格納されたログ ファイルは、/log/event_archive_1 ディレクトリにある event_archive_1 ログ ファイルで維持されます。
対応策、通知など、一部のアクションが実行されるデバイス アクティビティは、EEM によってイベントと見なされます。 イベントは通常、インターフェイスやファンの誤動作といったデバイスの障害に関連します。
イベント文は、どのイベントがポリシー実行のトリガーになるかを指定します。
ヒント |
ポリシー内に複数の EEM イベントを作成し、区別してから、カスタム アクションをトリガーするためのイベントの組み合わせを定義することで、イベントの組み合わせに基づいた EEM ポリシーをトリガーするように EEM を設定できます。 |
EEM ではイベント フィルタを定義して、クリティカル イベントまたは指定された時間内で繰り返し発生したイベントだけが関連付けられたアクションのトリガーになるようにします。
一部のコマンドまたは内部イベントが他のコマンドを内部的にトリガーします。 これらのコマンドは表示されませんが、引き続きアクションをトリガーするイベント指定と一致します。 これらのコマンドがアクションをトリガーするのを防ぐことはできませんが、どのイベントがアクションを引き起こしたかを確認できます。
EEM はイベント文で次のイベントをサポートします。
アクション文は、イベントが発生したときに、ポリシーによってトリガーされるアクションを説明します。 各ポリシーに複数のアクション文を設定できます。 ポリシーにアクションを関連付けなかった場合、EEM はイベント観察を続けますが、アクションは実行されません。
トリガーされたイベントがデフォルト アクションを処理するために、デフォルト アクションを許可する EEM ポリシーを設定する必要があります。 たとえば、一致文で CLI コマンドを照合する場合、EEM ポリシーに event-default アクション文を追加する必要があります。この文がないと、EEM ではコマンドを実行できません。
(注) |
ユーザ ポリシーまたは上書きポリシー内のアクション文を設定する場合、アクション文が、相互に否定したり、関連付けられたシステム ポリシーに悪影響を与えるようなことがないように確認することが重要です。 |
EEM がアクション文でサポートするアクションは、次のとおりです。
テキスト エディタを使用して、VSH スクリプトでポリシーを作成できます。 VSH スクリプトを使用して作成されたポリシーには、他のポリシーと同様にイベント文とアクション文が含まれます。また、これらのポリシーはシステム ポリシーを拡張するか、または無効にすることができます。
VSH スクリプト ポリシーを定義したら、それをデバイスにコピーしてアクティブにします。
この機能にはライセンスは不要です。 ライセンス パッケージに含まれていない機能はすべて Cisco NX-OS システム イメージにバンドルされており、追加費用は一切発生しません。 NX-OS ライセンス方式の詳細については、『Cisco NX-OS Licensing Guide』を参照してください。
EEM を設定するには、network-admin の権限が必要です。
EEM の設定を計画するときは、次の点を考慮します。
パラメータ | デフォルト |
---|---|
システム ポリシー | アクティブ |
環境変数の定義はオプションの手順ですが、複数のポリシーで繰り返し使用する共通の値を設定する場合に役立ちます。
ユーザ ポリシーを設定します。
イベント文およびアクション文を設定します。
イベント文を設定するには、EEM コンフィギュレーション モード(config-applet)で次のいずれかのコマンドを使用します。
ユーザ ポリシーを定義します。
アクション文を設定します。
すでにアクション文を設定した場合、または設定しないことを選択した場合は、次のオプション作業のいずれかを実行します。
EEM のコンフィギュレーション モード(config-applet)で次のいずれかのコマンドを使用して、アクションを設定できます。
(注) |
発生したイベントでデフォルトのアクションを処理できるようにする場合は、デフォルトのアクションを許可する EEM ポリシーを設定する必要があります。 たとえば、一致文でコマンドを照合する場合、EEM ポリシーに event-default アクション文を追加する必要があります。この文がないと、EEM ではコマンドを実行できません。 terminal event-manager bypass コマンドを使用すると、一致するすべての EEM ポリシーでコマンドを実行できます。 |
ユーザ ポリシーを定義します。
イベント文を設定します。
すでにイベント文を設定した場合、または設定しないことを選択した場合は、次のオプション作業のいずれかを実行します。
これはオプションのタスクです。 VSH スクリプトを使用して EEM ポリシーを記述する場合は、次の手順を実行します。
ステップ 1 | テキスト エディタで、ポリシーを定義するコマンド リストを指定します。 |
ステップ 2 | テキスト ファイルに名前をつけて保存します。 |
ステップ 3 | 次のシステム ディレクトリにファイルをコピーします。bootflash://eem/user_script_policies |
VSH スクリプト ポリシーを登録してアクティブにします。
これはオプションのタスクです。 VSH スクリプトを使用して EEM ポリシーを記述する場合は、次の手順を実行します。
ポリシーを VSH スクリプトを使用して定義し、システム ディレクトリにファイルをコピーします。
システム要件に応じて、次のいずれかを実行します。
メモリのしきい値は、イベントをトリガーし、メモリを割り当てることができない場合にオペレーティング システムがプロセスを停止するかどうかを設定するために使用されます。
システム要件に応じて、次のいずれかを実行します。
EEM パブリッシャとして syslog を設定すると、スイッチから syslog メッセージをモニタできます。
(注) |
syslog メッセージをモニタする検索文字列の最大数は 10 です。 |
EEM 設定を確認します。
設定を確認するには、次のいずれかのコマンドを使用します。
コマンド | 目的 |
---|---|
show event manager environment [variable-name | all] |
イベント マネージャの環境変数に関する情報を表示します。 |
show event manager event-types [event | all | module slot] |
イベント マネージャのイベント タイプに関する情報を表示します。 |
show event manager history events [detail] [maximum num-events] [severity {catastrophic | minor | moderate | severe}] |
すべてのポリシーについて、イベント履歴を表示します。 |
show event manager policy internal [policy-name] [inactive] |
設定したポリシーに関する情報を表示します。 |
show event manager policy-state policy-name |
しきい値を含め、ポリシーの状態に関する情報を表示します。 |
show event manager script system [policy-name | all] |
スクリプト ポリシーに関する情報を表示します。 |
show event manager system-policy [all] |
定義済みシステム ポリシーに関する情報を表示します。 |
show running-config eem |
EEM の実行コンフィギュレーションに関する情報を表示します。 |
show startup-config eem |
EEM のスタートアップ コンフィギュレーションに関する情報を表示します。 |
次に、モジュール 3 の中断のないアップグレードの障害のしきい値だけを変更することによって、__lcm_module_failure システム ポリシーを上書きする例を示します。 また、syslog メッセージも送信します。 その他のすべての場合、システム ポリシー __lcm_module_failure の設定値が適用されます。
event manager applet example2 override __lcm_module_failure event module-failure type hitless-upgrade-failure module 3 count 2 action 1 syslog priority errors msg module 3 "upgrade is not a hitless upgrade!" action 2 policy-default
次に、__ethpm_link_flap システム ポリシーを上書きし、インターフェイスをシャット ダウンする例を示します。
event manager applet ethport override __ethpm_link_flap event policy-default count 2 time 1000 action 1 cli conf t action 2 cli int et1/1 action 3 cli no shut
次に、ユーザがデバイスでコンフィギュレーション モードを開始すると、コマンドを実行できるが、SNMP 通知をトリガーする EEM ポリシーを作成する例を示します。
event manager applet TEST event cli match "conf t" action 1.0 snmp-trap strdata "Configuration change" action 2.0 event-default
(注) |
EEM ポリシーに event-default アクション文を追加する必要があります。この文がないと、EEM ではコマンドを実行できません。 |
次に、EEM ポリシーの複数イベントを関連付け、イベント トリガーの組み合わせに基づいてポリシーを実行する例を示します。 この例では、EEM ポリシーは、指定された syslog パターンのいずれかが 120 秒以内に発生したときにトリガーされます。
event manager applet eem-correlate event syslog tag one pattern "copy bootflash:.* running-config.*" event syslog tag two pattern "copy run start" event syslog tag three pattern "hello" tag one or two or three happens 1 in 120 action 1.0 reload module 1
関連項目 | マニュアル タイトル |
---|---|
EEM コマンド |
『Cisco Nexus 3000 Series NX-OS System Management Command Reference』 |
この機能では、新規の標準がサポートされることも、一部変更された標準がサポートされることもありません。また、既存の標準に対するサポートが変更されることもありません。
機能名 | リリース | 機能情報 |
---|---|---|
Embedded Event Manager(EEM) | 5.0(3)U3(1) | 機能が追加されました。 |