SG24-4534-02

International Technical Support Organization

www.redbooks.ibm.com

Using Tivoli Storage Manager to Back Up LotusNotesMathis Landzettel, Clarence Beukes, Rosana Bratfich, Charlotte Brooks, Urs Moser

Using Tivoli Storage Manager to Back Up Lotus Notes

SG24-4534-02

May 2000

International Technical Support Organization

Copyright International Business Machines Corporation 1998 2000. All rights reserved.Note to U.S Government Users Documentation related to restricted rights Use, duplication or disclosure issubject to restrictions set forth in GSA ADP Schedule Contract with IBM Corp.

Third Edition (May 2000)

This edition applies to Version 3 Release 7 of Tivoli Storage Manager for AIX, Solaris, HP-UX and NT,program 5697-TSM; Version 3 Release 1 of Tivoli Storage Manager for AS/400, program 5697-TSM;Version 3 Release 7 of Tivoli Storage Manager for MVS-OS/390, program 5697-TSO and Tivoli DataProtection for Lotus Notes UNIX and Win NT, program 5697-DPN.

Comments may be addressed to:IBM Corporation, International Technical Support OrganizationDept. 471F Building 80-E2650 Harry RoadSan Jose, California 95120-6099

When you send information to IBM, you grant IBM a non-exclusive right to use or distribute theinformation in any way it believes appropriate without incurring any obligation to you.

Before using this information and the product it supports, be sure to read the general information inAppendix B, Special notices on page 145.

Take Note!

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .ix

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiThe team that wrote this redbook. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiComments welcome. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Part 1. Implementing Tivoli Storage Manager with Notes . . . . . . . . . . . . . . . . . . . . . . . 1 Copyright IBM Corp. 2000 iii

Chapter 1. Notes and Tivoli Storage Manager . . . . . . . . . . . . . . . . . . . . 31.1 Introduction to Lotus Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.1.1 Notes components and platforms . . . . . . . . . . . . . . . . . . . . . . . . . 31.1.2 Notes user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.1.3 Notes administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.1.4 Notes data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.1.5 Storage management of Notes . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.2 Tivoli Storage Manager backup/archive client and Notes . . . . . . . . . . 121.3 Introducing the Tivoli Storage Manager Notes agent . . . . . . . . . . . . . 13

Chapter 2. Tivoli Storage Manager Notes Backup Agent on OS/2 . . . . 172.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2.1.1 Tivoli Storage Manager API . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172.1.2 Tivoli Storage Manager Notes Backup Agent . . . . . . . . . . . . . . . 182.1.3 Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202.1.4 Tivoli Storage Manager Notes Backup Agent files for OS/2 . . . . 20

2.2 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212.2.1 Updating the NOTES.INI file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212.2.2 Setting environment variables. . . . . . . . . . . . . . . . . . . . . . . . . . . 222.2.3 Setting up Tivoli Storage Manager . . . . . . . . . . . . . . . . . . . . . . . 23

2.3 Migration considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Chapter 3. Tivoli Data Protection for Notes on Windows NT . . . . . . . . 293.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

3.1.1 Tivoli Storage Manager API . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293.1.2 Tivoli Data Protection for Notes . . . . . . . . . . . . . . . . . . . . . . . . . 303.1.3 Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333.1.4 TDP for Notes files for Windows NT . . . . . . . . . . . . . . . . . . . . . . 34

3.2 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343.2.1 Updating the NOTES.INI file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343.2.2 Setting environment variables. . . . . . . . . . . . . . . . . . . . . . . . . . . 36

3.2.3 Setting up Tivoli Storage Manager . . . . . . . . . . . . . . . . . . . . . . . 373.3 DSMCUTIL utility on Windows NT . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 4. Tivoli Data Protection for Notes on AIX . . . . . . . . . . . . . . . 454.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

4.1.1 Tivoli Storage Manager API . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454.1.2 TDP for Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454.1.3 Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474.1.4 TDP for Notes files for AIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

4.2 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484.2.1 Updating the NOTES.INI file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494.2.2 Setting environment variables. . . . . . . . . . . . . . . . . . . . . . . . . . . 50iv Using Tivoli Storage Manager to Back Up Lotus Notes

4.2.3 Setting up Tivoli Storage Manager . . . . . . . . . . . . . . . . . . . . . . . 51

Chapter 5. Operation of the Tivoli Storage Manager Notes agent . . . . 575.1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

5.1.1 Backup of Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575.1.2 Restoring deleted documents . . . . . . . . . . . . . . . . . . . . . . . . . . . 605.1.3 Restoring documents and databases . . . . . . . . . . . . . . . . . . . . . 615.1.4 Change of Notes agent password . . . . . . . . . . . . . . . . . . . . . . . . 63

5.2 Using the graphical user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . 645.2.1 Restoring selected documents from a database . . . . . . . . . . . . . 645.2.2 Rebuilding a database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665.2.3 Restoring deleted documents . . . . . . . . . . . . . . . . . . . . . . . . . . . 675.2.4 Change of TDP for Notes client password . . . . . . . . . . . . . . . . . 68

5.3 Remote recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695.3.1 Using the Notes workspace (on OS/2 only). . . . . . . . . . . . . . . . . 705.3.2 Using the remote server console . . . . . . . . . . . . . . . . . . . . . . . . 72

5.4 Summary tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Part 2. Exploiting Tivoli Storage Manager with Notes . . . . . . . . . . . . . . . . . . . . . . . . . 75

Chapter 6. Tivoli Storage Management in a Notes environment . . . . . 776.1 Sample Notes environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776.2 Tivoli Storage Management implementation considerations . . . . . . . . 796.3 Tivoli Storage Manager backup policy for a Notes environment . . . . . 846.4 Tivoli Storage Manager configuration in a Notes environment . . . . . . 86

6.4.1 Node names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866.4.2 Policy considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876.4.3 Include/exclude lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

6.5 Automation of Tivoli Storage Manager backups . . . . . . . . . . . . . . . . . 956.5.1 Notes scheduling using the Name and Address Book . . . . . . . . . 966.5.2 Tivoli Storage Manager scheduling . . . . . . . . . . . . . . . . . . . . . . . 98

6.6 Tivoli Storage Manager logs and server queries . . . . . . . . . . . . . . . . 1016.6.1 Tivoli Storage Manager client logs . . . . . . . . . . . . . . . . . . . . . . 1016.6.2 TDP for Notes logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036.6.3 Automating Tivoli Storage Manager log collection. . . . . . . . . . . 1056.6.4 Tivoli Storage Manager server queries . . . . . . . . . . . . . . . . . . . 109

Chapter 7. Notes features and Tivoli Storage Manager . . . . . . . . . . . 1137.1 Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1137.2 Access control lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147.3 Directory and database links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1167.4 Full-text indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1207.5 Shared mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121v

7.6 Notes calendar and scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227.7 Internal database IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Chapter 8. Recovery scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258.1 Document recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

8.1.1 Restore selected documents . . . . . . . . . . . . . . . . . . . . . . . . . . 1258.1.2 Restore deleted documents . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

8.2 Database recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1298.3 Notes server recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Appendix A. Sample queries for the Notes agent . . . . . . . . . . . . . . . . . 135A.1 Tivoli Storage Manager query content command output . . . . . . . . . . . . 135A.2 Tivoli Storage Manager Notes agent query output . . . . . . . . . . . . . . . . . 138

Appendix B. Special notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Appendix C. Related publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149C.1 IBM Redbooks publications: Tivoli Storage Manager . . . . . . . . . . . . . . . 149C.2 IBM Redbooks collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150C.3 Other resources: Tivoli Storage Manager product publications . . . . . . . 150

How to get IBM Redbooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153IBM Redbooks fax order form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

IBM Redbooks evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

vi Using Tivoli Storage Manager to Back Up Lotus Notes

Figures

1. Notes workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62. Notes server console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73. Public Name and Address Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84. Administration window on Notes workspace . . . . . . . . . . . . . . . . . . . . . . . . 95. Tivoli Storage Manager Notes agent GUI . . . . . . . . . . . . . . . . . . . . . . . . . 156. Logical components of Tivoli Storage Manager Notes agent . . . . . . . . . . 167. Tivoli Storage Manager API installation on OS/2. . . . . . . . . . . . . . . . . . . . 188. Install directories on OS/2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199. NOTES.INI file update on OS/2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Copyright IBM Corp. 2000 vii

10. CONFIG.SYS update on OS/2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2311. Client option file on OS/2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2712. Setup options window on Windows NT . . . . . . . . . . . . . . . . . . . . . . . . . . . 3013. Select Destination Directory window: Typical on Windows NT . . . . . . . . . 3114. Select Destination Directory window: Custom on Windows NT. . . . . . . . . 3115. Select Destination Directory window: Compact on Windows NT. . . . . . . . 3216. Start Copying Files window on Windows NT . . . . . . . . . . . . . . . . . . . . . . . 3317. NOTES.INI file update on Windows NT . . . . . . . . . . . . . . . . . . . . . . . . . . . 3518. System Properties on Windows NT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3719. Tivoli Storage Manager password in registry. . . . . . . . . . . . . . . . . . . . . . . 3920. Client options file on Windows NT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4121. Tivoli Storage Manager Scheduler installation using DSMCUTIL . . . . . . . 4322. TDP for Notes password generation using DSMCUTIL. . . . . . . . . . . . . . . 4423. NOTES.INI file update on AIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5024. Notes users system profile update on AIX . . . . . . . . . . . . . . . . . . . . . . . . 5125. Client system options file on AIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5326. Client user options file on AIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5327. Include/exclude list on AIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5528. Incremental backup using DSMNOTES. . . . . . . . . . . . . . . . . . . . . . . . . . . 5929. TDP for Notes GUI embedded in Notes workspace . . . . . . . . . . . . . . . . . 6430. Restoring selected documents from the Notes workspace . . . . . . . . . . . . 6531. Rebuilding a database from the Notes workspace . . . . . . . . . . . . . . . . . . 6632. Restoring data documents from deletion stubs . . . . . . . . . . . . . . . . . . . . . 6833. Typical Notes environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6934. ADSM remote node window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7135. Restoring data documents from deletion stubs on remote server . . . . . . . 7236. Remote server console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7337. Notes sample environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7838. Failed backup of NAMES.NSF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8139. Notes sample environment with Tivoli Storage Manager clients . . . . . . . . 8340. Weekly full and daily incremental backup schedules. . . . . . . . . . . . . . . . . 85

41. Mail server 1 Tivoli Storage Manager node names . . . . . . . . . . . . . . . . . . 8742. Tivoli Storage Manager server policy domains . . . . . . . . . . . . . . . . . . . . . 8843. Management class settings: BA_MGNT . . . . . . . . . . . . . . . . . . . . . . . . . . 9144. Management class settings: DB_MGNT . . . . . . . . . . . . . . . . . . . . . . . . . . 9245. Management class settings: MAIL_MGNT . . . . . . . . . . . . . . . . . . . . . . . . 9246. Client system options file on AIX: two server stanzas . . . . . . . . . . . . . . . . 9547. Notes server programs on Notes workspace. . . . . . . . . . . . . . . . . . . . . . . 9648. Setup of Notes program for TDP for Notes backup . . . . . . . . . . . . . . . . . . 9749. Command script RUN_INC.CMD for Notes scheduler . . . . . . . . . . . . . . . 9850. Scheduling DSMNOTES with the Tivoli Storage Manager scheduler . . . . 9951. Scheduler client log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102viii Using Tivoli Storage Manager to Back Up Lotus Notes

52. TDP for Notes log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10553. Tivoli Storage Manager logs imported into a Notes log database . . . . . . 10754. Open Tivoli Storage Manager Notes log database . . . . . . . . . . . . . . . . . 10855. Tivoli Storage Manager server file spaces: Windows NT . . . . . . . . . . . . 11056. Tivoli Storage Manager server file spaces: AIX . . . . . . . . . . . . . . . . . . . . 11057. Tivoli Storage Manager server file space occupancy . . . . . . . . . . . . . . . 11158. Access control lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11559. Notes logical directory structure: directory and database links . . . . . . . . 11760. Error message resulting when Notes agent finds a directory link . . . . . . 11861. Additional backup command specifying the directory link . . . . . . . . . . . . 11962. Error message resulting when Notes agent finds a database link . . . . . . 11963. Full-text index panel in database view . . . . . . . . . . . . . . . . . . . . . . . . . . . 12064. Replica ID in database properties window. . . . . . . . . . . . . . . . . . . . . . . . 12365. Scenario 1: restoring a selected document . . . . . . . . . . . . . . . . . . . . . . . 12666. Restoring selected documents from a database . . . . . . . . . . . . . . . . . . . 12767. Scenario 2: recovery of deleted documents. . . . . . . . . . . . . . . . . . . . . . . 12868. Restoring data documents from deletion stubs . . . . . . . . . . . . . . . . . . . . 12969. Disaster recovery of a database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Tables

1. Tivoli Storage Manager backup/archive client and Notes agent . . . . . . . . 132. Tivoli Storage Manager Notes Backup Agent on OS/2: files . . . . . . . . . . . 203. TDP for Notes for Windows NT: Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344. TDP for Notes for AIX: files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475. TDP for Notes for AIX: language files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486. TDP for Notes for AIX: symbolic links . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487. Tivoli Storage Manager Notes agent functions by user interface . . . . . . . 748. Tivoli Storage Manager Notes agent functions by platform . . . . . . . . . . . . 74 Copyright IBM Corp. 2000 ix

x Using Tivoli Storage Manager to Back Up Lotus Notes

Preface

Tivoli Storage Manager is an enterprise-wide network storage managementsolution. It provides a marketplace solution for an incremental backup andrestore of individual Lotus Notes database documents. This IBM Redbookaddresses backup and recovery of Lotus Notes 4.5 and 4.6 on OS/2,Windows NT, and AIX.

This IBM Redbook is structured in two parts: Part 1 provides information forthe implementation of Tivoli Storage Manager, including the Tivoli StorageManager Version 3 Notes Backup Agent on OS/2 and Tivoli Data Protection Copyright IBM Corp. 2000 xi

for Lotus Notes on Windows NT and AIX; and, Part 2 shows how TivoliStorage Manager can be exploited in a Notes environment.

We refer to Lotus Notes simply as Notes for the remainder of this IBMRedbook.

This IBM Redbook is intended for customers, consultants, IBM BusinessPartners, and IBM personnel who are familiar with Tivoli Storage Managerand Lotus Notes and want to know how to use Tivoli Storage Manager tomanage Notes data.

The team that wrote this redbookThis IBM Redbook was produced by a team of specialists from around theworld working at the International Technical Support Organization, San JoseCenter.

Mathis Landzettel was a project leader at the International TechnicalSupport Organization, San Jose Center. He joined IBM in 1994 aftercompleting a diploma in mathematics at the Technical University ofDarmstadt. Before joining the ITSO, Mathis worked in the Tivoli StorageManager development department in Mainz, Germany, as a software testteam leader. Mathis is now with the SAN Interoperability Lab, also in Mainz.

Tivoli Storage Manager is the follow-on product to IBMs ADSTAR Distributed Storage Manager(ADSM). The Tivoli Data Protection products replace and extend the former ADSMConnect agents.These products are a part of Tivoli Storage Management Solutions. Please visit the Tivoli StorageManagement Website at http://www.tivoli.com/products/solutions/storage for informationabout Tivoli Storage Management Solutions

Note:

Clarence Beukes is an IT Specialist in South Africa. He has one year ofexperience in Tivoli Storage Manager implementation and support. Clarenceholds a National Diploma in IT from Technicon Witwatersrand in Johannesburg.His areas of expertise include Tivoli Storage Manager implementation on OS/2and support for remote access (LAN distance, LIG).Rosana Bratfich is a System Support Specialist in Brazil. She has six monthsof experience with Tivoli Storage Manager. Rosana holds a degree in SystemsAnalysis from PUCC University in Campinas. Her areas of expertise includeTivoli Storage Manager planning, implementation, and recovery of Notes serverson AIX.xii Using Tivoli Storage Manager to Back Up Lotus Notes

Charlotte Brooks is a Tivoli Storage Management Project Manager at theInternational Technical Support Organization, San Jose Center. She has 10years of experience with IBM in the fields of RS/6000 and StorageManagement. Before joining the ITSO this year, Charlotte was the TechnicalSupport Manager for Tivoli Storage Manager in the Asia Pacific region.

Urs Moser is an Advisory IT Specialist in Switzerland. He has more than 20years of IT experience, including more than seven years experience with TivoliStorage Manager and the former WDSF/VM. His areas of expertise include TivoliStorage Manager projects and education at customer sites, including mainframeenvironments (MVS, VSE, and VM) and databases.The authors of the first edition of this redbook are:

Cyndie BehrensIBM Storage Systems Division, San Jose

Tim MortimerInternational Technical Support Organization, San Jose Center

Thanks to the following people for their invaluable contributions to thisproject:Deanna DangIBM Storage Systems Division, San Jose

Chieu DuongTivoli Storage Manager Development, San Jose

Cindy JiangIBM Storage Systems Division, San Jose

Cyndie BehrensIBM Storage Systems Division, San Jose

Achim WarneckeIBM Storage Systems Division, Mainz

Shirley HentzellInternational Technical Support Organization, San Jose Center

AlanTippettInternational Technical Support Organization, San Jose Centerxiii

David WrayInternational Technical Support Organization, San Jose Center

Comments welcomeYour comments are important to us!

We want our redbooks to be as helpful as possible. Please send us yourcomments about this or other redbooks in one of the following ways:

Fax the evaluation form found in IBM Redbooks evaluation on page 161to the fax number shown on the form.

Use the online evaluation form found at http://www.redbooks.ibm.com/ Send your comments in an Internet note to redbook@us.ibm.com

xiv Using Tivoli Storage Manager to Back Up Lotus Notes

Part 1. Implementing Tivoli Storage Manager with Notes

After a brief introduction to Lotus Notes in the first chapter we discuss thechallenge of storage management in a Notes environment and how TivoliStorage Manager fulfills the needs for a comprehensive Notes backupsolution. The subsequent chapters of Part 1 of this redbook coverimplementation issues of Tivoli Storage Manager in a Notes environment. Welook at the installation and configuration of the Tivoli Storage Manager Notesagents on the supported platforms:

OS/2 Copyright IBM Corp. 2000 1

Windows NT AIX

We also look at the operation of the agents both using the command lineinterface and the graphical user interface.

2 Using Tivoli Storage Manager to Back Up Lotus Notes

Chapter 1. Notes and Tivoli Storage Manager

This chapter gives a brief introduction to Lotus Notes, its components andinterfaces, and to Notes as a database system. We discuss the importance ofstorage management and its requirements to a backup solution.

Tivoli Storage Manager, the markets best storage manager in a distributedenvironment, provides a backup solution for a heterogeneous Notesenvironment, including the backup/archive client and the Notes agent. Weshow that although each component on its own has limitations in a Notesenvironment, together they provide a complete backup solution and fulfill the Copyright IBM Corp. 2000 3

requirements for Notes storage management.

1.1 Introduction to Lotus NotesNotes is an example of a growing genre of software called groupware.Groupware, by definition, means that the data for an application is used bymembers of a group. Its infrastructure comprises technologies forcommunication (electronic mail, messaging), collaboration (electronicdiscussions, shared databases, forums), and coordination (workflowautomation).Notes combines an advanced client/server application developmentenvironment, a document database, and a sophisticated messaging system.With Notes, people can work together regardless of software or hardwareplatforms and across technical, organizational, and geographical boundaries.It allows users to communicate securely over a local area network (LAN) orby telecommunication, and to create or access documents residing on ashared computer. Notes-based information can be shared across anydistance, at any time.

Notes also provides access to external network services such as host-basedmail or fax gateways and the Internet. Using the internal InterNotes WebNavigator, or any third-party navigator, such as Netscape or MicrosoftInternet Explorer, you can browse the Internet directly. On the other hand,Notes translates Notes documents into HTML documents on the fly, makingany Notes server into a Web server

1.1.1 Notes components and platformsNotes is a client/server application that runs on a variety of workstationoperating system platforms. There are two product components: Notes serverand Notes workstation.

Notes serverThe Notes server provides services to Notes workstation users and otherNotes servers, including storage and replication of shared databases andmail routing. With Notes Release 4.6.5, you can run the Notes server onthese platforms:

Windows NT and Windows 95 OS/390 OS/2 NetWare4 Using Tivoli Storage Manager to Back Up Lotus Notes

UNIX, IBM AIX, HP-UX, and Sun Solaris AS/400

The last release of Notes server is Release 4.6.6. Currently, the TivoliStorage Manager Notes agents support backup of Notes databases atRelease 4.6.5 level. You can check for the supported Notes Releaselevels at:http://www.tivoli.com/support/storage_mgr/adagent.htm#NotesNT andhttp://www.tivoli.com/support/storage_mgr/adagent.htm#NotesAIX.

Notes workstationThe Notes workstation communicates with one or more Notes servers,providing the interface that allows a Notes user to access shareddatabases and to read and send mail. With Notes R4.6.5, you can runNotes workstation on these platforms:

Windows NT, Windows 95, and Windows 98 UNIX, IBM AIX, HP-UX, and Sun Solaris

Since Notes R4.6, there has been no Notes workstation client available forOS/2. From then, there is only a Notes administration client which is includedwith the Notes Server on OS/2.

The Notes workstation is required on user workstations that will accessdatabases on a Notes server. However, the Notes workstation is more thanjust a client. It is a single-user version of a Notes server, providing a verycomplete subset of the server functions on the user's client workstation.Notes users can work with databases on a Notes server that are shared withother users or have Notes databases on their own client workstation. Thelocal databases on their client workstation look and feel exactly the same asdatabases on a server. The only limitation is that the database can be

accessed only at the user's client workstation, not by other users in thenetwork.

Connectivity between Notes servers and clients is typically over a local orwide area network. Protocols supported include: TCP/IP, NetBIOS, IPX/SPX,Apple Talk, Banyan Vines, and X.PC. Dial-in connections are also supportedfor remote Notes workstations that connect to a server only occasionally.

1.1.2 Notes user interfaceNotes provides a graphical user interface (GUI), also called Notesworkspace, as shown in Figure 1. Users use Notes workspace to accessNotes and Tivoli Storage Manager 5

databases or applications. The Notes workspace consists of seven tabbeddesktop windows, or folders. Six of them contain icons that representdatabases. The replicator window enables the user to start and monitordatabase replications between Notes server and the local Notes workstation.

Users can open databases by clicking on the tab of a folder and thendouble-clicking on a database icon. Icons can represent databases orapplications on either the user's local workstation or a remote Notes server.

Notes databases and Notes applications are synonymous terms. The Notesworkspace also has a set of pull-down menus for working with databases andSmartIcons that provide a fast path to many everyday functions. The Notesworkspace has the same look and feel across all of the supported clientplatforms.

6 Using Tivoli Storage Manager to Back Up Lotus Notes

Figure 1. Notes workspace

1.1.3 Notes administrationLike any other system, Notes requires administration. Notes provides twomain interfaces for administration: the Notes server console and the Notesclient workspace.

When a Notes server is started, a full-screen command line console ispresented as shown in Figure 2. The console displays the server activities,such as scheduled macros and replication. The server console is also theinterface for administrators to perform tasks, such as loading additional Notesprograms, querying server statistics, and setting certain server options. Theserver console is a window on the physical server screen. A remote consolefunction is also provided through the Notes workspace. It enables remoteserver administration by suitably authorized users.

Lotus Domino r Server, Release 4.5.2 (Intl), 26 June 1997Copyright c 1985-1997, Lotus Development Corporation, All Rights Reserved

04/02/98 12:58:32 PM Database Replicator started04/02/98 12:58:37 PM Mail Router started for domain ALMADEN04/02/98 12:58:37 PM Router: Internet SMTP host malawi in domain almaden.ibm.com04/02/98 12:58:42 PM Index update process started04/02/98 12:58:47 PM Stats agent shutdown04/02/98 12:58:52 PM Agent Manager started04/02/98 12:58:55 PM AMgr: Executive '1' started04/02/98 12:58:57 PM servwnt/almaden is the Administration Server of the PublicAddress Book.04/02/98 12:58:58 PM Administration Process started04/02/98 12:59:02 PM Schedule Manager startedNotes and Tivoli Storage Manager 7

Figure 2. Notes server console

Although the server console is the interface for basic administration, mostNotes administration is performed by using a special Notes database calledthe Name and Address database, from the Notes workspace. The Name andAddress database, with a file name of names.nsf, is created on every Notesserver and client when the servers and clients are installed. On a Notesserver, the Name and Address databases (or books as they are also called)are public and contain information about all servers and users within thenetwork. On a Notes client, the Name and Address database is private andcontains information pertinent only to that client workstation. Figure 3 onpage 8 shows the Notes server Name and Address database, calledAlmadens Address Book. The selected view is People, which lists allregistered users in the Notes domain Almaden. A Notes domain is defined asa collection of users, servers, and groups that share a common Name andAddress Book within a Notes environment.

04/02/98 12:59:02 PM SchedMgr: Validating Schedule Database04/02/98 12:59:03 PM SchedMgr: Done validating Schedule Database04/02/98 12:59:07 PM Calendar Connector started04/02/98 12:59:13 PM HTTP Web Server started04/02/98 12:59:18 PM Database Server started

8 Using Tivoli Storage Manager to Back Up Lotus Notes

Figure 3. Public Name and Address Book

On a Notes server, the Name and Address database is probably the mostpowerful directory-services and server-management tool for an administrator.The public Name and Address database as a directory service tool is adirectory of all Notes users, servers in a domain, group names for mailinglists, and foreign domains. Servers within a domain have a common Nameand Address database that is replicated across all servers in the domain.

As a server management tool, the Name and Address database is used tocontrol server operations. It contains instructions about how servers cancommunicate with other servers and which tools or programs are run. It is themain Notes scheduling tool to schedule operations, such as establishingserver-to-server connections for replication.

Notes administrators additionally use the Notes workspace to administer aNotes server. If you select File > Tools > Server Administration, adedicated administration window appears (Figure 4). From there,administrators can maintain all Notes servers, register new users or serversin the domain, and access the different views of the Name and Addressdatabase.

Notes and Tivoli Storage Manager 9

Figure 4. Administration window on Notes workspace

1.1.4 Notes dataA Notes database is the basic component of a Notes application. It is therepository where users create, update, store, and track documents in variousformats. The document-oriented information within the files is unstructuredand can contain many types of data: text, image, audio, and video. Shareddatabases reside on one or more Notes servers and can be accessed bymultiple users. A local database is resident on a user's client workstation andis accessible only at that workstation. Each icon on the Notes workspaceshown in Figure 1 on page 6 represents a database, either on a remote Notesserver or on the local workstation. A Notes database created on a Windowsclient, for example, has the same format as a database created on an OS/2,NetWare, or UNIX Notes server. Therefore, Notes databases are portableamong various Notes servers and clients throughout an enterprise.

A Notes database is stored on a server or client workstation as a single notesstructured file with an .nsf file extension. A Notes database is a single,self-contained entity as far as the workstation operating system is concerned.A workstation operating system, such as AIX, has no knowledge of thestructure or contents of a Notes database. The lack of knowledge is beneficialin terms of portability but presents an interesting storage management

challenge. Notes databases can become very large files, often growing tohundreds of megabytes in size.

Beside databases, Notes includes other files. These files are part of yourNotes environment:

notes.iniThis file is the Notes server and workstation initialization file that definesvarious configuration and performance variables.

names.nsfThis file is the server Name and Address Book. It is the central repository10 Using Tivoli Storage Manager to Back Up Lotus Notes

for address and server configuration information for users, groups, andservers within a Notes domain.

log.nsfThis database is automatically created to record and store informationabout all types of Notes server activities, and remote workstationcommunication activities.

cert.idThis certifier ID file is used to create new Notes user and server ID filesand to cross-certify existing server, user, and other certifier ID files.

server.idThis server ID file is used to start and run the Notes server.

user.idThis ID file identifies the Notes user when accessing a Notes server.

desktop.dskThis is the configuration file for the Notes workspace.

catalog.nsfThis database catalog lists all public databases. It records and storesinformation about the databases on a Notes server.

mail.boxThis file is the Notes mail-router mail box.

..\mail\user.nsfThis is a users mail database. It is used to send and receive electronicmail using Notes. In a large Notes environment, there are several mailsubdirectories including mail databases for all users.

discuss4.ntfFiles with the extension .ntf are database template files in this example,a template file for a Notes discussion forum.

names.ftThis is actually a directory with several subdirectories including files. It isNotes and Tivoli Storage Manager 11

the index data for a database, in this example, for the Name and Addressdatabase.

1.1.5 Storage management of NotesProviding effective storage management services for a Notes system can bea demanding task. All non-database Notes data comes under your generalstorage management policy. Regular backups need to be run againstfrequently updated data. The challenge with Notes, however, is the storagemanagement of Notes databases.

Notes databases are complex logical structures, often very large, that appearto traditional storage management tools as single workstation files. A backuptool that operates only at the operating system level will always back up theentire database. Whenever a single document is updated within a database,an incremental backup would catch the entire database since the modificationtimestamp of the database has changed. This leads to an enormous amountof data and backup copies on the storage location.

Most backup products can perform incremental backups of files, but this doesnot hold true with Notes. Incremental backing up of Notes databases has tobe performed on the document level. This is to enable the administrator tokeep a certain number of backup copies for each single document.

Notes itself provides a function for database backups: replication. Replicationis the process of updating databases that reside on different servers andclients within a Notes environment, simultaneously. Updates to a databasecan be reflected on all database copies wherever they physically reside. Thisupdate works on a document level. If a database or a document within adatabase is accidentally deleted, it can be recovered as long as a replicationdatabase copy is available elsewhere in the Notes environment. However,replication is not a substitute for an effective backup solution. Replication willduplicate user errors throughout a Notes network. If a critical document or

database is erased by accident, replication will, in time, erase that sameinformation wherever it is replicated.

Another problem with most backup products is that they do not allow backupof open files. There are several files in Notes that cannot be backed up whilethe Notes server is running, one of which is the most crucial file, the publicName and Address database. These files will not be backed up unless youstop the Notes server first, or make periodic replica copies that can bebacked up.

1.2 Tivoli Storage Manager backup/archive client and Notes12 Using Tivoli Storage Manager to Back Up Lotus Notes

The Tivoli Storage Manager backup and archive (backup/archive) client isdesigned to back up and restore and archive and retrieve workstation filesystem data. As your enterprise system backup solution, Tivoli StorageManager backs up all non-database Notes data on both Notes server andworkstation. Tivoli Storage Manager clients use standard operating systemfunctions to access files within file systems, but they do not understand anylogical structure that may exist within a file. This is not a limitation only ofTivoli Storage Manager; All other workstation backup products that work atthe file system level are similarly limited.

These limitations affect how Notes and other database systems are backedup. Each database appears as an individual NSF file in the server or client filesystems. An Tivoli Storage Manager backup/archive client running on a Notesserver or client can back up restore, archive, and retrieve entire Notesdatabases. It cannot back up smaller increments.

Tivoli Storage Manager clients can be installed wherever there are Notesdatabases that require backing up. However, this approach can potentiallylead to large numbers of duplicate database backup copies if Notesreplication is also being used. A more sensible approach is to implementTivoli Storage Manager clients on Notes servers only. If possible, identifythose databases on the servers that are replicas from other servers andexclude them from backup. This approach assumes that backups of thosedatabases have already been performed at the originating database server.

Other than the issues of size and replication, using a Tivoli Storage Managerbackup/archive client to back up Notes databases is straightforward. Eachdatabase is a self-contained NSF file that is backed up and restored withoutany problem. Tivoli Storage Manager restores a database in its entirety,because it is just a file for Tivoli Storage Manager. If a database is deleted orcorrupted, it is a simple task for Tivoli Storage Manager to restore the most

recent or any backup copy version of this database from the Tivoli StorageManager server to the Notes server or workstation.

The Tivoli Storage Manager backup/archive client, however, does not meetall requirements for an ideal storage management solution in a Notesenvironment, as discussed in 1.1.5, Storage management of Notes on page11. The Tivoli Storage Manager client backs up databases in their entiretyand not on a document level.

1.3 Introducing the Tivoli Storage Manager Notes agentNotes and Tivoli Storage Manager 13

The Tivoli Storage Manager Notes agent provides an integrated solution forperforming document-level incremental backup and restore operations on aNotes database. It is a Notes application that provides backup and restore ofindividual documents within a Notes database. It, therefore, providesfunctions complementary to the standard Tivoli Storage Managerbackup/archive client. It is not intended as a substitute for the standard TivoliStorage Manager backup/archive client. Table 1 compares the functionsprovided by either the Tivoli Storage Manager backup/archive client or theNotes agent.Table 1. Tivoli Storage Manager backup/archive client and Notes agent

The Notes agent cannot be used to back up or restore any other type of data,such as Notes ID files, or notes.ini, or any other system configuration files.Those files are backed up by the Tivoli Storage Manager backup/archive

Function Backup/archive client Notes agent

Non-database backup/restore Yes No

Full database backup/restore Yes Yes

Incremental database backup No Yes

Restore individual documents No Yes

Restore deleted documents No Yes

From now on we use the following naming convention: Tivoli StorageManager Notes agent or Notes agent stands for Tivoli Storage ManagerNotes Backup Agent for OS/2 or Tivoli Data Protection for Windows NT orAIX. Note that inside these products, for example, in most screen shotsand commands, ADSM names and terminology are still used.

Naming Convention:

client described in 1.2, Tivoli Storage Manager backup/archive client andNotes on page 12.

The Tivoli Storage Manager Notes agent and the Tivoli Storage Managerbackup/archive client can run simultaneously on the same Notes server orworkstation; However, they are totally separate clients as far as the TivoliStorage Manager server is concerned.

The Notes agent provides the ability to back up Notes databases at theindividual Notes document level. The Notes agent is integrated within Notesand recognizes the logical structure of a Notes database.14 Using Tivoli Storage Manager to Back Up Lotus Notes

The Notes agent provides commands to: Perform an incremental backup of Notes databases, backing up only those

documents that have changed since the previous incremental backup Restore to a database individual documents that have been previously

backed up by the Notes agent Restore individual documents that have been deleted from a Notes

database Restore an entire Notes database Perform an incremental restore function by merging changed documents

into a database

The Notes agent provides a command line interface for performing backupsand restores. The Notes agent commands can be issued either from acommand prompt or from a Notes server console. You can invoke the Notesagent GUI from the Notes workspace. Figure 5 shows the Tivoli StorageManager Notes agent embedded in the Notes workspace. See Chapter 5,Operation of the Tivoli Storage Manager Notes agent on page 57 for furtherdiscussion on the operation of the Notes agent.

Notes and Tivoli Storage Manager 15

Figure 5. Tivoli Storage Manager Notes agent GUI

The Notes agent uses the Notes API to communicate with the Tivoli StorageManager API. The Notes API enables the Notes agent to understand thestructure within a Notes database and, therefore, to back up and restore onthe document level. The Tivoli Storage Manager API, which has a C languageinterface, can be regarded as a special type of Tivoli Storage Manager client.It is designed to provide an interface between a workstation application andan Tivoli Storage Manager server. The Tivoli Storage Manager API isconfigured in a way similar to the standard Tivoli Storage Managerbackup/archive client. A Tivoli Storage Manager server views an applicationusing the API as a separate, self-contained workstation client. Figure 6illustrates the logical components of the Notes agent.

Tivoli StorageManager

Notes AgentNotesAPI Note

Note

Note

Note

TivoliStorage Manager

Server16 Using Tivoli Storage Manager to Back Up Lotus Notes

Figure 6. Logical components of Tivoli Storage Manager Notes agent

Tivoli StorageManager

API

NotesDatabaseson NotesServer/

Workstation

Chapter 2. Tivoli Storage Manager Notes Backup Agent on OS/2

This chapter covers the installation and configuration of the Tivoli StorageManager Lotus Notes Backup Agent on OS/2. The installation consists of twosteps: the installation of the Tivoli Storage Manager application programminginterface (API), and the installation of the Tivoli Storage Manager NotesBackup Agent. The configuration includes the update of the Notesinitialization file, modifications of the OS/2 environment, and the creation ofthe Tivoli Storage Manager client options file. All these steps are required toget the Tivoli Storage Manager Notes Backup Agent running and functionalon your OS/2 system. Copyright IBM Corp. 2000 17

Since the Notes Backup Agent on OS/2 was introduced in ADSM Version 2,we discuss issues of migration from Version 2 to Version 3.

2.1 InstallationThis section describes the steps to install the Version 3 Tivoli StorageManager Notes Backup Agent on OS/2. The prerequisites are: OS/2 isrunning on the system and your Notes server is already installed andfunctional. Check the readme file for the latest information about the OS/2and Notes server versions supported by the Tivoli Storage Manager NotesBackup Agent.

The Version 3 Tivoli Storage Manager Notes Backup Agent is introduced withTivoli Storage Manager V3.1.3. It requires the V3.1.3 API or higher.

2.1.1 Tivoli Storage Manager APIBefore running the Tivoli Storage Manager Notes Backup Agent, you mustinstall the Version 3 Tivoli Storage Manager API. The Tivoli Storage ManagerAPI is part of the standard Tivoli Storage Manager backup/archive clientVersion 3 for OS/2. The API is installed in the same way as the standardbackup/archive client. The Tivoli Storage Manager backup/archive client liststhe Tivoli Storage Manager API as a fifth optional component to install. Figure7 on page 18 illustrates the backup/archive client install window and showsthat the API is selected for installation. Please refer to ADSTAR Distributed

As of the release of Tivoli Storage Manager Version 3.7 client for OS/2, theNotes agent is no longer included.

Note:

Storage Manager: Installing the Clients, SH26-4080, for more detailedinstructions about how to install the API on OS/2.

If the Version 2 API is already installed on the system, for example, inc:\adsm\api, and is used for other applications, make sure that you specify adedicated directory for the installation of the Version 3 API (for examplec:\tsmcv3\api). Otherwise, you lose the older version of the API. If the Version3 API is already installed on the system, make sure that you have the latestversion of the API to run the Tivoli Storage Manager Notes Backup Agentsuccessfully.18 Using Tivoli Storage Manager to Back Up Lotus Notes

Figure 7. Tivoli Storage Manager API installation on OS/2

2.1.2 Tivoli Storage Manager Notes Backup AgentThese steps guide you through the Tivoli Storage Manager Notes BackupAgent Version 3 installation on OS/2:1. On the installation media, change to directory \adsmcli\os2\lnotes. For

example:cd f:\adsmcli\os2\lnotes

2. Type install and press Enter.3. On the instructions screen, click Continue.4. An install-confirmation box pops up. Click OK.5. In the Install-directories window, as shown in Figure 8, click Select all.

You must define three directories at this point: Tivoli Storage Manager Lotus Notes directory

The directory where you want the Tivoli Storage Manager NotesBackup Agent to be installed. For example:c:\dsmnotes

Tivoli Storage Manager option file directoryYou can select the directory where the client options sample filedsm.smp should be located. For example:c:\dsmnotesTivoli Storage Manager Notes Backup Agent on OS/2 19

Lotus NOTES.INI directoryThe directory is the location where the notes.ini file is already located.For example:c:\notes

Figure 8. Install directories on OS/2

6. Click Install.7. When the installation is complete, a confirmation box is displayed. Click

OK.8. Shut down and restart your workstation.

During the installation, an icon for the readme file of the Version 3 TivoliStorage Manager Notes Backup Agent is automatically added to the TivoliStorage Manager Version 3 folder on the OS/2 desktop.

2.1.3 LicensingWith Tivoli Storage Manager V3.1.3, the Tivoli Storage Manager NotesBackup Agent is packaged with the Tivoli Storage Manager Version 3 OS/2client. The OS/2 client contains the standard backup/archive client,administration client, API, Webshell client, and the Tivoli Storage ManagerNotes Backup Agent. Users select which components to install during theinstallation process.20 Using Tivoli Storage Manager to Back Up Lotus Notes

The Tivoli Storage Manager Notes Backup Agent on OS/2 is not a separatelycharged feature; Instead, it is provided as a no-charge component for theOS/2 client. However, if you configure the Tivoli Storage Manager NotesBackup Agent with a separate node name from the Tivoli Storage Managerbackup and archive client (as we recommend in Chapter 6, Tivoli StorageManagement in a Notes environment on page 77), the Tivoli StorageManager Notes Backup Agent counts as an additional client connection andis reflected as such in the Tivoli Storage Manager server pricing.

2.1.4 Tivoli Storage Manager Notes Backup Agent files for OS/2By default, all Tivoli Storage Manager Notes Backup Agent files are located inthe c:\dsmnotes subdirectory and are used for the Tivoli Storage ManagerNotes Backup Agent to run properly.

Table 2 lists the files that are on your workstation after this installation.Table 2. Tivoli Storage Manager Notes Backup Agent on OS/2: files

File Name Description

dsmnotes.exe Executable for dsmnotes command

dsmnotes.dll Agent dynamic link library

dsmnoted.dll Agent resources

dsmln.hlp Agent help file

readme.dln Readme file

optionsl.doc Summary of applicable options

epfirexx.dll Needed to determine notes.ini

dsmln.pkg Installation package file

2.2 ConfigurationThis section provides instructions for configuring the Tivoli Storage ManagerNotes Backup Agent on OS/2. The configuration comprises setup or updatesof the Notes initialization file, notes.ini, the user environment, and the TivoliStorage Manager client options file.

2.2.1 Updating the NOTES.INI fileThese variables are set in the notes.ini file (the AddInMenus variable isrequired but all other variables are optional):Tivoli Storage Manager Notes Backup Agent on OS/2 21

AddInMenus. The Tivoli Storage Manager Notes Backup Agentinstallation program automatically adds the AddInMenus variable to yournotes.ini file. AddInMenus ties Tivoli Storage Manager to the Notesworkspace. This is required to use the GUI of the Tivoli Storage ManagerNotes Backup Agent. Figure 5 on page 15 illustrates how Tivoli StorageManager is embedded in the Notes workspace. The specified path nameis the fully qualified path name of the dsmnotes.dll file. If this line is notadded to the notes.ini file automatically during installation, you can add itmanually.

DSMNOTES_CONFIG. This variable takes a fully qualified path name thatpoints to an additional client options file. This variable is recommendedespecially when you use a separate node name for your Tivoli StorageManager Notes Backup Agent. The Notes Backup Agent uses this clientoptions file as an additional options file, which overrides any of the sameoptions that are included in the backup/archive client options file.

DSMNOTES_LOGDIR. Log messages are sent to a file called log.dsm.Use DSMNOTES_LOGDIR to point to the directory where the log file islocated. If you do not set this environment variable, the default location forlog.dsm is the Notes data directory. If you do not have a Notes datadirectory, this environment variable is required. Because this file growsover time, it must be managed as appropriate.

DSMNOTES_STATS. Use DSMNOTES_STATS to send messages to thescreen, when a command line function is run. The messages show thecurrent status of the command. If VERBOSE is specified, two types ofstatus indicators may appear on the screen:

- One or more dots (.), indicating that processing is continuing.Depending on the environment, you may experience delays betweendots. For example, delays can occur when searching very large Notesdatabases for deleted documents. There may also be delays whenwaiting for offline media to be mounted.

- Messages showing the result of the command when the command hascompleted processing. The messages display information, such as thenumber of documents transferred and whether the dsmnotes commandcompleted without any errors.

The default value for this option is QUIET. Status messages are notdisplayed on your screen. This can be the appropriate choice in a largeNotes environment, since displaying the status messages on your screenslows the performance of command line operations.

The Version 2 Tivoli Storage Manager Notes Backup Agent on OS/2 providesa private password management function. If you specify22 Using Tivoli Storage Manager to Back Up Lotus Notes

DSMNOTES_AUTO_PW=ON and DSMNOTES_PWDIR in the notes.ini file,you enable the generation of a new Tivoli Storage Manager password whenthe original expires. The password is stored in a file in the directory that isspecified by DSMNOTES_PWDIR. The password file name is dsmnotes.pwd.Version 3 Tivoli Storage Manager Notes Backup Agent makes this automaticpassword handler obsolete. It uses the PASSWORDACCESS option to letTivoli Storage Manager keep track of the agents password, as explained in2.2.3, Setting up Tivoli Storage Manager on page 23.

After you modify the notes.ini file with these environment variables, you haveto shut down the Notes workspace and bring it back up for the new changesto be active. Figure 9 shows the part of notes.ini file we used in ourenvironment.

Figure 9. NOTES.INI file update on OS/2

2.2.2 Setting environment variablesThese variables need to be set in the system environment to use the TivoliStorage Manager Notes Backup Agent on OS/2. You can set these variablesin the system configuration file config.sys:

Path. During the installation, the Tivoli Storage Manager Lotus Notesdirectory, which is selected during the installation as shown in Figure 8 on

[NOTES]...

AddInMenus=C:\DSMNOTES\DSMNOTES.DLLDSMNOTES_CONFIG=C:\DSMNOTES\DSM.OPTDSMNOTES_LOGDIR=C:\DSMNOTESDSMNOTES_STATS=VERBOSE...

page 19, is automatically added to the path statements PATH, LIBPATH,and HELP in the config.sys

DSMI_CONFIG. This Tivoli Storage Manager API variable is the fullyqualified name for the client options file dsm.opt. To allow the TivoliStorage Manager Notes Backup Agent and the backup/archive client torun simultaneously on the system, make sure that the Notes BackupAgent uses a dedicated client user options file.

DSMI_DIR. This Tivoli Storage Manager API variable points to the locationcontaining the Tivoli Storage Manager message file dscameng.txt.

DSMI_LOG. This optional Tivoli Storage Manager API variable points toTivoli Storage Manager Notes Backup Agent on OS/2 23

the directory where Tivoli Storage Manager stores the API error log filedsierror.log. The error log file contains information about Tivoli StorageManager API errors that occur during processing.

Figure 10 shows the system environment settings in the config.sys of ourOS/2 machine.

Figure 10. CONFIG.SYS update on OS/2

You also can create a command script, which includes the environmentstatements, and which is executed in an OS/2 window. From there, you thenstart the Tivoli Storage Manager Notes Backup Agent command line programor the Notes workspace. We recommend doing this, if the Tivoli StorageManager API environment variables are already set, because they are beingused with a different API application.

2.2.3 Setting up Tivoli Storage ManagerThe following subsections provide instructions to set up Tivoli StorageManager. We cover only the options essential for creating the Tivoli StorageManager options file using TCP/IP, since this is the communication protocolwe use in our environment. See ADSTAR Distributed Storage Manager:Installing the Clients, SH26-4080, for more information about the availableoptions and supported communication protocols.

Before the Tivoli Storage Manager Notes Backup Agent can connect theserver, a dedicated node name and password must be provided by the Tivoli

...

SET DSMI_CONFIG=C:\DSMNOTES\DSM.OPTSET DSMI_DIR=C:\ADSMCV3SET DSMI_LOG=C:\DSMNOTES...

Storage Manager administrator. We highly recommend having an individualnode name, client options file, and include/exclude list for the Tivoli StorageManager Notes Backup Agent.

2.2.3.1 Creating the client options fileThe client options file identifies the Tivoli Storage Manager server to contactfor services and specifies the required communication options for the server.It can also include authorization options, backup and archive processingoptions, and scheduling options.

The Tivoli Storage Manager Notes Backup Agent includes a sample clientoptions file, dsm.smp, which contains the minimum options required to get24 Using Tivoli Storage Manager to Back Up Lotus Notes

started using the Notes Backup Agent. If you choose, you can add otheroptions to the file as part of your initial setup, and you can change or addoptions later. The file dsm.smp resides in \dsmnotes after the initial codeinstallation. If you rename the file, make sure that the Tivoli Storage ManagerAPI environment variable DSMI_CONFIG points to it.

The required options for TCP/IP are: COMMMethod. The communication method to be used for client/server

communications. TCPPort. The TCP/IP port address used to communicate with the Tivoli

Storage Manager server. You do not need to set this option if the port is1500.

TCPServeraddress. The TCP/IP internet address for a Tivoli StorageManager server.

The optional entries are: NODename. If the Tivoli Storage Manager backup/archive client is

installed on the same system as the Notes Backup Agent, we highlyrecommend keeping the Notes Backup Agent as a separate node from thebackup/archive client. The separate nodes enable you to manage the filespaces for the two functions individually.

PASSWORDAccess. Specifies whether users are prompted for apassword if a Tivoli Storage Manager password is required on yourworkstation. Your Tivoli Storage Manager administrator determineswhether passwords are necessary.If you want Tivoli Storage Manager to prompt users for the node passwordfor your workstation each time they request services from the server, usethe default value of this option, which is PROMPT.

If you do not want the server to prompt users for a password, useGENERATE. The Tivoli Storage Manager password for your workstation isencrypted and stored locally. Tivoli Storage Manager automaticallygenerates a new password when the current password expires. Werecommend setting PASSWORDACCESS to GENERATE to avoid anyneed to pass along the password with every Tivoli Storage Manager NotesBackup Agent action.

PASSWORDDIR. Use this option to specify the directory where you wantTivoli Storage Manager to store the password file. You use this option onlywhen PASSWORDACCESS is set GENERATE.

Include/Exclude. These two options allow you to include or excludeTivoli Storage Manager Notes Backup Agent on OS/2 25

databases from backup services. This is explained in more detail in2.2.3.2, Creating an include/exclude list on page 25.

Figure 11 on page 27 illustrates the client options file we used in ourenvironment.

2.2.3.2 Creating an include/exclude listAn include/exclude list contains statements that identify any database filesyou want to specifically include or exclude from backup services. You canenter broad statements that exclude entire groups of database files. Then, ifnecessary, you can enter include statements to make exceptions to thosebroad statements.

Another important use for an include/exclude list is to use include statementsto assign one specific management class to all database files. This isdifferent from Tivoli Data Protection for Lotus Notes on AIX, where you canassign management classes to specific database files or groups of databasefiles. If you do not create an include/exclude list, Tivoli Storage Managerconsiders all files for backup services and uses the default managementclass.

Using include/exclude statements, the Tivoli Storage Manager NotesBackup Agent on OS/2 requires these syntax rules:

A drive must be specified with a question mark (?). If your data is in the Notes data directory, specify $NOTESDIR and then

the database. If your data resides in a subdirectory of the Notes data directory, specify

$NOTESDIR, the subdirectory, and the database.

Include/exclude syntax:26 Using Tivoli Storage Manager to Back Up Lotus Notes

To create an include/exclude list, follow these steps:1. Determine your include and exclude requirements.2. Enter your include and exclude statements into the client options file.

The include/exclude statements you enter are processed from the bottom up.If you enter an include option to assign a particular management class to thedatabases that are affected by an incremental backup, it must be the firststatement in your include/exclude list. The wildcard characters (\*\*) you needto enter at the end of a database file indicate that the statement applies to alldocuments in the specified database, both data and non-data documents.

Figure 11 illustrates an example for a client options file with include/excludestatements on OS/2.

If your data is not in the Notes data directory, you must specify a volumelabel, the full path, and the database file name.

Notes database file names end with \*\*.

TCPSERVERADDRESS YELLOWNODENAME OS2_AGENTCOMMMETHOD TCPIPPASSWORDACCESS GENERATEPASSWORDDIR C:\DSMNOTESINCLUDE ?:\* RESEARCHEXCLUDE ?:\$NOTESDIR\NAMES.NSF\*\*EXCLUDE ?:\$NOTESDIR\MAIL\...\*\*INCLUDE ?:\$NOTESDIR\MAIL\CBEUKES.NSF\...\*\*EXCLUDE ?:\D_DRIVE\...\TEST.NSF\*\*Tivoli Storage Manager Notes Backup Agent on OS/2 27

Figure 11. Client option file on OS/2

The statements have these meanings:1. Assign the RESEARCH management class to all Notes database files.2. Exclude the public Name and Address database names.nsf, which resides

in the Notes data directory, from backup services.3. Exclude any mail database of the mail subdirectory of the Notes data

directory from backup services.4. Regardless of excluding all mail database files in the mail directory,

include the database cbeukes.nsf.5. Exclude any Notes database file on the D_DRIVE that has the file name

test.nsf.

After an incremental backup has been run against a database, it is importantnot to change the management class assigned to that database. When theTivoli Storage Manager Notes Backup Agent backs up a database, it bindseach document it backs up to the specified management class. If yousubsequently change the assigned management class for a database to amanagement class that retains backup versions for a different length of time,it may not be possible to restore the entire database.

2.3 Migration considerationsThe migration from Version 2 to Version 3 of the Tivoli Storage ManagerNotes Backup Agent on OS/2 is straightforward. Databases that are backedup with a previous version of the Tivoli Storage Manager Notes Backup Agentcan be restored using the latest version. However, databases that are backedup with the latest version cannot be restored with the previous version.

Therefore, you should first uninstall the Version 2 Notes Backup Agent andthen install the Version 3 agent. You may want to use the same directory aswith the Version 2 agent, for example, c:\dsmnotes.

If you are migrating to Version 3, make sure that you also install the latestlevel of the Version 3 Tivoli Storage Manager API. You cannot run the Version3 Tivoli Storage Manager Notes Backup Agent with the Version 2 API.28 Using Tivoli Storage Manager to Back Up Lotus Notes

Chapter 3. Tivoli Data Protection for Notes on Windows NT

This chapter covers the installation and configuration of Tivoli Data Protection(TDP) for Lotus Notes on Windows NT. The installation consists of two steps:installation of the Tivoli Storage Manager API and installation of TDP forLotus Notes. The configuration includes the update of the Notes initializationfile, modifications of the Windows NT environment, and the creation of theTivoli Storage Manager client options file. All these steps are required to getTDP for Lotus Notes running and functional on your Windows NT system.

To be able to run unattended services on Windows NT, you can install the Copyright IBM Corp. 2000 29

Tivoli Storage Manager scheduler service using a new client utility that isshipped with the Version 3 Tivoli Storage Manager backup/archive client onWindows NT. We cover this installation in 3.3, DSMCUTIL utility on WindowsNT on page 42.

3.1 InstallationThis section describes the steps to install TDP for Notes on Windows NT. Theprerequisites are that Windows NT is running on the system and that theNotes server is already installed and functional. Check the readme file for thelatest information about the Windows NT and Notes server versionssupported by TDP for Notes. Moreover, the directory path for the Noteslibrary, nnotes.dll, must be included in the PATH environment variable.

You do not need to have the Tivoli Storage Manager backup/archive clientinstalled on your system. But since the agent is not able to back upnon-database data, we highly recommend using the backup/archive client inparallel. If you decide to do so, however, no specific level of the client isrequired to run it in parallel to the agent, since they do not directly interfere.

3.1.1 Tivoli Storage Manager APITivoli Data Protection for Notes uses the Tivoli Storage Manager API tocommunicate with the Tivoli Storage Manager server. The API is packagedand installed together with Tivoli Data Protection for Notes. The API files arestored in the agent directory, so that they do not override any existing APIfiles on the system. This enables you to run several Tivoli Storage ManagerAPI applications using different levels of the Tivoli Storage Manager API. Youdo not necessarily need to have the Tivoli Storage Manager backup/archiveclient installed on the system in order to run TDP for Notes. With V2.1.7 ofTDP for Notes and higher, the Version 3 API is shipped and used.

3.1.2 Tivoli Data Protection for NotesTDP for Notes has its own subdirectory structure. All files are in the\win32app\ibm\adsm\agentln\ subdirectory. The product has its own .dll and.txt files shipped with it. The following instructions assume that Windows NTVersion 4.0 is already running on the client workstation.

To install TDP for Notes on Windows NT, follow these steps:1. Insert the TDP for Notes CD-ROM in your CD-ROM reader, such as the

D-drive. Installation begins and a Welcome window is displayed. ClickNext.30 Using Tivoli Storage Manager to Back Up Lotus Notes

In the Setup options window, shown in Figure 12, you may selectTypical.

Figure 12. Setup options window on Windows NT

2. In the Select Destination Directory window, Figure 13 on page 31,specify your destination directory by clicking Browse. We selected thedefault directory c:\Program Files\Tivoli\TSM.

Tivoli Data Protection for Notes on Windows NT 31

Figure 13. Select Destination Directory window: Typical on Windows NT

If you select Custom in the Setup options window as shown in Figure 12on page 30, you get to the Select Components window as shown inFigure 14, where you can select all the components you want to install.You can exclude the documentation if you have already read it.

Figure 14. Select Destination Directory window: Custom on Windows NT

If you select Compact in the Setup options window as shown in Figure12 on page 30, you get to the Select Destination Directory compactinstallation window, as shown in Figure 15, where you can specify thedirectory to which you want the executable code copied.32 Using Tivoli Storage Manager to Back Up Lotus Notes

Figure 15. Select Destination Directory window: Compact on Windows NT

The default directory for TDP for Notes is C:\Program Files\Tivoli\TSM.The Choose Directory window appears. You can specify the:

Path Directory Drives

When you are done with the Select Destination Directory window, clickNext to continue.

3. In the Select Program Folder window, you can add program icons to theprogram folder. You can type a new folder name or select a folder from thefolders list.Select ADSM for Windows NT ADSMConnect Agent for Lotus Notes,which is the default, then click Next.The Start Copying Files window appears as shown in Figure 16 on page33. This window shows the current settings for setup type, target directoryand program folder.

Tivoli Data Protection for Notes on Windows NT 33

Figure 16. Start Copying Files window on Windows NT

Click Next.4. The Setup Complete window appears. Click Finish to complete the

installation.5. From the program folder, you can now access:

The ADSMConnect Agent for Lotus Notes command line window icon The installation and user guide The option file and other icons

All Notes Agent files, such as the executables and libraries reside in asubdirectory called agentln under the specified directory setup in step 2 onpage 30.

3.1.3 LicensingTDP for Notes on Windows NT fully implements the try and buy licensingfunction. You can use it for a limited time as a full function demonstration. Torun TDP for Notes permanently on Windows NT, however, you need a fulllicense. Without a license you cannot access the Tivoli Storage Managerserver. The license file is installed together with the TDP for Notes and storedas C:\Program Files\Tivoli\TSM\agentln\agent.lic on Windows NT. TDP forNotes uses the environment variables to locate the license file. Therefore,you need to set the appropriate environment variables before you use TDP

for Notes. This is explained in more detail in 3.2.2, Setting environmentvariables on page 36.

3.1.4 TDP for Notes files for Windows NTBy default, all TDP for Notes files are located in the C:\ProgramFiles\Tivoli\TSM\agentln\agent.lic subdirectory. Table 3 lists the files that areon your workstation after you have installed TDP for Notes.Table 3. TDP for Notes for Windows NT: Files

File Name Description

dsmnotes.exe Executable for TDP for Notes command-line functions34 Using Tivoli Storage Manager to Back Up Lotus Notes

3.2 ConfigurationThis section provides instructions for configuring TDP for for Notes onWindows NT. The configuration comprises setup or updates of the Notesinitialization file, notes.ini, the user environment, and the Tivoli StorageManager client options file.

3.2.1 Updating the NOTES.INI fileThe following variables are set in the notes.ini file (the AddInMenus variableis required but all other variables are optional):

AddInMenus. The TDP for Notes installation program automatically addsthe AddInMenus variable to your notes.ini file. AddInMenus ties TivoliStorage Manager to the Notes workspace. This is required to use the GUIof TDP for Notes. Figure 5 on page 15 illustrates how Tivoli StorageManager is embedded in the Notes workspace. The specified path nameis the fully qualified path name of the dsmnoted.dll file. If this line is notadded to the notes.ini file automatically during installation, you can add itmanually.

dsmnoted.dll TDP for Notes GUI library

notesdlg.dll TDP for Notes resources

dsmnoted.hlp TDP for Notes help file

dsm.opt Options file

readln.txt Last minute updates and other special information

dscameng.txt Tivoli Storage Manager API message file

agent.lic License file

DSMNOTES_LOGDIR. Log messages are sent to a file called log.dsm.Use DSMNOTES_LOGDIR to point to the directory where the log file islocated. If you do not set this environment variable, the default location forlog.dsm is the Notes data directory. If you do not have a Notes datadirectory, this environment variable is required. Because this file growsover time, it must be managed carefully.

DSMNOTES_STATS. Use DSMNOTES_STATS to send messages to thescreen when a command line function is run. The messages show thecurrent status of the command. If VERBOSE is specified, two types ofstatus indicators might appear on the screen:

One or more dots (.), indicating that processing is continuing.Tivoli Data Protection for Notes on Windows NT 35

Depending on the environment, you may experience delays betweendots. For example, delays can occur when searching very large Notesdatabases for deleted documents. There may also be delays whenwaiting for off line media to be mounted.

Messages showing the result of the command when the command hascompleted processing. The messages display information such as thenumber of documents transferred and whether the dsmnotes commandcompleted without any errors.

The default value for this option is QUIET. Status messages are notdisplayed on your screen. This can be the appropriate choice in a largeNotes environment, since displaying the status messages on your screenslows the performance of command line operations.

After you modify the notes.ini file with these environment variables, you haveto shut down the Notes workspace and bring it back up for the new changesto be active. Figure 17 shows the part of the notes.ini file we used in ourenvironment.

Figure 17. NOTES.INI file update on Windows NT

[Notes]...

AddInMenus=C:\PROGRA~1\TIVOLI\TSM\ADSM\Agentln\dsmnoted.dllDSMNOTES_LOGDIR=C:\PROGRA~1\TIVOLI\TSM\AgentlnDSMNOTES_STATS=verbose...

3.2.2 Setting environment variablesThe following variables need to be set in the system environment to use TDPfor Notes. You need to set these variables as system variables for theWindows NT system. To do this, open the system properties window from theWindows NT control panel. Select the environment folder and set all thefollowing variables in the upper system-variables window.

Insert the variables as system variables. If you enter these as user variables,you will not be able to run any unattended services such as Tivoli StorageManager schedules. See 3.3, DSMCUTIL utility on Windows NT on page 42for further details.36 Using Tivoli Storage Manager to Back Up Lotus Notes

These are the environment variables: Path. You need to include the following directories to your PATH

statement:

- Notes library directory, containing nnotes.dll- TDP for Notes libraries directory, containing dsmnoted.dll, adsmv3.dll,

and notesdlg.dll DSMI_CONFIG. This Tivoli Storage Manager API variable is the fully

qualified name for the client options file, dsm.opt. To allow TDP for Notesand the backup/archive client to run simultaneously on the system, makesure that TDP for Notes uses a dedicated client user options file.

DSMI_DIR. This Tivoli Storage Manager API variable points to the locationcontaining the Tivoli Storage Manager message file dscameng.txt and theTDP for Notes license file agent.lic.

DSMI_LOG. Select this optional Tivoli Storage Manager API variable topoint to the directory where Tivoli Storage Manager stores the API errorlog file dsierror.log. The error log file contains information about TivoliStorage Manager API errors that occur during processing.

Figure 18 shows the system environment settings on our Windows NTworkstation.

Tivoli Data Protection for Notes on Windows NT 37

Figure 18. System Properties on Windows NT

You can also create a command script that includes the environmentstatements and is executed in a command prompt window. From there, youcan start the TDP for Notes command line program or the Notes workspace.We recommend doing this if the Tivoli Storage Manager API environmentvariables have already been set to be used with a different API application.

3.2.3 Setting up Tivoli Storage ManagerThe following subsections provide instructions to set up Tivoli StorageManager. We cover only the options essential for creating the Tivoli StorageManager options file using TCP/IP, since this is the communication protocolwe use in our environment. See Tivoli Storage Manager: Installing theClients, SH26-4102, or the options.wri file in the installation directory for moreinformation about the available options and supported communicationprotocols.

Before TDP for Notes can connect the server, a dedicated node name andpassword must be provided by the Tivoli Storage Manager administrator. Wehighly recommend having an individual node name, client options file, andinclude/exclude list for TDP for Notes.

3.2.3.1 Creating the client options fileThe client options file identifies the Tivoli Storage Manager server to contactfor services and specifies the required communication options for the server.It can also include authorization options, backup and archive processingoptions, and scheduling options.

The required options for TCP/IP are: COMMMethod. The communication method to be used for client/server

communications. TCPPort. The TCP/IP port address used to communicate with the Tivoli

Storage Manager server. You do not need to set this option if the port is1500.

TCPServeraddress. The TCP/IP internet address for an Tivoli StorageManager server.

The optional entries are:38 Using Tivoli Storage Manager to Back Up Lotus Notes

NODename. If the Tivoli Storage Manager backup/archive client isinstalled on the same system as TDP for Notes, we highly recommend thatTDP be on a separate node from the Tivoli Storage Managerbackup/archive client. Separating the nodes enables you to manage thefile spaces for the two functions separately.

PASSWORDAccess. Specifies whether users are prompted for apassword, if a Tivoli Storage Manager password is required on yourworkstation. Your Tivoli Storage Manager administrator determineswhether passwords are necessary.If you want Tivoli Storage Manager to prompt users for the Tivoli StorageManager password for your workstation each time they request servicesfrom the server, use the default value of this option, which is PROMPT.If you do not want Tivoli Storage Manager to prompt users for a password,use GENERATE. The Tivoli Storage Manager password for your nodename is encrypted and stored locally in the registry as illustrated in Figure19. Each Tivoli Storage Manager node instance has its dedicatedpassword entry in the registry. In our example, the backup/archive client iscalled SERVWNT and the TDP for Notes client is Tivoli StorageManagerWNT_AGENT. Tivoli Storage Manager automatically generates anew password when the current password expires. We recommend settingPASSWORDACCESS to GENERATE to avoid any need to pass along thepassword with every TDP for Notes action.

Tivoli Data Protection for Notes on Windows NT 39

Figure 19. Tivoli Storage Manager password in registry

The password is stored in the registry under the Tivoli Storage Managernode name. Therefore, you can run multiple client instances withPASSWORDACCESS set to GENERATE on the same system, forexample, the backup/archive client and TDP for Notes. Tivoli StorageManager then does not prompt you for any password.

Include/Exclude. These two options allow you to include or excludedatabases from backup services. This is explained in more detail in3.2.3.2, Creating an include/exclude list on page 40.

Figure 20 on page 41 illustrates the client options file we used in ourenvironment.

TDP for Notes includes a sample client options file, dsm.opt, which containsthe minimum options required to get started using TDP for NotesTivoliStorage Manager. If you choose, you can add other options to the file as partof your initial setup, and you can change or add options later. The file dsm.optresides in win32app\ibm\adsm\agentln after the initial code installation. If yourename the file, make sure that the Tivoli Storage Manager API environmentvariable DSMI_CONFIG points to it. However, only options supported by the

API can be used. For example, the SUBDIR option is not recognized in theclient options file by the Tivoli Storage Manager API; therefore, if you want touse it, you must specify it in the TDP for Notes command line directly.

3.2.3.2 Creating an include/exclude listAn include/exclude list contains statements that identify any database filesyou want to specifically include or exclude from backup services. You canenter broad statements that exclude entire groups of database files. Then, ifnecessary, you can enter include statements to make exceptions to thosebroad statements.

Another important use for an include/exclude list is to use include statements40 Using Tivoli Storage Manager to Back Up Lotus Notes

to assign one particular management class to all database files. This isdifferent from TDP for Notes on AIX, where you can assign managementclasses to specific database files or groups of database files. If you do notcreate an include/exclude list, Tivoli Storage Manager considers all files forbackup services and uses the default management class.

To create an include/exclude list, follow these steps:1. Determine your include and exclude requirements.2. Enter your include and exclude statements into the client options file.

The include/exclude statements you enter are processed from the bottom up.If you enter an include option to assign a particular management class to thedatabases that are affected by an incremental backup, it must be the firststatement in your include/exclude list. The wildcard characters (\*\*) you need

Using include/exclude statements, TDP for Notes on Windows NT requiresthe following syntax rules:

A drive must be specified with a question mark (?). If your data is in the Notes data directory, specify $NOTESDIR and then

the database. If your data resides in a subdirectory of the Notes data directory, specify

$NOTESDIR, the subdirectory, and the database. If your data is not in the Notes data directory, you must specify a volume

label, the full path, and the database file name. Notes database file names end with \*\*.

Include/exclude syntax:

to enter at the end of a database file indicate that the statement applies to alldocuments in the specified database, both data and non-data documents.

Figure 20 illustrates an example for a client options file with include/excludestatements on Windows NT.

nodename wnt_agentcommmethod TCPIPtcpport 1500tcpserveraddress yellowPASSWORDACCESS GenerateTivoli Data Protection for Notes on Windows NT 41

Figure 20. Client options file on Windows NT

The statements have the following meaning:1. Assign the RESEARCH management class to all Notes database files.2. Exclude from backup services all help database files in the Notes data

directory that start with help.3. Exclude from backup services all database files in the sample subdirectory

of the Notes data directory.4. Regardless of excluding all database files in the sample directory, include

the database faqw46.nsf.5. Exclude any Notes database file on the D_DRIVE that has the file name

test.nsf.

After an incremental backup has been run against a database, it is importantnot to change the management class assigned to that database. WhenTDPfor Notes backs up a database, it binds each document it backs up to thespecified management class. If you subsequently change the assignedmanagement class for a database to a management class that retains backupversions for a different length of time, it may not be possible to restore theentire database.

INCLUDE ?:* RESEARCHEXCLUDE ?:\$NOTESDIR\HELP*.NSF\*\*EXCLUDE ?:\$NOTESDIR\sample\...\*\*INCLUDE ?:\$NOTESDIR\sample\faqw46.NSF\*\*EXCLUDE ?:\D_DRIVE\...\test.nsf\*\*

3.3 DSMCUTIL utility on Windows NTTDP for Notes does not have its own scheduler service. It uses the TivoliStorage Manager backup/archive client scheduler service to run backupsautomatically. This section shows how the Tivoli Storage Manager schedulerservice is installed on a Windows NT machine.

With Version 3, a new client utility, called dsmcutil, is shipped with the TivoliStorage Manager backup/archive client on Windows NT. This utility createsseveral entries in the registry of Windows NT. It allows Tivoli StorageManager scheduler services to be installed and configured on Windows NT42 Using Tivoli Storage Manager to Back Up Lotus Notes

machines. It replaces the Version 2 showpw, updatepw, and dsmcsvciutilities. See the dsmcutil.txt readme file in the backup/archive installationdirectory for more detailed information.

When you plan to run the Tivoli Storage Manager scheduler as a Windows NTservice, you have to specify the Tivoli Storage Manager environmentvariables in the system part of the Windows NT environment. If you enterthese variables under the user part, you will not be able to run anyunattended services. See 3.2.2, Setting environment variables on page 36for further information.

To set up Tivoli Storage Manager backup/archive client scheduler as aservice on Windows NT, you need to run the dsmcutil commands from anaccount that belongs to the Administrator/Domain Administrator group. Forthe installation, specify the registered node name and password of thebackup/archive client on your Windows NT machine. Figure 21 illustrates thecommand and its output during the installat