Include and exclude processing

Information about file inclusions and file exclusion is presented.

Considerations

Data Protection for IBM® Domino® deals only with Domino databases and transaction log files if archival logging is in enabled on the Domino server. Other files that might exist on the server are not backed up by Data Protection for HCL Domino so they do not have to be excluded. If you want to limit the backups to a subset of the databases on your Domino server, the standard include and exclude syntax can be used.

Read the documentation about include and exclude processing for the base IBM Storage Protect backup-archive client as a thorough introduction to processing concepts. See the Examples in this section regarding Data Protection for HCL Domino.

Examples

Domino databases are stored by their relative names on the IBM Storage Protect server. As result, relative names must be used in include and exclude statements. The notes data directory should not be specified, and databases that are linked to the notes data directory by database or directory links must be referenced by the symbolic name. Do not use fully qualified physical file names.

A single database backup is stored as two objects on the IBM Storage Protect server. The objects that are created are the relative database name and the relative database name with a .DATA extension. For example, a backup of database mail6\user1.nsf would result in the following two objects:

The relative name of the database:
```
mail6\user1.nsf
```
The relative name of the database with .DATA:
```
mail6\user1.nsf.DATA
```

When you exclude a group of databases and then include a specific subset of that group, you must be sure to include both objects. For example, to exclude all databases in directory mail6 except for database user1.nsf, use the following statements:

EXCLUDE mail6\*

INCLUDE mail6\user1.nsf

INCLUDE mail6\user1.nsf.DATA

Note: When you exclude a specific database, the .DATA object does not have to be excluded because the .DATA object is not created unless the database is included.

When you assign a group of databases to a management class, you must assign both objects. For example, to assign all databases that match *.nsf in the mail6 subdirectory to the DOMINO management class, code the following statement:

INCLUDE mail6\*.nsf* DOMINO

If archival logging is in effect on the domino server, you must be sure not to exclude the transaction log files from backup. The transaction logs have a base object name of S######.TXN, the "#" character represents a number. If you use a broad exclude statement, make sure to include the transaction log files by coding a statement as follows:

INCLUDE S*.TXN

Exclude databases that increase in size during compression compressionyes by using the client option, exclude.compression. You must specify the .DATA object to exclude a database from compression. For example, to exclude the database mail6\user1.nsf from compression, enter:

EXCLUDE.COMPRESSION mail6\user1.nsf.*

See IBM Storage Protect for Windows Backup-Archive Client Installation and User's Guide for more information about the exclude.compression option.

You can encrypt Domino databases during backup and restore processing by specifying enableclientencryptkey=yes in the Data Protection for HCL Domino options file dsm.opt, located by default in the Data Protection for HCL Domino installation directory.. In the same file, specify the databases that you want to encrypt by adding an include statement with the include.encrypt option. For example, to encrypt all data, use:

include.encrypt *\...\*

To encrypt only the Mydb.nsf database in the default directory, use:

include.encrypt Mydb.nsf
include.encrypt Mydb.nsf.DATA

include.encrypt Mydb.nsf*

To encrypt all databases in the mail65 directory, use:

include.encrypt mail65\...\*

Transparent encryption is available on IBM Storage Protect server Version 5.3 (or later).

You can choose to include backup or archive files for data deduplication. To refine the list of files to be included, the include.dedup option can be used in combination with the exclude.dedup option. By default, all eligible objects are included for data deduplication. The following examples show how to use the include and exclude options:

exclude.dedup E:\myfiles\...\*

Include.dedup E:\myfiles\archive\*

Exclude all databases named db1.nsf regardless of where they display:

EXCLUDE db1.nsf

Exclude all databases that match help5_* in the help subdirectory:

EXCLUDE help\help5_*

Include all databases in the mail6 directory:

INCLUDE mail6\...\*

Assign all databases that match *.nsf in the mail subdirectory to the MAILDB management class:

INCLUDE mail\*.nsf* MAILDB

Exclude all databases in the mail6 subdirectory from compression:

EXCLUDE.COMPRESSION mail6\...\*

The default INCLUDE/EXCLUDE lists.

EXCLUDE mail.box

EXCLUDE log.nsf

Note: You can back up the log.nsf database, but you can only restore it to an alternate name.

Include all transaction logs:

INCLUDE S*.TXN

Domino DB2

Include and exclude statements can be specified for table space backups and for full DB2® database backups. The administrator can use include/exclude statements to manage the meta objects (created by Data Protection for HCL Domino) and the data objects (created by DB2 API). The management class assigned to meta objects is forced on the data objects created by the DB2 API. The include/exclude statements specification for meta objects is based on the naming convention for the meta object group leaders. To assign management classes to DB2NSF databases, the user must use the IBM Storage Protect object name of the full DB2 group leader object, or the IBM Storage Protect object name of the table space group leader object.

Domino DB2 example (full DB2 backup)

The following statement includes all DB2 databases that are assigned to management class MGMTC1, on partition NODE000, on the Domino 7 Server during a full DB2 backup:

INCLUDE \domino7.DOMDBS\NODE0000\FULL\DOMINO  MGMTC1

The following statement includes all DB2 databases that are assigned to management class MGMTC1, on all partitions that reside on all available Domino servers during a full DB2 backup:

INCLUDE \…\FULL\*    MGMTC1

Domino DB2 example (table space backup)

This statement includes DB2 Group GRP1:

INCLUDE GRP1

This statement assigns DB2 Group GRP2 to management class DB2GROUPS:

INCLUDE GRP2 DB2GROUPS

This statement excludes all DB2 Groups in CLASS1:

EXCLUDE CLASS1\*

This statement includes all DB2 Groups in CLASS2:

INCLUDE CLASS2\*

This statement excludes DB2 Group GRP1 in CLASS3:

EXCLUDE CLASS3\GRP1