Source:How to Configure Mail Notification-Jaglion: Difference between revisions

From SEPsesam
No edit summary
m (Sta moved page How to configure Mail Notification to How to Configure Mail Notification without leaving a redirect: Part of translatable page "How to configure Mail Notification")
(14 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== Configuration of Mail Notification in SEP Sesam ==
<translate><!--T:1-->
<div class="noprint"><languages />
{{Copyright SEP AG en}}
{{Navigation_latest|release=[[Special:MyLanguage/SEP_sesam_Release_Versions|4.4.3/4.4.3 ''Beefalo'']]|link=[[Special:MyLanguage/SEP_sesam_Documentation#previous|documentation archive]]}}</div></translate><br />
<translate>==Overview== <!--T:2--></translate>
<div class="boilerplate metadata" id="Additional resources" style="background-color:#ecedf1; color:#8695a7; border: 1px ridge #cdd3db; margin: 0.5em; padding: 0.5em; float: right; width: 25%; "><center><b><translate><!--T:3-->
Additional resources</translate></b></center>


This short Howto will describe how to configure Mail Notification with SEP Sesam.
{|style="margin: auto; margin-bottom:1em; width:100%; border:0px solid grey;"
| rowspan="2" style="padding:0px 10px 0px;" | <translate><!--T:4-->
[[File:SEP Tip.png|45px|link=Special:MyLanguage/4_4_3_Beefalo:Configuration#mail|Email settings and interfaces]]</translate>
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" | <translate><!--T:5-->
See also: [[Special:MyLanguage/4_4_3_Beefalo:Configuration#mail|Email settings and interfaces]] – [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery|Disaster interface]]</translate>
|}


=== E-Mail Interfaces ===
{|style="margin: auto; margin-bottom:1em; width:100%; border:0px solid grey;"
| rowspan="2" style="padding:0px 10px 0px;" |
<translate><!--T:6-->
[[File:SEP Tip.png|45px|link=Special:MyLanguage/FAQ|FAQ]]</translate>
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" |
<translate><!--T:7-->
Check [[Special:MyLanguage/FAQ#encryption_and_compression|FAQ]] to find the answers to most common questions.</translate>
|}


The Notification is done via several "Interface" Scripts. These scripts are by default
{|style="margin: auto; margin-bottom:1em; width:100%; border:0px solid grey;"
included in a SEP Sesam Server installation, but will not be configured.
| rowspan="2" style="padding:0px 10px 0px;" | <translate><!--T:8-->
[[File:SEP Troubleshooting.png|45px|link=Special:MyLanguage/Troubleshooting_Guide|Troubleshooting Guide]]</translate>
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" | <translate><!--T:9-->
Problems? Check the [[Special:MyLanguage/Troubleshooting_Guide| Troubleshooting Guide]].</translate>
|}</div>
<translate><!--T:10-->
SEP sesam email notification is based on [[Special:MyLanguage/SEP_sesam_Glossary#interfaces|''interface'']] scripts that has to be activated first. You can activate them via [[Special:MyLanguage/How_to_configure_Mail_Notification#interfaces|GUI]] or manually by [[Special:MyLanguage/How_to_configure_Mail_Notification#copy|copying]] the templates that are available in the SEP sesam directory {{path|<SESAM_ROOT>/skel/templates}}.  


The following Interfaces exist:
<!--T:11-->
SEP sesam interfaces require a [[Special:MyLanguage/How_to_configure_Mail_Notification#email|configured email account]] that is used for sending the selected notifications by email.


sm_notify   : sends E-Mail about Backups/Restores and status E-Mails upon the Newday event
<!--T:12-->
sm_alarm   : sends E-Mail if there are problems with tapes (no tape, wrong tape inserted ..)
The following ''interfaces'' exist:</translate>
sm_disaster : sends disaster information if SESAM_BACKUP is executed.
*<tt>'''sm_notify'''</tt>: <translate><!--T:13-->
''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.</translate>
*<tt>'''sm_alarm'''</tt>: <translate><!--T:14-->
''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.</translate>
*<tt>'''sm_disaster'''</tt>: <translate><!--T:15-->
This interface must be properly configured to help carry out the disaster recovery process. For details on how to prepare, see [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery|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.


The E-Mails will be sent to the user accounts defined in the SEP sesam GUI (Configuration: E-Mail Settings)
=={{anchor|interfaces}}Configuring interfaces== <!--T:16-->


<!--T:17-->
The interface templates are located in the SEP sesam directory {{path|<SESAM_ROOT>/skel/templates}}. You can activate them automatically via GUI or manually by copying them.


==== Configuration of the Interfaces ====
==={{anchor|GUI}}Activating ''interfaces'' via SEP sesam GUI=== <!--T:18--></translate>
<ol><li><translate><!--T:19-->
From '''Configuration''' -> '''Interfaces''', select the relevant interface type (''Alarm'', ''Disaster'' or ''Notify''), depending on which information you want to receive.</translate></li>
{{<translate><!--T:20-->
note</translate>|<translate><!--T:21-->
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 [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery#preparation|SEP sesam Server Disaster Recovery]].</translate>}}


The Interface files are installed in the so called "templates"
<translate><!--T:22-->
directory of the SEP sesam Server's installation path. They
[[Image:Configuration_interfaces.png|link=]]</translate>
have to be copied to the right directory.
<br clear=all>
<li><translate><!--T:23-->
Window with the ''interface script'' opens. Click '''Save'''  to activate the interface.</translate></li>
<translate><!--T:24-->
[[Image:Alarm_interface.png|link=]]</translate>
<br clear=all> 
</ol>
<translate><!--T:25-->
Upon saving the template script is read and copied to the {{path|<SESAM_ROOT>/bin/sesam}}. You can customize the script according to your needs. Now you have to configure an [[Special:MyLanguage/How_to_configure_Mail_Notification#email|email account]] to enable sending the selected notifications by email.


===== Windows =====
==={{anchor|copy}}Activating interfaces manually=== <!--T:26-->


The interfaces are (based on your installation Path) placed
<!--T:27-->
in for example:
Alternatively, you can activate the interfaces by copying the existing templates from the SEP sesam directory {{path|<SESAM_ROOT>/skel/templates}} to the directory {{path|<SESAM_ROOT>/bin/sesam}}. You can customize the script according to your needs.
 
  C:\SEPSesam\skel\templates\
 
The Files are named like:
 
sm_alarm.cmd
sm_notify.cmd
sm_disaster.cmd
 
Copy those files to:
C:\SEPSesam\bin\sesam
 
 
===== Linux =====
 
Like on Windows the templates are shipped within the sesam
installation path's template directory:
 
/opt/sesam/skel/templates
 
The scripts are named:


<!--T:28-->
By default, the interfaces are located in the SEP sesam {{path|<SESAM_ROOT>/skel/templates}} under the names:</translate>
  sm_notify
  sm_notify
  sm_alarm
  sm_alarm
  sm_disaster
  sm_disaster


Copy those scripts to:
<translate><!--T:29-->
 
Note that on Windows, all interfaces/commands have the ending <tt>.cmd</tt> or <tt>.ps1</tt> when using Powershell.
/opt/sesam/bin/sesam/
To activate the interfaces, copy the selected interfaces manually to {{path|<SESAM_ROOT>/bin/sesam}}.</translate>
 
{{<translate><!--T:30-->
==== Configure E-Mail recipients ====
note</translate>|<translate><!--T:31-->
 
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 [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery#preparation|SEP sesam Server Disaster Recovery]].</translate>}}
The Recipients are configured through the SEP sesam GUI.
<translate><!--T:32-->
 
Now you have to configure an [[Special:MyLanguage/How_to_configure_Mail_Notification#email|email account]] to enable sending the selected notifications by email.
Chose the Menu:
 
Configuration -> E-Mail Settings
 
and create a user account like shown in this screenshot, please replace
the values from the example with your desired E-Mail accounts.


[[Image:Mail_en.jpg]]
=={{anchor|email}}Configuring email account and recipients== <!--T:33--></translate>
<ol><li><translate><!--T:34-->
From '''Configuration''' -> '''E-mail Settings''', select '''Use Sesam mail program''' option and click '''New'''.</translate></li>
<translate><!--T:35-->
[[Image:Email_account.png|link=]]</translate>
<br clear=all>
<li><translate><!--T:36-->
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 [[Special:MyLanguage/4_4_3_Beefalo:Configuration#mail|Email settings]].</translate></li>
<translate><!--T:37-->
[[Image:Configuring_email_account.png|link=]]</translate>
<br clear=all>
<li><translate><!--T:38-->
Click '''Send Test Email''' to check if your email account is configured properly, and then click '''OK'''.</translate></li>
</ol>


{{Box_Hint|Please Note|The first line "Account" should always include "sesam"!}}
<translate><div class="noprint">
==See also== <!--T:39-->
[[Special:MyLanguage/4_4_3_Beefalo:Configuration#mail|Email settings and interfaces]] – [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery|Disaster interface]]</div></translate>

Revision as of 16:22, 29 November 2019

Other languages:

Template:Copyright SEP AG en

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.