Tivoli Storage Manager Installing the Clients


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 and space management services (if the TSM HSM client is installed), and to assign specific management classes to files. TSM backs up any file that is not explicitly excluded. TSM client directories or folders (for Macintosh) should be excluded from backup services.

Table 8 provides brief descriptions of the include and exclude options that you can specify in your client options file, Preferences file (for Macintosh), or include-exclude options file (for UNIX). 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 and space management services (if the TSM HSM client is installed). 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 normal backup services, but not from HSM. 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. This option is valid for Windows clients only. 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
exclude.file.spacemgmt Excludes a file from hierarchical space management services (HSM) only. Use this option when you have both the backup-archive client and the HSM client installed. Exclude Options
exclude.fs Excludes file spaces matching a pattern. Exclude Options
exclude.image Excludes mounted file systems and raw logical volumes that match the pattern from image processing. This option is valid for AIX, HP-UX, and Solaris only. Exclude Options
exclude.spacemgmt Excludes a group of files from HSM backup only. Use this option when you have both the backup-archive client and the HSM client installed. Exclude Options
include Includes files or management classes for backup or archive processing. Include Options
include.encrypt Includes files for encryption processing. This option is valid for Windows clients only. Include Options
include.file Includes a file for backup services, or assigns a management class to a file. Include Options
include.image Includes a file space or logical volume, or assigns a management class when used with the backup image command. The backup image command ignores all other include options. This option is valid for AIX, HP-UX, and Solaris clients only. Include Options

Excluding System Files

We recommend at least the following minimum include-exclude lists:

Macintosh
exclude "...:Desktop DB"
exclude "...:Desktop DF"
exclude "...:Desktop"
exclude "...:Trash:*"
exclude "...:VM Storage"
exclude "...:Norton FileSaver Data"
exclude "...:Norton VolumeSaver Data"
exclude "...:Norton VolumeSaver Index"

NetWare
exclude servera\*:/.../VOL$LOG.ERR
exclude servera*:/.../TTS$LOG.ERR
exclude servera*:/.../SYS$LOG.ERR
exclude servera*:/.../EVENTS.LOG
exclude servera*:/.../SECAUDIT.LOG
exclude servera*:/.../SYSTEM.LOG
exclude servera*:/.../NET$OBJ.SYS
exclude servera*:/.../NET$PROP.SYS
exclude servera*:/.../NET$VAL.SYS
exclude servera\SYS:SYSTEM/CMASTER.DBA
exclude servera\SYS:SYSTEM/BTRIEVE.TRN
exclude servera\SYS:SYSTEM/TSA/TSA$TEMP.*

UNIX
exclude /unix
exclude /.../core
exclude /.../.SpaceMan/.../*

If you are using AFS, also specify:

exclude /usr/vice/cache/*
exclude /var/vice/cache/*

Windows 95, Windows 98, Windows NT, and Windows 2000
Exclude "*:\microsoft uam volume\...\*"
Exclude *:\...\pagefile.sys
Exclude *:\IBMBIO.COM
Exclude *:\IBMDOS.COM
Exclude *:\MSDOS.SYS
Exclude *:\IO.SYS
Exclude *:\...\SYSTEM32\CONFIG\*.*
Exclude *:\...\SYSTEM32\CONFIG\...\*

These files are all system files that can not be recovered without possibly corrupting the operating system.


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 the individual TSM client publications.

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 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.

For Windows: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 specially treated.
] The close character-class character ends the enumeration of a character class.

Windows 95, Windows 98, Windows NT, and Windows 2000 specific
\... 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 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 file name. For example:
   d:\direct\file.nam

Macintosh specific
...: Matches all volumes or folders. For example:
   ...:...:*

Matches any file in any folder on any volume. The first group specifies the volume and the second group specifies the folder.

Note:This is three periods followed by a colon, not an ellipsis followed by a colon.

UNIX specific
/... 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:
   core
   /.../core

NetWare specific
/... 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:
   servera\sys:*.nlm
   servera\sys:...\*.nlm
\ When used outside a character class, it is used as a directory separator. TSM changes a \ to a /, unless it is used within a character class.

This is also a server name delimiter when it is placed before a volume delimiter (:).

: The volume-separator character separates a file specification. The characters after the colon identify either a directory name or a file name. The characters before the colon identify a volume name. For example:
volumename:/directoryname/file.nam

Examples Using Wildcards With Include and Exclude Patterns


Table 10. Using Wildcard Characters with Include and Exclude Patterns

Task Pattern
Windows 95, Windows 98, Windows NT, and Windows 2000
Exclude any .obj file in any directory on the local or removable c: e: f: and g: drives.
exclude [ce-g]:\...\*.obj  

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 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}:*

Macintosh
Exclude all files that end with doc, except those found on volume La Pomme in the Documents folder.
exclude "...:...:*doc"
include "La Pomme:Documents:*doc"

Exclude all files and folders under any Documents folder that might exist, except for the file, La Pomme:Documents:Current Resume. Include this file.
exclude "...:...:Documents:...:*"
include "La Pomme:Documents:
Current Resume"

Exclude any .cpp file in any folder on the Vol1, Vol2, Vol3, and Vol4 volumes.
exclude "Vol[1-4]:...:*.cpp"

NetWare
Exclude all files with an extension of .bak, except those found on servera in the one:/dev directory.
exclude servera\*:.../*.bak
include servera\one:dev/*.bak 

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

Exclude any .obj file in any directory on volumec, volumee, volumef, and volumeg.
exclude servera\volume[ce-g]:/.../
*.obj

UNIX
Exclude all files with an extension of bak, except those found on the /usr file system in the dev directory.
exclude *.bak
include /usr/dev/*.bak     

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

Exclude any .obj file in any directory on the /usr1, /usr2, and /usr3 file systems.
exclude /usr[1-3]/.../*.obj  


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 Processing 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. 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.

  2. If a match is not found, files listed are implicitly included and backed up.
  3. 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 (for Windows 95, Windows 98, Windows NT, and Windows 2000)
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 (for UNIX)
Assume that /home is defined as the domain, and you defined the following statements for the include and exclude options:
   exclude *.obj
   include /home/foo/.../*.obj
   exclude /home/foo/junk/*.obj

The file that processes is: /home/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 /home/widg/copyit.bat is implicitly included and backed up.

Example 3 (for NetWare)
Assume that servera\data: is defined as the domain, and you defined the following statements for the exclude and include options:
Note:In a NetWare environment, if you do not specify a server name, the TSM client program uses the local server name.
   exclude servera\*:*.obj
   include servera\data:foo/.../*.obj
   exclude servera\data:foo/junk/*.obj

The current file that processes is: servera\data: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, servera\data:foo/junk/*.obj does not match the current file name that is being processed.
  2. Processing moves to Rule 2 and checks. This time, file servera\data:foo/.../*.obj matches the current file name that is being processed. Processing stops, the option is checked, and it is include.
  3. File servera\data:foo/dev/test.obj is backed up.

Example 4 (Macintosh)
Assume that La Pomme is defined as the domain, and you defined the following statements for the include and exclude options.
   exclude "...:*.cpp"
   include "La Pomme:Foo:...:*.cpp"
   exclude "La Pomme:Foo:Junk:*.cpp"

The current file being processed is La Pomme:Foo:Dev:test.cpp. The processing follows these steps:

  1. Rule 3 (the last include or exclude statement defined) is checked first because of bottom up processing. The file La Pomme:Foo:Junk:*.cpp does not match the current file name being processed.
  2. Processing moves to Rule 2 and checks. This time, file La Pomme:Foo:...:*.cpp matches the current file name being processed. Processing stops, the option is checked, and it is include.
  3. File La Pomme:Foo:Dev:test.cpp is backed up.

Using Management Classes with Include

When your files are included in a backup or archive, a management class defines how long they are kept on the TSM server, and how many versions of the file the TSM server maintains.

The TSM server administrator selects a default management class which you can override with your own management class.

The following is an example (shown for UNIX) of using a management class:

   exclude /.../*.sno
   include /u/winter/.../*.ice mcweekly
   include /u/winter/december/*.ice mcdaily
   include /u/winter/january/*.ice mcmonthly
   include /u/winter/winter/white.sno

The example above is processed in the following way:

  1. The file named /u/winter/winter/white.sno is backed up because of bottom up processing. Because you did not specify a management class, the file is bound to the default management class.
  2. Any file with an ice extension in the directory /u/winter/january is bound to the management class MCMONTHLY.
  3. Any file with an ice extension in the directory /u/winter/december is bound to the management class MCDAILY.
  4. Any other files with an ice extension in any directory under /u/winter are bound to MCWEEKLY.
  5. Any file with a sno extension (except /u/winter/winter/white.sno) in any directory is excluded from backup.

To specify your own default management class for files that are not explicitly included, specify:

Windows 95, Windows 98, Windows NT, and Windows 2000:
INCLUDE ?:* mgmt_class_name

Macintosh
include "...:*" mgmt_class_name

NetWare
include *:...\* mgmt_class_name

UNIX
include * mgmt_class_name

This must be the first statement in your include-exclude list.

If you archive files with the archive command, you can override the include management class or select the default management class using the archmc option.

To specifically define a management class for backed up directories, use the dirmc option. For details, see Dirmc.


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