Source:How to Configure Mail Notification-Jaglion: Difference between revisions
(Marked this version for translation) |
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") |
||
(5 intermediate revisions by 3 users not shown) | |||
Line 2: | Line 2: | ||
<div class="noprint"><languages /> | <div class="noprint"><languages /> | ||
{{Copyright SEP AG en}} | {{Copyright SEP AG en}} | ||
{{Navigation_latest|release=4.4.3|link=[[Special:MyLanguage/SEP_sesam_Documentation#previous|documentation archive]]}}</div></translate><br /> | {{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> | <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--> | <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--> | ||
Line 9: | Line 9: | ||
{|style="margin: auto; margin-bottom:1em; width:100%; border:0px solid grey;" | {|style="margin: auto; margin-bottom:1em; width:100%; border:0px solid grey;" | ||
| rowspan="2" style="padding:0px 10px 0px;" | <translate><!--T:4--> | | rowspan="2" style="padding:0px 10px 0px;" | <translate><!--T:4--> | ||
[[File:SEP Tip.png|45px|link=Special:MyLanguage/ | [[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--> | | style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" | <translate><!--T:5--> | ||
See also: [[Special:MyLanguage/ | See also: [[Special:MyLanguage/4_4_3_Beefalo:Configuration#mail|Email settings and interfaces]] – [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery|Disaster interface]]</translate> | ||
|} | |} | ||
Line 40: | Line 40: | ||
''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> | ''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--> | *<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.</translate> | ''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--> | *<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. | 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. | ||
Line 66: | Line 66: | ||
</ol> | </ol> | ||
<translate><!--T:25--> | <translate><!--T:25--> | ||
Upon saving the template script is read and copied to the {{path|<SESAM_ROOT>/bin/sesam}}. Now you have to configure an [[Special:MyLanguage/How_to_configure_Mail_Notification#email|email account]] to enable sending the selected notifications by email. | 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. | ||
==={{anchor|copy}}Activating interfaces manually=== <!--T:26--> | ==={{anchor|copy}}Activating interfaces manually=== <!--T:26--> | ||
<!--T:27--> | <!--T:27--> | ||
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}}. | 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. | ||
<!--T:28--> | <!--T:28--> | ||
Line 95: | Line 95: | ||
<br clear=all> | <br clear=all> | ||
<li><translate><!--T:36--> | <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 | 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--> | <translate><!--T:37--> | ||
[[Image:Configuring_email_account.png|link=]]</translate> | [[Image:Configuring_email_account.png|link=]]</translate> | ||
Line 105: | Line 105: | ||
<translate><div class="noprint"> | <translate><div class="noprint"> | ||
==See also== <!--T:39--> | ==See also== <!--T:39--> | ||
[[Special:MyLanguage/ | [[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 17:22, 29 November 2019
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
- From Configuration -> Interfaces, select the relevant interface type (Alarm, Disaster or Notify), depending on which information you want to receive.
- Window with the interface script opens. Click Save to activate the interface.
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. |
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
.
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
- From Configuration -> E-mail Settings, select Use Sesam mail program option and click New.
- 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.
- Click Send Test Email to check if your email account is configured properly, and then click OK.