Tivoli Storage Manager for Macintosh 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 folders 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 section.

You can also create an include-exclude list by selecting Utilities> Setup Assistant 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. Open your Preferences file with SimpleText or another Macintosh text editor.
  3. Locate the include-exclude section in your Preferences file.
  4. Enter your include and exclude statements using the appropriate include-exclude options in Table 6. 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.
  5. Save the file and close it.
  6. Restart TSM with your new Preferences file.

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

Table 6. 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.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.file Includes a file for backup services, or assigns a management class to a file. Include Options

Excluding System Files

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

   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"

These are system files that cannot 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 7. This table applies to include and exclude statements only. For information about using wildcard characters in a file specification, see Using Wildcard Characters.

Table 7. Wildcard and Other Special Characters

Character Function
? The match-one character matches any single character except the folder 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. (See Matchonechar). 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.
 ...: 

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

The volume or folder separator. It limits the scope of search for matching all characters and matching all volumes.

[ 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.
Note:For ASCII machines such as the Macintosh, characters represented by the hexadecimal codes of 61 (a) through 7A (z) will match. If the last character in the range is less than the first, only the first is used.
\ 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.

Examples Using Wildcards With Include and Exclude Patterns

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

Table 8. Using Wildcard Characters with Include and Exclude Patterns

Task Pattern
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"

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

Match the .cpp files found in the root folder of the Vol2 volume.
exclude "Vol2:*.cpp"

Match any file found on any volume that resides under the Development folder.
exclude "...:Development:...:*"


Processing Include and Exclude Options

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

  1. Folders are not checked; files are checked. Therefore, if you have a volume (such as La Pomme) defined using the domain option, all folders of that volume are backed up regardless of what you defined for your include and exclude options, even if the files in those folders are not backed up.
  2. Options are checked from the bottom of the include-exclude list up, until a match is found. However, an exclude.dir statement takes precedence over other include-exclude statements.

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

Example 2
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:Widget:Sample File. The 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 La Pomme:Widget:Sample File is implicitly included and is backed up.

Example 3
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:Lib:Src:Module1.cpp. The 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 La Pomme:Lib:Src:Module1.cpp is not backed up.


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