Mail Notification for Backup/Route Change


This function improves manageability by sending mail notification when the line is switched to the backup line or when the gateway to a certain route is changed.


This function targets the following backup types:

  1. PP backup ("pp backup" command)
  2. LAN backup ("lan backup" command)
  3. TUNNEL backup ("tunnel backup" command)
  4. Backup for the route (network backup) ("ip route" command)

Compatible Models & Firmware Revisions

The following YAMAHA router models and firmware support the mail notification for backup/route change:

Model Firmware
RTX5000 Rev.14.00.15 or later
FWX120 Rev.11.03.16 or later
RTX810 Rev.11.01.15 or later

Notification trigger

Types of triggers for this function are the following:

  1. When switching of backups is configured as a trigger, the function is triggered by the following two types:
    When switched to the backup (PP, LAN, and TUNNEL)
    When switched back from the backup (PP, LAN, and TUNNEL)
  2. When the gateway for a certain route is changed

Mail notification

You can specify multiple interfaces and route information by using the following keywords:

  • When switched to the backup:
    • PP backup: pp
    • LAN backup: lan
    • TUNNEL backup: tunnel
  • Backup for route (network backup): route

You need to specify an interface number or route information after the keyword.
You can configure the interface number by specifying all interfaces (*), multiple interfaces (using comma), or a range of interfaces (using a comma or hyphen). Note that route information cannot be specified by range.

Mail protocols

This function supports the following protocols:

  • For sending: SMTP
  • For receiving: POP3, APOP

SMTP-AUTH (RFC2554) is supported for authentication before sending mail notification.

The supported authentication protocols are the following:

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

You can choose a transmission method from the following:

  • Normal transmission
  • POP before SMTP

Mail headers

The following mail headers are added:

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

Mail configuration

You can configure the mail settings using the following three steps:

  1. Mail server setting
  2. Settings of templates used for sending mails
  3. Detailed settings for each mail function

1. Mail server setting ("mail server xxx" command)

In this step, you configure the following settings for your mail server:

  • Setting name
  • SMTP server setting (including SMTP-AUTH and POP before SMTP)
  • POP server setting (including POP3 and APOP)
  • Timeout setting for the mail processing

The mail server setting is identified using an ID.

2. Settings of templates used for sending mails ("mail template" command)

In this step, you can configure the following settings regarding the content of the mail notification:

  • Mail server's setting ID
  • Mail header setting
  • Character code to be used when sending a mail
  • Wait time between the first backup notification and the actual mail notification
  • Whether log data is attached or not when a notification mail is sent

The mail content setting is identified using an ID.

3. Detailed settings for the service ("mail notify" command)

In this step, you can configure the settings specific to each service based on the mail content settings.
(Example) Mail notification during backup

  • Backup target setting (Multiple targets may be specified)

Aggregation of notification information

Notification is sent out in the following timing according to the configuration of the "mail notify" command.

  • Backup: When the specified interface is switched to the backup line or switched back from the backup line
  • Route: When the gateway to the specified route is changed

This function is designed not to send a lot of mails. When the first interface subject for mail notification is switched to the backup, the function waits for a certain time before sending mail notification. If one or more interfaces are switched to the backup before the time elapses, information on those interfaces is sent out collectively as one mail.
This wait time can be configured by the user (using the "mail template" command).

Example) Suppose that the target interfaces and routes for mail notification are the following:

- PP         1-3
- TUNNEL     1,4

Also, suppose that the wait time is 30 seconds and the following events take place:

- 0:00:00 TUNNEL1 is switched to the backup
- 0:00:10 PP1 is switched to the backup
- 0:00:30 TUNNEL4 is switched to the backup
- 0:00:31 The gateway to ROUTE is switched
- 0:00:33 PP2 is switched to the backup

The first mail is sent out as a single mail aggregating all backup information switched within 30 seconds after TUNNEL1 is switched to the backup.
Here, the backup information on TUNNEL1, PP1, and TUNNEL4 are sent out collectively as a single mail.
Then, the backup information on ROUTE and PP2 are sent out collectively as a single mail.

Maximum notification information aggregated within the wait time is limited to 100 events.

Notification content

The content of the notification mail sent by this function is as described below:

  • Subject (Specified by the user. If the subject is not specified, the default value is used)
  • Body
    • Title
    • Model name
    • Revision
    • sysName's setting name (If specified)
    • sysLocation's setting name (If specified)
    • Notification time (Actual date and time when the mail is sent out)
    • Template ID
    • Switching details for each interface (Source I/F, destination I/F, and switched time)
    • Logs that are recorded in the several minutes before the mail notification

Cancellation of notification

If the corresponding "mail server smpt/pop" command or configuration of "mail template" command is deleted during the wait time for mail notification, the waiting operation is canceled at that point in time.

Error processing during execution

If an error occurs during the mail transmission and the execution stops, the function will attempt to send out the mail notification again after the wait time specified by the "mail template" command.
The number of retries is three times (fixed), which means four retries are made including the first attempt.
When the last attempt fails, the mail notification process is terminated.
If a notification of backup/route change matching the template ID occurs during these retries, the notification is sent out as a separate mail.
This also applies to cases in which the router logs are attached.
Even if additional backup/route change notifications occur, the number of retries is not updated. The mail notification process is terminated after four failed attempts.

                   First notification process ---- Failed
Backup notification --------->| <- Notified in a separate new mail... (*1)
                          1st retry
Route change notification --> | <- Added to the mail in (*1) if within the wait time in (*1)
                              |    Notified in a separate new mail if the wait time in (*1) has expired
                          2nd retry
                          3rd retry
                       End (Process fail)

Note that the timeout value specified by the "mail server timeout" command is reset after every retry.


Refer to the Command Reference for "Triggered Mail Notification Function".

Notification mail example

Model:  FWX120
Revision:  Rev.11.03.16
Time:  2016/11/25 13:23:09
Template ID:  1

ID   Time                   Status     Backup Interface Information
0001 2016/11/25 13:22:57     Switched          LAN2 -> LAN1

ID   Time                   Route Change Information
0001 2016/11/25 13:23:05     Gateway for [default] changes to [pp1]

Return to Top