Difference between revisions of "stoney backup: Notification Overview"
[unchecked revision] | [unchecked revision] |
(→Who will receive notification mails) |
(→Customer / User) |
||
Line 23: | Line 23: | ||
== Customer / User == | == Customer / User == | ||
# Check if the customer / user must be informed | # Check if the customer / user must be informed | ||
− | #* If <code>sstBackupWarnings</code> of the accounts backend (LDAP directory) entry is set to <code>TRUE</code>, the customer / user has to be informed | + | #* If <code>sstBackupWarnings</code> of the accounts backend (LDAP directory) entry is set to <code>TRUE</code> AND <code>sstNotificationWarningMedium</code> is set to <code>mail</code>, the customer / user has to be informed |
− | #* If <code>sstBackupWarnings</code> of the accounts backend (LDAP directory) entry is set to <code>FALSE</code>, the customer / user does not have to be informed | + | #* If <code>sstBackupWarnings</code> of the accounts backend (LDAP directory) entry is set to <code>FALSE</code> OR <code>sstNotificationWarningMedium</code> is not set to <code>mail</code>, the customer / user does not have to be informed |
# Check if the account itself has some E-Mail addresses attached | # Check if the account itself has some E-Mail addresses attached | ||
#* Check if the LDAP attribute <code>mail</code> exists for the accounts backend (LDAP directory) entry. | #* Check if the LDAP attribute <code>mail</code> exists for the accounts backend (LDAP directory) entry. | ||
− | #** If yes, send the mail to all (the attribute <code>mail</code> is multivalued, see [[ | + | #** If yes, send the mail to all (the attribute <code>mail</code> is multivalued, see [[stoney_backup:_OpenLDAP_directory_data_organisation#Backup_Account_Example | OpenLDAP directory data organisation]]) addresses specified in the attribute <code>mail</code> |
#** If not, check to whom the accounts belongs | #** If not, check to whom the accounts belongs | ||
# Check to which person the backup accounts belongs | # Check to which person the backup accounts belongs | ||
#* Read the attribute <code>sstBelongsToPersonUID</code> and search the given person UID in the backend (LDAP directory). | #* Read the attribute <code>sstBelongsToPersonUID</code> and search the given person UID in the backend (LDAP directory). | ||
#* Read the attibute <code>mail</code> from the persons bachend (LDAP directory) entry retrieved form the previous serach | #* Read the attibute <code>mail</code> from the persons bachend (LDAP directory) entry retrieved form the previous serach | ||
− | #* Send the mail to all (the attribute <code>mail</code> is multivalued, see [[ | + | #* Send the mail to all (the attribute <code>mail</code> is multivalued, see [[stoney_backup:_OpenLDAP_directory_data_organisation#Backup_Account_Example | OpenLDAP directory data organisation]]) addresses specified in the attribute <code>mail</code> |
== Reseller == | == Reseller == |
Revision as of 11:35, 31 January 2014
Contents
Overview
The pages gives you an overview of the stoney backup relevant notifications scripts.
Main tasks:
- Warns the user when the backup is running out of space (quota).
- Warns the user if the backup wasn't executed at the planned time (schedule).
- Informs the user if the backup was executed, but finished with errors (unsuccessful).
- If the Backup Client is too old, inform the user (upgrade) (not implemented yet).
- Tell the user, that they have a backup account, but it was never used (no backup) (not implemented yet).
Tasks
Quota
If the used quota in percentage is bigger than the threshold, the appropriate error message is sent (see who will be informed). The threshold is variable value which is read from the accounts backend (LDAP directory) entry. (The reseller and/or the customer can change the threshold for the given account using the selfcare web-interface (not implemented yet).)
Schedule
Each (more or less up-to-date) backup client (developed by stepping stone GmbH]) uploads scheduling information to the server when backing up a computer. According to the scheduling information, the server can check if a backup was executed at the correct time or not. If not an appropriate error message is sent (see who will be informed). (The reseller and/or customer can define after how many not executed backups he or she wants to be informed using the selfcare web-interface (not implemented yet).)
Unsuccessful
Each (more or less up-to-date) backup client (developed by stepping stone GmbH]) uploads the status of the backup to the server after backing up a computer. According to this status information, the server can check if the last backup was successful. If not an appropriate error message is sent (see who will be informed). (The reseller and/or customer can define after how many not successful backups he or she wants to be informed using the selfcare web-interface (not implemented yet).)
Who will receive notification mails
If one (or more) of the tasks result in sending an error message, the notification scripts collects the mail addresses to whom it must send the message(s) from the LDAP directory backend in the following way:
Customer / User
- Check if the customer / user must be informed
- If
sstBackupWarnings
of the accounts backend (LDAP directory) entry is set toTRUE
ANDsstNotificationWarningMedium
is set tomail
, the customer / user has to be informed - If
sstBackupWarnings
of the accounts backend (LDAP directory) entry is set toFALSE
ORsstNotificationWarningMedium
is not set tomail
, the customer / user does not have to be informed
- If
- Check if the account itself has some E-Mail addresses attached
- Check if the LDAP attribute
mail
exists for the accounts backend (LDAP directory) entry.- If yes, send the mail to all (the attribute
mail
is multivalued, see OpenLDAP directory data organisation) addresses specified in the attributemail
- If not, check to whom the accounts belongs
- If yes, send the mail to all (the attribute
- Check if the LDAP attribute
- Check to which person the backup accounts belongs
- Read the attribute
sstBelongsToPersonUID
and search the given person UID in the backend (LDAP directory). - Read the attibute
mail
from the persons bachend (LDAP directory) entry retrieved form the previous serach - Send the mail to all (the attribute
mail
is multivalued, see OpenLDAP directory data organisation) addresses specified in the attributemail
- Read the attribute
Reseller
Source Code
The source code is located in our GitHub Repository: