バックアップ/経路変更時のメール通知機能

目的

バックアップ回線への切り替え時、またはある経路に対するゲートウェイが変更された時に、変更内容をメールを通知することで管理の利便性を向上させることができます。

対象

今回の機能の対象となるバックアップ種別

  1. PPバックアップ(pp backupコマンド)
  2. LANバックアップ(lan backupコマンド)
  3. TUNNELバックアップ(tunnel backupコマンド)
  4. 経路(ネットワークバックアップ)に対するバックアップ(ip routeコマンド)

通知トリガー

今回の機能のトリガーとなる種別

  1. バックアップの切り替えをトリガーとした場合は次の2種類が該当します。
    ・バックアップ切り替え時(PP、LAN、TUNNEL)
    ・バックアップ切り戻し時(PP、LAN、TUNNEL)
  2. ある経路に対するゲートウェイが変更された時

メール通知

通知対象インターフェイスおよび経路情報は複数指定でき、各キーワードは

  • バックアップ切り替え時
    • PPバックアップ:pp
    • LANバックアップ:lan
    • TUNNELバックアップ:tunnel
  • 経路(ネットワークバックアップ)に対するバックアップ:route

となり、キーワードのあとに、インターフェイス番号や経路情報を指定します。
インターフェイス番号は、すべて(*)、カンマおよびハイフンによる複数および範囲指定可能(経路情報は範囲指定不可能)となります。

メールのプロトコル

今回サポートするメール用プロトコル

  • 送信用:SMTP
  • 受信用:POP3, APOP

になり、送信時の認証としては、SMTP-AUTH(RFC2554)をサポートします。

認証プロトコルとしては下記をサポートします。

  • PLAIN (RFC2595)
  • DIGEST-MD5 (RFC2831)
  • CRAM-MD5 (RFC2195)

また、送信時の方法として、下記を選択できるようにします。

  • 通常送信
  • POP before SMTP

メールヘッダ

メールのヘッダは、下記を付加します。

  • From:
  • To:
  • Subject:
  • Data:
  • MIME-version:
  • Content-Type:

メール設定

メールの設定については下記の3段階によって行います。

  1. メールサーバの設定
  2. メール送信時に使用するテンプレートの設定
  3. 各メール用機能の詳細設定

1. メールサーバの設定(mail server xxxコマンド)

メールサーバの設定では、メールサーバに関する設定を行います。

  • 設定名
  • SMTPサーバの設定(SMTP-AUTH, POP before SMTPも含む)
  • POPサーバの設定(POP3, APOPも含む)
  • メール処理のタイムアウトの設定

になり、メールサーバの設定はIDによって区別されます。

2. メール送信時に使用するテンプレートの設定(mail templateコマンド)

ここでは、どういった内容のメールを送信するかの設定を行います。

  • 使用メールサーバの設定ID
  • メールヘッダの設定
  • 送信時の文字コード
  • バックアップ通知が最初に通知されてから送信するまでの時間
  • 通知系メール送信におけるログの添付の有無

になり、メール内容の設定はIDによって区別されます。

3. サービスの詳細設定(mail notifyコマンド)

サービスの詳細設定はメール内容の設定に基づき各サービス固有の設定を行います。
(例) バックアップ時のメール通知

  • バックアップ対象の設定(複数可)

通知情報の集約

通知情報は、mail notifyコマンドで指定した設定に応じて、次のタイミングで通知されます。

  • バックアップを指定した場合:指定されたインターフェイスがバックアップに切り替わった、または切り戻ったタイミング
  • 経路を指定した場合:指定した経路に対してゲートウェイが変更されたタイミング

大量のメールが送信されないように、設定されたインターフェイス群のうち最初のバックアップが開始された後、一定時間内はメールを送信せず、その間に対象インターフェイスに対してバックアップに切り替わったならば、その情報をまとめて、一定時間が経過したあとに通知されます。
この待機時間はユーザが設定することができます(mail templateコマンド)。

例) メール通知対象インターフェイスおよび経路が

- PP         1-3
- TUNNEL     1,4
- ROUTE      192.168.1.0/24

で、待機時間として30秒と設定しているときに、

- 0:00:00 TUNNEL1がバックアップに切り替わる
- 0:00:10 PP1がバックアップに切り替わる
- 0:00:30 TUNNEL4がバックアップに切り替わる
- 0:00:31 ROUTE 192.168.1.0/24に対するゲートウェイが切り替わる
- 0:00:33 PP2がバックアップに切り替わる

となった場合に、
最初のメールはTUNNEL1がバックアップに切り替わってから30秒以内に切り替わったバックアップ情報はすべて集約されて1通のメールとして送信されます。
ここでは、TUNNEL1, PP1, TUNNEL4のバックアップ情報が一つのメールとして送信されます。
また、ROUTE 192.168.1.0/24, PP2のバックアップ情報が一つのメールとして送信されます。

待機時間内に集約する通知情報は最大100件に制限してあります。

メールの内容

今回通知されるメール内容は

  • サブジェクト(ユーザ指定。なければデフォルト値を使用する)
  • 本文
    • タイトル
    • 機種名
    • リビジョン
    • sysNameの設定名(設定されていれば)
    • sysLocationの設定名(設定されていれば)
    • 通知時刻(実際にメールを送信したときの日時)
    • テンプレートID
    • 各インターフェイスの切り替え状況(元I/F, 先I/F, 切り替え時刻)
    • メール通知をする時刻から前数分間のログ

となります。

実行のキャンセル

メール通知処理のキャンセルとして、メール送信処理までの待機中に、該当する mail server smpt/pop コマンドの削除や、mail templateコマンドの設定を削除すると、その時点で待機処理はキャンセルされます。

実行時のエラー処理

メール送信実行時にエラーにより処理が停止した場合は、mail templateコマンドで設定された送信までの待機時間後に、再び送信処理が実行されます。
リトライ回数は3回(固定)で、最初の処理を含め、4回処理されることになります。
最後の処理が失敗すると、メール送信の処理は終了します。
リトライ中にテンプレートIDに合致するバックアップ/経路変更通知が発生すると、それは別メールの内容として通知されます。
また、ルータのログを添付する場合も同様です。
追加のバックアップおよび経路変更通知が発生しても、リトライ回数は更新されず、全体として4回の処理が失敗するとメール送信処理は終了します。

                   最初のメール処理 ---- 失敗
                          |
  バックアップ通知 -----> | <- 新たな別メールとして通知される ... (*1)
                          |
                     リトライ1回目
                          |
  経路変更通知 ---------> | <- (*1)の待機時間内であれば、(*1)のメールに追加される
                          |    (*1)の待機時間後であれば、新たな別メールとして通知される
                     リトライ2回目
                          |
                          |
                          |
                     リトライ3回目
                          |
                          V
                    終了(処理失敗)

なお、mail server timeoutコマンドで設定されたタイムアウト時間は、各リトライ処理毎にリセットされます。

設定コマンド

通知されるメールの例

Model: RTX1200
Revision: Rev.10.01.33
Time: 2012/09/13 14:55:08
Template ID: 1

ID   時刻                   状態     バックアップ時インターフェイス情報
----------------------------------------------------------------------------
0001 2012/09/13 14:54:58     切替        LAN3 -> LAN2

ID   時刻                   経路変更情報
----------------------------------------------------------------------------
0001 2012/09/13 14:55:04 [default] に対するゲートウェイが [pp1] に変更

ページトップへ戻る