How to Configure Mail Notification

From SEPsesam
Jump to: navigation, search
This page contains changes which are not marked for translation.

Other languages:
Deutsch • ‎English

Copyright © SEP AG 1999-2019. All rights reserved.

Any form of reproduction of the contents or parts of this manual is allowed only with the express written permission from SEP AG. When compiling and designing user documentation SEP AG uses great diligence and attempts to deliver accurate and correct information. However, SEP AG cannot issue a guarantee for the contents of this manual.

Docs latest icon.png Welcome to the latest SEP sesam documentation version 4.4.3/4.4.3 Beefalo. For previous documentation version(s), check documentation archive.


Overview

SEP sesam email notification is based on interface scripts that has to be activated first. You can activate them via GUI or manually by copying the templates that are available in the SEP sesam directory <SESAM_ROOT>/skel/templates.

SEP sesam interfaces require a configured email account that is used for sending the selected notifications by email.

The following interfaces exist:

  • sm_notify: Notify is executed on the SEP sesam Server. It can be used for reporting on successfully finished events, such as backup, restore, migration, media initialization, and start/finish of a NEWDAY event.
  • sm_alarm: Alarm is executed on the SEP sesam Server to warn the system administrator when a fatal error occurs or in case of a license violation.
  • sm_disaster: This interface must be properly configured to help carry out the disaster recovery process. For details on how to prepare, see SEP sesam Server Disaster Recovery. The disaster interface sends an email describing the recovery procedure in the event of a disaster and an attachment containing the SEP sesam bootstrap database with all essential data for the disaster recovery. sm_disaster is always called after the task SESAM_BACKUP is finished.

Configuring interfaces

The interface templates are located in the SEP sesam directory <SESAM_ROOT>/skel/templates. You can activate them automatically via GUI or manually by copying them.

Activating interfaces via SEP sesam GUI

  1. From Configuration -> Interfaces, select the relevant interface type (Alarm, Disaster or Notify), depending on which information you want to receive.
  2. Information sign.png Note
    The Disaster interface should always be configured to help carry out the disaster recovery process in case of a SEP sesam Server breakdown. This means that you have to configure at least one backup task with the name SESAM_BACKUP. For details, see SEP sesam Server Disaster Recovery.

    Configuration interfaces.png

  3. Window with the interface script opens. Click Save to activate the interface.
  4. Alarm interface.png

Upon saving the template script is read and copied to the <SESAM_ROOT>/bin/sesam. You can customize the script according to your needs. Now you have to configure an email account to enable sending the selected notifications by email.

Activating interfaces manually

Alternatively, you can activate the interfaces by copying the existing templates from the SEP sesam directory <SESAM_ROOT>/skel/templates to the directory <SESAM_ROOT>/bin/sesam. You can customize the script according to your needs.

By default, the interfaces are located in the SEP sesam <SESAM_ROOT>/skel/templates under the names:

sm_notify
sm_alarm
sm_disaster

Note that on Windows, all interfaces/commands have the ending .cmd or .ps1 when using Powershell. To activate the interfaces, copy the selected interfaces manually to <SESAM_ROOT>/bin/sesam.

Information sign.png Note
The Disaster interface should always be configured to help carry out the disaster recovery process in case of a SEP sesam Server breakdown. This means that you have to configure at least one backup task with the name SESAM_BACKUP. For details, see SEP sesam Server Disaster Recovery.

Now you have to configure an email account to enable sending the selected notifications by email.

Configuring email account and recipients

  1. From Configuration -> E-mail Settings, select Use Sesam mail program option and click New.
  2. Email account.png

  3. The E-mail Account window opens. Use the account name sesam (the default email account) as shown in the example below, and enter the email addresses of the recipients. For details, see Email settings.
  4. Configuring email account.png

  5. Click Send Test Email to check if your email account is configured properly, and then click OK.