Mail Notification

1. Function Overview

The mail notification function sends mail notifications of information detected by the L2MS function or terminal monitoring function.
By specifying the following settings, mail notifications can be sent with information detected by various functions.

  • Specify settings for the mail server used to send mails.

  • Specify the mail template.

2. Definition of Terms Used

Mail Template

The mail template defines the collection of information needed for sending mail.

  • Mail server to use

  • Sender mail address

  • Recipient mail address

  • Subject of mail

  • Notification content

  • Transmission wait time

3. Function Details

3.1. Action

After mail server settings and mail template settings have been configured correctly, the mail notification function will enter the send-standby state whenever a notification event occurs for a function that supports mail notification.
When the mail notification function is in the send-standby state, the function will wait until the specified mail transmission wait time specified in each mail template elapses.
When the mail transmission wait time has elapsed, the mail notification function combines the information for notification events that occurred during the wait time into a single mail and sends it to the recipient.

3.2. Mail server settings

Settings can be specified in the List of Registered Mail Servers displayed by clicking [Detailed settings] - [mail notification] in the web GUI.
To display the Mail server settings, click the New button or the Setting button for existing settings.
In Mail server settings, make the following settings.

  • Account identification name
    Name for uniquely identifying the mail server settings. This setting may be omitted.

  • SMTP server address

  • SMTP server port number

  • Encrypting SMTP
    Selects either “SMTP over SSL” or “STARTTLS” as the encryption method.

  • SMTP authentication
    To use SMTP authentication, enter the username and password.

mail notify mail server en

3.3. Specify the mail template

Mail template settings can be specified by clicking [Detailed settings] - [mail notification] in the web GUI to display the List of mail notification settings.
Press the New button or the Setting button for an existing setting to display mail notification settings.
In mail notification settings, specify the following settings.

  • Source (From)

  • Destination (To)

  • Subject
    If the Use default subject box is checked, then the mail subject will always be in the form Notification from (device name).

  • Notification content
    Error types can be specified in detail for LAN map error detection, so that only the specified type of notifications are output.

  • Mail transmission wait time

mail notify mail template en

3.4. Functions that support mail notification

The following functions support mail notification.

  • LAN MAP
    The following notification events can be included in mail notifications.

    Category Type Event Description

    Device abnormality

    Fan error

    Fan Lock

    Fan stopped

    Fan speed

    Fan rotation speed increased

    Fan stop

    A specific fan stopped

    Power supply abnormality

    Power voltage

    Power supply voltage exceeded the upper threshold value

    Power supply

    Overcurrent occurred in power supply

    Temperature anomaly

    CPU temperature
    CPU temperature error
    PHY temperature
    PHY temperature error
    SFP temperature
    SFP module temperature error
    Unit temperature
    Unit temperature error
    PSE temperature
    PSE temperature error
    MAC temperature
    MAC temperature error

    Yamaha network switch temperature (CPU, PHY, SFP module, main unit, PSE, or MAC temperature) exceeded the upper threshold value

    The Yamaha network switch temperature returned to normal

    Thermal Sensor invalid

    A Yamaha network switch temperature sensor error occurred

    Loop Detection

    Loop was detected

    Loop Detect

    Loop was detected at a port

    The loop detected at the port was resolved

    SFP optical Rx level abnormality

    SFP optical input level error

    SFP RX Power

    SFP optical input level exceeded the threshold value

    SFP optical input level returned to the normal range

    Transmission Queue Monitoring

    Sending queue usage ratio error

    Queue Usage Rate

    Sending queue usage ratio increased

    Sending queue usage ratio reached upper limit

    Sending queue usage ratio returned to normal value

    PoE supply

    Temperature anomaly

    Over Temperature

    Power supply stopped due to a temperature anomaly

    Maximum power supply capacity was exceeded

    Over Supply

    The power supply exceeded the maximum supply capacity

    Power supply abnormality

    Power Failure

    The power supply source malfunctioned

    Power supply stopped due to a power supply class error

    Class Failure

    Power supply was stopped because a class greater than the power supply class setting was detected at the power supply port

    Power supply stopped due to a class4 power supply

    Forced Terminate

    Power supply to a port that was being supplied class3 (15.4 W) power was stopped due to a class4 (30 W) power supply at the port

    Power supply stopped due to overcurrent

    Over Current

    Power supply stopped because an excessive current was supplied to a port

    Power supply stopped because power supply capacity was exceeded

    PoE state error(over-supply)

    The power supply exceeded the maximum supply capacity

    Maximum power supply capacity exceeded has been resolved

    Power supply stopped due to temperature error

    PoE state error(over-temperature)

    Power supply stopped due to a temperature anomaly

    Power supply stop due to temperature error was resolved

    Power supply stopped due to stoppage of fan

    PoE state error(fanlock)

    Power supply stopped because the fan stopped

    Power supply stop due to stopped fan was resolved

    Power supply stopped due to power supply abnormality

    PoE state error(power-failure)

    Power supply stopped due to a PoE power supply abnormality

    Snapshot

    Invalid device connected

    Illegal Equipment(SnapShot)

    Device not registered in snapshot was detected

    Invalid device connection was resolved

    Connection port mismatch

    Port Mismatch(SnapShot)

    Device with a connection port that differs from snapshot was detected

    Connection port mismatch was resolved

    Device lost

    Disappearance Equipment(SnapShot)

    A device registered in the snapshot is not connected

    Device loss was resolved

    L2MS Manager Duplication

    L2MS Manager Duplication

    L2MS manager duplication

    A duplicate L2MS manager was detected

    The L2MS manager duplication was resolved

  • Terminal monitoring function
    The following notification events can be included in mail notifications.

    Category Type Description

    Ping monitoring

    Up detection

    Terminal up was detected

    Down detection

    Terminal down was detected

    Frame reception volume monitoring

    Up detection

    Terminal up was detected

    Down detection

    Terminal down was detected

    LLDP monitoring

    Up detection

    Terminal up was detected

    Down detection

    Terminal down was detected

  • Stack function
    The following notification events can be included in mail notifications.

    Type Description

    Stack port link down

    The stack port connected to the member switch went link-down

    Heartbeat error detection

    A member switch heartbeat error was detected

    Member switch was upgraded

    A member switch was upgraded to a main switch

3.5. Mail body example

The body of a notification mail includes content such as the following.
For details, refer to the technical reference for each function.
Up to 100 items can be included in one notification mail.

Model: SWX2310P-28GT                 * Model name
Revision: Rev.2.02.02                * Firmware version
Name: SWX2310P-28GT_XXXXXXXX         * Host name
Time: 2017/06/13 11:42:56            * Mail transmission time
Template ID: 1                       * Mail template ID

<<<<<<<<<<<<<<<<<<<<<<<<    Lan Map Information    >>>>>>>>>>>>>>>>>>>>>>>>>

[SFP RX Power]

  Type                                Device_Name
  MAC_Address                         Err_Port
  Route
  State
============================================================================
(Detected: 2017/06/13 10:09:40  Recovered: 2017/06/13 10:10:10)
  SWX2310P-10G                        SWX2310P-10G_S4K000398
  00a0.deae.b89c                      1.9
  port1.7(UpLink:1.5)
  Low
----------------------------------------------------------------------------

[Queue Usage Rate]

  Type                                Device_Name
  MAC_Address                         Err_Port
  Route
  State
============================================================================
(Detected: 2017/06/13 10:15:42  Recovered: 2017/06/13 10:17:24)
  SWX2310P-10G                        SWX2310P-10G_S4K000398
  00a0.deae.b89c                      1.6
  port1.7(UpLink:1.5)
  Full(Queue:2)
----------------------------------------------------------------------------

[Fan Lock]

  Type                                Device_Name
  MAC_Address
  Route
============================================================================
(Detected: 2017/06/13 10:28:43  Recovered: ----/--/-- --:--:--)
  SWX2200-8PoE                        SWX2200-8PoE_S45000345
  00a0.de83.4146
  port1.5(UpLink:2)
----------------------------------------------------------------------------
(Detected: 2017/06/13 10:42:13  Recovered: 2017/06/13 10:42:22)
  SWX2200-24G                         SWX2200-24G_X00000344
  00a0.de2a.dbbb
  port1.1(UpLink:23)
----------------------------------------------------------------------------

<<<<<<<<<<<<<<<<<<    Terminal Monitoring Information    >>>>>>>>>>>>>>>>>>>

[via Ping]

 Date                      Status    IP Address        Description
----------------------------------------------------------------------------
 2017/06/13 Thu 10:42:56   UP        192.168.100.155   IP_Camera_1
 2017/06/13 Thu 10:51:00   DOWN      192.168.100.155   IP_Camera_1
 2017/06/13 Thu 10:54:02   UP        192.168.100.10    Wireless_AP_1
 2017/06/13 Thu 11:29:27   UP        192.168.100.155   IP_Camera_1
 2017/06/13 Thu 11:30:31   DOWN      192.168.100.10    Wireless_AP_1

[via Bandwidth Usage]

 Date                      Status    Interface         Description
----------------------------------------------------------------------------
 2017/06/13 Thu 10:45:43   UP        port1.4           IP_Camera_2
 2017/06/13 Thu 10:45:56   UP        port1.6           Note_PC_1
 2017/06/13 Thu 10:50:00   DOWN      port1.6           Note_PC_1
 2017/06/13 Thu 10:53:27   DOWN      port1.4           IP_Camera_2

[via LLDP]

 Date                      Status    Interface         Description
----------------------------------------------------------------------------
 2017/06/13 Thu 10:53:56   UP        port1.3           Note_PC_2
 2017/06/13 Thu 11:11:54   DOWN      port1.3           Note_PC_2
 2017/06/13 Thu 11:14:24   UP        port1.3           Note_PC_2

<<<<<<<<<<<<<<<<<<<<<<<<<<    Stack Information    >>>>>>>>>>>>>>>>>>>>>>>>>

 Date                      Information
----------------------------------------------------------------------------
 2017/06/13 Thu 10:53:44   The stack port changed state to down. (port1.27)
 2017/06/13 Thu 10:53:46   Promoted to a main. (Old main ID : 1)
 2017/06/13 Thu 10:59:10   Occurred the heartbeat error. (ID : 1)

3.5.1. Content of LAN map notifications

  • Notification content of each event
    The content of LAN map notification mails differs depending on the event type.
    The content of notifications for each event type is indicated below.

    Event Type
    Device_Name
    MAC_Address    		 Comment Stack_ID Err_Port Fan_number Route Route(SnapShot) State

    Fan Lock

    Yes

    No

    No

    No

    No

    Yes

    No

    No

    Fan speed

    No

    Yes

    No

    No

    Yes

    No

    No

    Fan stop

    No

    Yes

    No

    Yes

    Yes

    No

    No

    Power voltage
    Power supply

    No

    Yes

    No

    No

    Yes

    No

    No

    CPU temperature
    CPU temperature error
    PHY temperature
    PHY temperature error
    SFP temperature
    SFP module temperature error
    Unit temperature
    Unit temperature error
    PSE temperature
    PSE temperature error
    MAC temperature
    MAC temperature error
    Thermal Sensor invalid

    No

    Yes

    No

    No

    Yes

    No

    No

    Loop Detect

    No

    No

    Yes

    No

    Yes

    No

    No

    SFP RX Power

    No

    No

    Yes

    No

    Yes

    No

    Yes

    Over Temperature
    Over Supply
    Power Failure

    No

    No

    No

    No

    Yes

    No

    No

    Class Failure
    Forced Terminate
    Over Current

    No

    No

    Yes

    No

    Yes

    No

    No

    PoE state error(over-supply)
    PoE state error(over-temperature)
    PoE state error(fanlock)
    PoE state error(power-failure)

    No

    Yes

    No

    No

    Yes

    No

    No

    Illegal Equipment(SnapShot)

    Yes

    No

    No

    No

    Yes

    No

    No

    Port Mismatch(SnapShot)

    Yes

    No

    No

    No

    Yes

    Yes

    No

    Disappearance Equipment(SnapShot)

    Yes

    No

    No

    No

    No

    Yes

    No

    L2MS manager duplication

    Yes

    No

    Yes

    No

    Yes

    No

    No

  • Detailed content of notification
    A detailed description of the various information included in notifications is indicated below.

    Notification content Example: Description

    Detected

    Detected: 2021/10/01 8:25:40

    Indicates the date/time the error occurred.

    Recovered

    Recovered: 2021/10/01 10:09:40

    Indicates the date/time the error was resolved.

    Type

    SWX2310P-28GT

    Indicates the model name.

    Device_Name

    SWX2310P-28GT_XXXXXXXXXX

    Indicates the device name.

    MAC_Address

    ac44.f2xx.xxxx

    Indicates the MAC address.

    Comment

    Snapshot:
    Comment

    Indicates comments specified in the LAN map device list.

    L2MS manager duplication:
    ac44.f2xx.xxxx

    Indicates the MAC address of duplicate L2MS managers.

    Stack_ID

    1

    Indicates the stack ID.

    Err_Port

    1.5

    Indicates the port number where the error occurred.

    Fan_number

    1

    Indicates the fan number where the error occurred.

    Route

    port1.20(UpLink:1.2)

    Indicates routing information for applicable devices.

    Route(SnapShot)

    port1.20(UpLink:1.2)

    Indicates routing information on the snapshot for applicable devices.

    State

    SFP optical Rx level abnormality:
    Low

    Indicates SFP optical input level as either “Low” or “High”.

    Transmission queue monitoring:
    Full (Queue: 2)

    Indicates either “Busy” or “Full” as the transmission queue usage status and the transmission queue number.

4. Related Commands

Related commands are indicated below.
For details on the commands, refer to the Command Reference.

Operations Operating commands

SMTP mail server setting

mail server smtp host

SMTP mail server name setting

mail server smtp name

Mail notification trigger setting

mail notify trigger

Mail sending template setting mode

mail template

Mail sending server ID setting

send server

Mail sender address setting

send from

Mail recipient address setting

send to

Mail subject setting

send subject

Mail wait time setting

send notify wait-time

Mail certificate setting

mail send certificate

Mail certificate notification setting

mail send certificate-notify

Certificate expiration date notification timing setting

mail certificate expire-notify

Show mail information

show mail information

5. Points of Caution

The following are precautions related to SMTP authentication.

  • The SMTP authentication only supports the LOGIN method.

  • PLAIN, CRAM-MD5, and other methods are not supported.

Precautions for using firmware not compatible with the mail notification function.

  • If the firmware is updated from a version that does not support a command to a version that does support the command, commands specified in the web GUI are directly carried over as command settings.

  • To revert to the firmware version that does not support the commands, any changes to settings made using the firmware that does support the commands are not migrated and must be specified again after restoring the older version.

  • If no settings were changed, then the current settings can be maintained.

The following are precautions related to LAN map error detection.

  • Errors are indicated in notifications as active until the error is resolved, even if the error notification is disabled without resolving the error.

  • Specifically, even after a notification is disabled, an mail is sent after the error is resolved and is included in mails about the occurrence of other errors.

6. Related Documentation