Tivoli Storage Manager for Windows Using the Backup-Archive Client


Chapter 7. Creating an Include-Exclude List

You can create an include-exclude list to exclude a specific file or groups of files from backup services, and to assign specific management classes to files. TSM backs up any file that is not explicitly excluded. TSM client directories should be excluded from backup services.

To create an include-exclude list, you can use the TSM preference editor as follows:

  1. From the TSM GUI, select Edit> Preferences.
  2. Select the Include/Exclude tab.

You can also create an include-exclude list by selecting Utilities> Setup Wizard from the TSM GUI.

You can also create an include-exclude list, by performing the following steps:

  1. Determine your include and exclude requirements.
  2. Locate the include-exclude section in your dsm.opt file.
  3. Enter your include and exclude statements using the appropriate include-exclude options in Table 8. Because TSM processes your include-exclude list from the bottom of the list up, it is important to enter all your include-exclude statements in the same section.
  4. Save the file as dsm.opt or as the file specified in the DSM_CONFIG environment variable.

Table 8 provides brief descriptions of the include and exclude options that you can specify in your client options file. See table references for more information about each option.

Table 8. Include-Exclude Options

Option Description Page
exclude Excludes a file or group of files from backup services. Any file in your client domain that is not specifically excluded with this option is considered for backup. Exclude Options
exclude.archive Excludes a file or group of files from archive services. Exclude Options
exclude.backup Excludes a file or a group of files from backup services only. Exclude Options
exclude.dir Locates matching directory names. If a matching directory is found, that directory, its files, and all its subdirectories and their files are excluded from backup services. Exclude Options
exclude.encrypt Excludes files from encryption processing. Exclude Options
exclude.file Excludes files, but not directories, that match a pattern. Exclude Options
exclude.file.backup Excludes a file from normal backup services. Exclude Options
include Includes files or management classes for backup or archive processing. Include Options
include.encrypt Includes files for encryption processing. Include Options
include.file Includes a file for backup services, or assigns a management class to a file. Include Options

Excluding Files with UNC Names

You can exclude files that are accessed remotely by specifying their universal naming convention (UNC) names. For example, assume that local drive letter g is mapped to the remote share point,

\\remote\books

You would like to exclude from backups all files at the root of this share point which have an extension of .txt. You could use either of the following commands:

exclude g:*.txt
exclude \\remote\spike\*.txt

You cannot specify UNC names for removable drives such as CD or diskette. For example, the following command is not valid:

exclude \\ocean\a$\winnt\system32\...\*.*

Excluding System Files

We recommend that you have the following minimum include-exclude list in your client options file:

   exclude "*:\microsoft uam volume\*"
   exclude "*:\microsoft uam volume\*.*"
   exclude "*:\microsoft uam volume\...\*"
   exclude "*:\microsoft uam volume\...\*.*"
   exclude "*:\...\ea data. sf"
   exclude "*:\...\pagefile.sys
   exclude "*:\...\ibmbio.com
   exclude "*:\ibmdos.com
   exclude "*:\msdos.sys
   exclude "*:io.sys
   exclude "*:\...\system32\config\*.*
   exclude "*:\...\system32\config\...\*

These are system files that cannot be recovered without possibly corrupting the operating system. If you are using a disk compression program, you might want to exclude the dblspace.* and drvspace.* files. It is not necessary to back up these hidden files because TSM backs them up in the file spaces that these programs use. If you do back up these large files, your communication session might time out before TSM sends the files. Consult your disk compression documentation for the file names, or enter the following command to look for hidden files:

   dir /a:h

Including and Excluding Groups of Files

To specify groups of files that you want to include or exclude, use the wildcard characters listed in Table 9. This table applies to include and exclude statements only. For information about using wildcard characters in TSM commands, see "Using Wildcard Characters".

Table 9. Wildcard and Other Special Characters

Character Function
? The match-one character matches any single character except the directory separator; it does not match the end of the string. You cannot use the match-all character (or any wildcard character) when specifying the high-level qualifier of an object, only use it for the low-level qualifier. . For example:
  • The pattern ab?, matches abc, but does not match ab, abab, or abzzz.
  • The pattern ab?rs, matches abfrs, but does not match abrs, or abllrs.
  • The pattern ab?ef?rs, matches abdefjrs, but does not match abefrs, abdefrs, or abefjrs.
  • The pattern ab??rs, matches abcdrs, abzzrs, but does not match abrs, abjrs, or abkkkrs.
* The match-all character. You cannot use the match-all character (or any wildcard character) when specifying the high-level qualifier of an object, only use it for the low-level qualifier. For example:
  • The pattern ab*, matches ab, abb, abxxx, but does not match a, b, aa, bb.
  • The pattern ab*rs, matches abrs, abtrs, abrsrs, but does not match ars, or aabrs, abrss.
  • The pattern ab*ef*rs, matches abefrs, abefghrs, but does not match abefr, abers.
  • The pattern abcd.*, matches abcd.c, abcd.txt, but does not match abcd, abcdc, or abcdtxt.
\... The match-n character matches zero or more directories.
\

The directory separator character limits the scope of the search for the matching n characters and directories. If a pattern does not begin with a directory separator (or one does not follow the drive specification), a match all directories is appended to the pattern. For example, these patterns are equivalent:

   c:*
   c:\...\*

[ The open character-class character begins the enumeration of a character class. For example:
   xxx[abc] matches xxxa, xxxb, or xxxc.
- The character-class range includes characters from the first character to the last character specified. For example:
   xxx[a-z] matches xxxa, xxxb, xxxc, ... xxxz.

This format should not be used to specify remote drives in an exclude statement.

\ The literal escape character. When used within a character class, it treats the next character literally. When used outside of a character class, it is not treated in this way.
] The close character-class character ends the enumeration of a character class.
: The drive separator character separates a file specification. The characters before the colon identify a drive name. The characters after the colon identify either a directory name or a file name. For example:
d:\direct\file.nam

Examples Using Wildcards With Include and Exclude Patterns

Table 10 contains examples of ways you might use wildcard characters with include and exclude patterns.

Table 10. Using Wildcard Characters with Include and Exclude Patterns

Task Pattern
Exclude all files with an extension of bak, except those found on the d: drive in the dev directory.
exclude ?:*.bak
include d:\dev\*.bak

Exclude all files and directories under any tmp directory that might exist, except for the file, d:\tmp\save.fil. Include this file.
exclude ?:\...\tmp\...\*
include d:\tmp\save.fil

Exclude any .obj file in any directory on the c: e: f: and g: drives.
exclude [ce-g]:\...\*.obj  

The c: e: f: and g: drives are local or removable.

Exclude the .obj files found in the root directory in the d: drive only.
exclude d:\*.obj

Exclude any file that resides under the tmp directory found on any drive.
exclude ?:tmp\...\*

Exclude all directories and files on the remote, removable drives.
exclude \\*\*\*

Exclude all directories and files on the local drives, except the c: drive.
exclude.dir \\*\*\*
exclude     {abd - z}:*
exclude.dir {abd - z}:*


Processing Include and Exclude Options

Include-exclude options can be defined on the server using the inclexcl parameter. The include-exclude statements specified by the server are evaluated along with those in the client options file. The server include-exclude statements are always enforced and placed at the bottom of the include-exclude list and evaluated before the client include-exclude statements. TSM processes the include-exclude list from the bottom up, and stops when it finds an include or exclude statement that matches the file it is processing. The order in which the include and exclude options are listed therefore affects which files are included and excluded. See Chapter 8, "Setting Common Options" for more information about the order in which all options are processed.

The TSM client program processes the include and exclude options as follows:

  1. Files are checked; directories are only checked if the exclude.dir option is specified.

    You can use the exclude.dir option in your options file to exclude directories and subdirectories from backup. See Exclude Options for more information.

  2. Options are checked from the bottom of the include-exclude list up, until a match is found. However, on full incremental backups exclude.fs statements take precedence over other include-exclude statements, regardless of their position in the include-exclude list. See Exclude Options for more information.

    If a match is found, the processing stops and checks whether the option is include or exclude. If the option is include, the file is backed up. If the option is exclude, the file is not backed up.

  3. If a match is not found, files listed are implicitly included and backed up.
  4. If policy administration is in effect, files are backed up according to the default management class, or the management class you specify.

The following examples demonstrate bottom up processing.

Example 1
Assume that c: is defined as the domain, and you defined the following statements for the include and exclude options:
   exclude ?:\*.obj
   include c:\foo\...\*.obj
   exclude c:\foo\junk\*.obj

The file that processes is: c:\foo\dev\test.obj. Processing follows these steps:

  1. Rule 3 (the last include or exclude statement defined) is checked first because of bottom up processing. The file c:\foo\junk\*.obj does not match the file name that is being processed.
  2. Processing moves to Rule 2 and checks. This time, file c:\foo\...\*.obj matches the file name that is being processed. Processing stops, the option is checked, and it is include.
  3. File c:\foo\dev\test.obj is backed up.

Example 2
Assume that c: is defined as the domain, and you defined the following statements for the include and exclude options:
   exclude ?:\*.obj
   include c:\foo\...\*.obj
   exclude c:\foo\junk\*.obj

The file that processes is: c:\widg\copyit.bat. Processing follows these steps:

  1. Rule 3 is checked and finds no match.
  2. Rule 2 is checked and finds no match.
  3. Rule 1 is checked and finds no match.
  4. Because a match is not found, file c:\widg\copyit.bat is implicitly included and backed up.

Example 3
Assume that c: is defined as the domain, and you defined the following statements for the include and exclude options:
   exclude ?:\...\*.obj
   include c:\foo\...\*.obj
   exclude c:\foo\junk\*.obj

The current file that processes is: c:\lib\objs\printf.obj. Processing follows these steps:

  1. Rule 3 is checked and finds no match.
  2. Rule 2 is checked and finds no match.
  3. Rule 1 is checked and a match is found.
  4. Processing stops, the option is checked, and it is exclude.
  5. File c:\lib\objs\printf.obj is not backed up.

Processing Rules When Using UNC Names

When processing files with UNC names, TSM uses the rules described above. In addition, the following rules apply.

Explicit Use of UNC names for Remote Drives

TSM will recognize explicit use of UNC names for remote drives. For example, in the list below the UNC name pattern can be substituted for the DOS pattern. Assume local drive letter r: is mapped to remote share point \\remote\c$, s: is mapped to \\remote\share4, and t: is mapped to \\remote\share2.

Table 11. Using UNC Names with Include and Exclude Patterns

UNC Name Pattern DOS Pattern
\\remote\c$\include\file.out 

r:\include\file.out

\\remote\c$\...\file.out 

r:\...\file.out

\\remote\share4\exclude\*

s:\exclude\*  

\\remote\share2\...\?.out 

t:\...\?.out

Conversion of DOS Pathnames for Fixed and Remote Drives

TSM converts DOS pathnames that are mapped to remote share points. For example, a remote share point that is mapped from

r:\test\...\exclude.out

to

\\remote\share\test\...\exclude.out

is converted. Remote share points that are not mapped are not converted. Files on removable media is not converted.

File Space Name Matching

File space names that are specified with a wildcard must be UNC names. For example, the specification ?:\...\test.txt only matches files named test.txt which are specified in one or more of the following ways:

\\server\d$\test.txt
\\server\share\directory\test.txt
a:\diskette\test.txt

Character Class Matching

The following examples show valid matches using character class:

\\remote[a-z]\share\file.txt
matches    \\remotea\share\file.txt
 \\remote\share[a-z]\file.txt
matches     \\remote\sharex\file.txt
 \\remote\share\file[a-z].txt
matches     \\remote\share\fileg.txt 


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]