Source:HCL Domino Server Configuration: Difference between revisions
(Fixed links for SEP download center.) |
No edit summary |
||
Line 28: | Line 28: | ||
{{Domino rebrand en}} | {{Domino rebrand en}} | ||
[[Special:MyLanguage/SEP_sesam_Glossary#SBC|SEP sesam Client SBCLN]] is a program library for backing up IBM Domino (previously Lotus Domino) databases. All required components for IBM Domino server backup are already included in the regular SEP sesam Client for Windows | [[Special:MyLanguage/SEP_sesam_Glossary#SBC|SEP sesam Client SBCLN]] is a program library for backing up IBM Domino (previously Lotus Domino) databases. All required components for IBM Domino server backup are already included in the regular SEP sesam Client for Windows and Linux package. Once the extension is present and all the [[Special:MyLanguage/4_4_3_Beefalo:IBM_Domino_Server_Configuration#requirements|requirements]] are met, you have to configure your client for the use with SEP sesam environment. For details, see section [[Special:MyLanguage/4_4_3_Beefalo:IBM_Domino_Server_Configuration#configuration|Configuring IBM Domino server as a SEP sesam client]]. | ||
Additionally, to perform IBM Domino database-level backups, you have to enable and set up ''transaction logging'' in ''Archived'' mode on the IBM Domino server. Note that Domino databases can also be backed up with transaction logging disabled, however, this is not recommended as it only allows for FULL backups of databases and requires much more frequent full database backups. For details, see section [[Special:MyLanguage/4_4_3_Beefalo:IBM_Domino_Server_Configuration#transaction_logging|Enabling ''transaction logging'' in ''Archive'' mode]]. | Additionally, to perform IBM Domino database-level backups, you have to enable and set up ''transaction logging'' in ''Archived'' mode on the IBM Domino server. Note that Domino databases can also be backed up with transaction logging disabled, however, this is not recommended as it only allows for FULL or COPY backups of databases and requires much more frequent full database backups. For details, see section [[Special:MyLanguage/4_4_3_Beefalo:IBM_Domino_Server_Configuration#transaction_logging|Enabling ''transaction logging'' in ''Archive'' mode]]. | ||
{{Cheatsheet| | {{Cheatsheet| | ||
#Install SEP sesam Client on IBM Domino server. | #Install SEP sesam Client on IBM Domino server. | ||
#[[Special:MyLanguage/4_4_3_Beefalo:IBM_Domino_Server_Configuration#configuration| | #Add the IBM Domino server [[Special:MyLanguage/4_4_3_Beefalo:IBM_Domino_Server_Configuration#configuration|as client to the SEP sesam environment]]. | ||
#Set the required variables [[4_4_3_Beefalo:IBM_Domino_Server_Configuration#Linux|on Linux]] or [[Special:MyLanguage/4_4_3_Beefalo:IBM_Domino_Server_Configuration#Windows|on Windows]], including the ''Path'' environment variable. | #Set the required variables [[4_4_3_Beefalo:IBM_Domino_Server_Configuration#Linux|on Linux]] or [[Special:MyLanguage/4_4_3_Beefalo:IBM_Domino_Server_Configuration#Windows|on Windows]], including the ''Path'' environment variable. | ||
#Enable [[Special:MyLanguage/4_4_3_Beefalo:IBM_Domino_Server_Configuration#transaction_logging|''transaction logging'' in ''Archive'' mode]] on the IBM Domino server. | #Enable [[Special:MyLanguage/4_4_3_Beefalo:IBM_Domino_Server_Configuration#transaction_logging|''transaction logging'' in ''Archive'' mode]] on the IBM Domino server. | ||
Line 82: | Line 82: | ||
Once you have installed your [https://download.sep.de/windows/ SEP sesam Windows Client] on the IBM Domino server, proceed as follows: | Once you have installed your [https://download.sep.de/windows/ SEP sesam Windows Client] on the IBM Domino server, proceed as follows: | ||
<ol><li>Configure your IBM Domino client by adding it to the SEP sesam environment: '''Main selection''' -> '''Components''' -> '''Topology''' -> '''New client''' -> add your IBM Domino client. For details, see [[Special:MyLanguage/Configuring_Clients|Configuring Clients]].</li> | <ol><li>Configure your IBM Domino client by adding it to the SEP sesam environment: '''Main selection''' -> '''Components''' -> '''Topology''' -> '''New client''' -> add your IBM Domino client. For details, see [[Special:MyLanguage/Configuring_Clients|Configuring Clients]].</li> | ||
<li> | <li>Add the folder path of the ''nnotes.dll'' to the <tt>Path</tt> environment variable: right-click ''This PC'' -> Properties -> ''Advanced system settings'' -> ''Environment Variables'' -> under ''System variables'' area select ''Path'' and click ''Edit''. Click ''New'' and add the path from your IBM Domino Server installation where the ''nnotes.dll'' is located, for example:</li> | ||
C:\Program Files\IBM\Domino | |||
Then click OK to save your changes. | Then click OK to save your changes. | ||
<li>Restart the SEP sesam service | <li>Restart the SEP sesam service. For details, see [[Special:MyLanguage/How_to_Start_and_Stop_SEP_sesam|How to Start and Stop SEP sesam]].</li> | ||
For details, see [[Special:MyLanguage/How_to_Start_and_Stop_SEP_sesam|How to Start and Stop SEP sesam]]. | |||
{{note|Before proceeding, you should validate that you can backup to SEP sesam. Run a test ''Path'' backup manually to ensure that the backups work. For details on typical backup configuration, see [[Special:MyLanguage/Standard_Backup_Procedure|Standard Backup Procedure]].}} | {{note|Before proceeding, you should validate that you can backup to SEP sesam. Run a test ''Path'' backup manually to ensure that the backups work. For details on typical backup configuration, see [[Special:MyLanguage/Standard_Backup_Procedure|Standard Backup Procedure]].}} | ||
</ol> | </ol> |
Revision as of 11:32, 30 April 2019
Overview
SEP sesam Client SBCLN is a program library for backing up IBM Domino (previously Lotus Domino) databases. All required components for IBM Domino server backup are already included in the regular SEP sesam Client for Windows and Linux package. Once the extension is present and all the requirements are met, you have to configure your client for the use with SEP sesam environment. For details, see section Configuring IBM Domino server as a SEP sesam client.
Additionally, to perform IBM Domino database-level backups, you have to enable and set up transaction logging in Archived mode on the IBM Domino server. Note that Domino databases can also be backed up with transaction logging disabled, however, this is not recommended as it only allows for FULL or COPY backups of databases and requires much more frequent full database backups. For details, see section Enabling transaction logging in Archive mode.
Quick setup
|
|
Requirements
To ensure error-free operation of SEP sesam and improve performance, make sure that the following conditions are met:
- Check the support matrix for the list of supported IBM Domino (previously Lotus Domino) server versions. Note that Windows 2012 is supported with regular file system functions. No support is provided for the Domino (Notes) data that were held on a NTFS deduplication partition!
- SEP sesam Server v. 4.4.3 or higher. Check Hardware requirements for SEP sesam Server.
- Install the SEP sesam Client package on the IBM Domino server. You can download it from SEP Download Center. For details on installing, see SEP sesam Quick Install Guide.
- A user account with sufficient privileges to perform backup and restore operations.
- SEP sesam IBM Domino backup module requires a license. For details, see List of Licenses.
Configuring IBM Domino server as a SEP sesam client
Before proceeding, make sure that the above requirements are met. The configuration procedure is slightly different depending on the operating system type (Linux or Windows).
On Linux
Once you have installed your SEP sesam Linux Client on IBM Domino server, proceed as follows:
- Configure your IBM Domino client by adding it to the SEP sesam environment: Main selection -> Components -> Topology -> New client -> add your IBM Domino client. For details, see Configuring Clients.
- Check if the library libsbcln.so is already present in the
<SESAM_ROOT>/bin/sesam/
directory on your Linux client. If not, download the SEP sesam extension for IBM Domino from https://www.sep.de/downloadportal/extensions/groupware/notes/ and copy it into the<SESAM_ROOT>/bin/sesam/
directory. - To work with Domino and load the library, add/set the following variables in the [ENVIRONMENT] section in
<SESAM ROOT>/var/ini/sm.ini
at the client: LOTUS, NOTES_DATA_DIR, Notes_ExecDirectory and PATH. The LD_LIBRARY_PATH must refer to directories containing the libraries libsbcln.so (located in <SESAM_BIN>/bin/sesam) and libnotes.so (in the Notes binary files installation directory).
The values listed below depend on the IBM Domino (previously Lotus Domino) installation. Use the values that apply to your Domino environment.
LOTUS=<IBM_Domino_path>
NOTES_DATA_DIR=<IBM_Domino_data_path>
Notes_ExecDirectory=<IBM_Domino_exe_path>
PATH=$PATH:<IBM_Domino_exe_path>:<IBM_Domino_data_path>
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<IBM_Domino_exe_path>
For example:
[ENVIRONMENT]
...
LOTUS=/opt/ibm/lotus
NOTES_DATA_DIR=/srv/notesdata
Notes_ExecDirectory=$LOTUS/notes/latest/linux
Notes_Resources=$Notes_ExecDirectory/res
SESAM_LIB_PATH=/opt/sesam/bin/sesam
NOTES_LIB_PATH=$NOTES_DATA_DIR:$Notes_ExecDirectory:$Notes_Resources
PATH=$PATH:$NOTES_DATA_DIR:$Notes_ExecDirectory:$Notes_Resources
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$SESAM_LIB_PATH:$NOTES_LIB_PATH
...
If the [ENVIRONMENT] section in the sm.ini file does not exist, you have to create it.
- Afterwards, restart the SEP sesam daemon: /etc/init.d/sesam restart For details, see How to Start and Stop SEP sesam.
Note | |
Before proceeding, you should validate that you can backup to SEP sesam. Run a test Path backup manually to ensure that the backups work. For details on typical backup configuration, see Standard Backup Procedure. |
On Windows
Once you have installed your SEP sesam Windows Client on the IBM Domino server, proceed as follows:
- Configure your IBM Domino client by adding it to the SEP sesam environment: Main selection -> Components -> Topology -> New client -> add your IBM Domino client. For details, see Configuring Clients.
- Add the folder path of the nnotes.dll to the Path environment variable: right-click This PC -> Properties -> Advanced system settings -> Environment Variables -> under System variables area select Path and click Edit. Click New and add the path from your IBM Domino Server installation where the nnotes.dll is located, for example: C:\Program Files\IBM\Domino Then click OK to save your changes.
- Restart the SEP sesam service. For details, see How to Start and Stop SEP sesam.
Note | |
Before proceeding, you should validate that you can backup to SEP sesam. Run a test Path backup manually to ensure that the backups work. For details on typical backup configuration, see Standard Backup Procedure. |
Enabling transaction logging in Archive mode
You have to set up transaction logging in Archive mode on the IBM Domino server to enable point-in-time recovery. The main advantage of transaction logging is fast server restart in case of a recovery; since transaction logging keeps a sequential record of every operation that occurs to data, you can roll back the database to a point before it was corrupted and replay the changes from the transaction log.
By default, transaction logging is disabled. You can enable it from Domino Administrator -> Configuration tab -> Use Directory on field -> select Domino directory -> click Server Configuration -> Current Server Document -> Transactional Logging tab -> enable the Transactional Logging and select Archive as Logging style.
Note | |
SEP sesam does not support Circular logging for IBM Domino server. Domino databases can be backed up with transaction logging disabled, but this only allows for FULL backups of databases and requires much more frequent full database backups. |
Once you enable transaction logging, IBM Domino assigns a Database Instance Identifier (DBIID) to each Domino database. When Domino records a transaction in the log, it includes the DBIID. During restore, the DBIID is used to identify the database to which the changes should be applied. If a new DBIID is assigned to a Domino database as a result of some Domino database maintenance activities, such as using fixup (e.g., automatic fixup of corrupt databases) or compact, the console message Assigning New DBIID for DB xxxx appears. In this case, you have to run a full database backup to be able to successfully restore the database.
For additional information on transaction logging and DBIID, see IBM FAQ about Transaction Logging, Transaction Logging on Domino Servers and Notes/Domino Best Practices: Transaction Logging.