Tivoli Header

Tivoli Storage Manager for Windows Backup-Archive Clients Installation and User's Guide

Using Include-Exclude Options

This section provides the following:

Excluding Directories

Use Exclude.dir statements to exclude all files and sub-directories in the specified directory from processing. Tivoli Storage Manager evaluates all Exclude.dir statements first, and removes the excluded directories and files from the list of objects available for processing. The Exclude.dir statements override all include statements that match the pattern.

Table 4. Option for Excluding Directories

Option Description Page
exclude.fs.nas Excludes file systems on the NAS filer from an image backup when used with the backup nas command. If you do not specify a NAS node name, the file system identified applies to all NAS filers. The backup nas command ignores all other exclude statements including exclude.dir statements. This option is for Windows NT, 2000, XP, and .NET clients only. Exclude Options
exclude.dir Excludes a directory, its files, and all its subdirectories and their files from backup processing. For example, exclude.dir c:\test\dan\data1 excludes c:\test\dan\data1, its files, and all its subdirectories and their files.

However, you can still back up c:\test\dan\data1, its files, and all its subdirectories and their files using a selective backup, as follows:

  dsmc sel -subdir=yes c:\test\dan\data1\

However, the next time you perform an incremental backup, these backup versions are expired. If you exclude a directory that was previously included, Tivoli Storage Manager marks existing backup versions of the files and directories beneath it inactive during the next incremental backup. Use this option to exclude a portion of your data in which no underlying files need to be backed up. The Tivoli Storage Manager Client API does not support this option.

Note:
If you define an exclude statement without using a drive letter, such as exclude.dir dirname, this will exclude from processing any directory named dirname on any drive.
Exclude Options

Controlling Backup, Archive, Image, and System Object Processing

After Tivoli Storage Manager evaluates all exclude.dir statements, the following options are evaluated against the remaining list of objects available for processing.

If you exclude an object that was previously included, Tivoli Storage Manager marks existing backup versions inactive during the next incremental backup.

Table 5. Options for Controlling Backup, Archive, Image, and System Object Processing

Option Description Page
Backup Processing
exclude
exclude.backup
exclude.file
exclude.file.backup
These options are equivalent. Use these options to exclude a file or group of files from backup services. Exclude Options
include
include.backup
include.file
These options are equivalent. Use these options to include files or assign management classes for backup processing. Include Options
Archive Processing
exclude.archive Excludes a file or group of files from archive services. Exclude Options
include
include.archive
These options are equivalent. Use these options to include files or assign management classes for archive processing. Include Options
Image Processing
exclude.image Excludes mounted file systems and raw logical volumes that match the pattern from image processing. This option is valid for Windows 2000. Exclude Options
exclude.fs.nas Excludes file systems on the NAS filer from an image backup when used with the backup nas command. If you do not specify a NAS node name, the file system identified applies to all NAS filers. The backup nas command ignores all other exclude statements including exclude.dir statements. This option is for Windows NT and Windows 2000 clients only. Exclude Options
include.image Includes a file space or logical volume, assigns a management class, or allows you to assign one of several image backup processing options to a specific logical volume when used with the backup image command. The backup image command ignores all other include options. This option is valid for Windows 2000 only. Include Options
include.fs.nas Assigns a management class when used with the backup nas command. If you do not specify a NAS node name, the file system identified applies to all NAS filers. The backup nas command ignores all other include statements. This option is for Windows NT and Windows 2000 clients only. Include Options
System Object Processing
include.systemobject Assigns management classes for backup of Windows 2000 system objects. By default, Tivoli Storage Manager binds all system objects to the default management class. You cannot use this option to bind individual systemobject components to a different management class. You cannot use this option to include or exclude a system object from processing. This option is valid for Windows 2000 only.
Note:
Other include-exclude statements do not affect system object processing. It is unnecessary to explicitly include the registry staging directory include c:\adsm.sys\...\* for back up, to ensure that the registry is backed up properly. If you accidently exclude a directory that is critical to a system object backup, the system object backup is not affected.
Include Options

Controlling Compression, Encryption, and Subfile Processing

After Tivoli Storage Manager evaluates Exclude.dir and any other include-exclude options controlling backup, archive, image, and system objects, it uses the following options to determine which files undergo compression, encryption, or subfile processing.

Table 6. Options for Controlling Compression, Encryption, and Subfile Processing

Option Description Page
Compression Processing
exclude.compression Excludes files from compression processing if compression=yes is specified. This option applies to backups and archives. Exclude Options
include.compression Includes files for compression processing if compression=yes is specified. This option applies to backups and archives. Include Options
Encryption Processing
exclude.encrypt Excludes files from encryption processing. Exclude Options
include.encrypt Includes files for encryption processing. Include Options
Adaptive Subfile Backup Processing
exclude.subfile Excludes files from adaptive subfile backup processing. This option does not apply to archive processing. This option is valid for all Windows clients. Exclude Options
include.subfile Includes files for adaptive subfile backup processing. This option does not apply to archive processing. This option is valid for all Windows clients. Include Options

Excluding System Files

We recommend that you have the following minimum include-exclude list in your client options file (dsm.opt):

Windows Me list:
 
   exclude "*:\...\ea data. sf"
   exclude "*:\...\pagefile.sys"
   exclude "*:\...\ibmbio.com"
   exclude "*:\ibmdos.com"
   exclude "*:\msdos.sys"
   exclude "*:io.sys"
   exclude.dir *:\recycled
   exclude.dir *:\recycler
   exclude "*:\...\system32\config\*.*
   exclude "*:\...\system32\config\...\*
 
Windows Me, NT, 2000, XP, Windows.NET list:
 
    exclude "*:\...\pagefile.sys"
    exclude "*:\...\ea data. sf"
   exclude "*:\...\system32\config\*.*
   exclude "*:\...\system32\config\...\*
   exclude.dir *:\recycled
   exclude.dir *:\recycler
   exclude "*:\microsoft uam volume\*"
   exclude "*:\microsoft uam volume\*.*"
   exclude "*:\microsoft uam volume\...\*"
   exclude "*:\microsoft uam volume\...\*.*"
   exclude *:\...\system32\perf*.dat
 

These are system files that cannot be recovered without possibly corrupting the operating system. If subfile backup is being used, the directory containing cache files should be excluded with exclude.dir. 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 Tivoli Storage Manager backs them up in the file spaces used by these programs. If you do back up these large files, your communication session might time out before Tivoli Storage Manager finishes sending the files. Consult your disk compression documentation for the file names or enter the following command to look for hidden files:

   dir \ /s /a:h

Excluding Files with UNC Names

You can exclude remotely accessed files by specifying their universal naming convention (UNC) names in your exclude statement. 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 that have an extension of .txt. You could use either of the following commands:

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

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

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

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 Tivoli Storage Manager commands, see Using Wildcard Characters.

Table 7. 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. 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. 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. For example, if you wish to include the ']' in a character class, enter [...\]...]. The escape character removes the usual meaning of ']' as the close character-class character.
] 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 8 contains examples of ways you might use wildcard characters with include and exclude patterns.

You cannot use wildcard characters with the include.fs.nas and exclude.fs.nas options.

Table 8. Using Wildcard Characters with Include and Exclude Patterns

Task Pattern
Exclude all files during backup 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 in 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 for backup 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 in any file space on any drive.
exclude ?:tmp\...\*
Exclude the c:\mydir\test1 directory and any files and subdirectories under it.
exclude.dir c:\mydir\test1
Exclude all directories under the \mydir directory with names beginning with test.
exclude.dir c:\mydir\test*
Exclude all directories directly under the \mydir directory with names beginning with test, on any drive.
exclude.dir ?:\mydir\test*
Exclude the raw logical volume from image backup.
exclude.image c:\*
Exclude all directories and files on the local drives, except the c: drive.
exclude     [abd-z]:\...\*
exclude.dir [abd-z]:\...\*


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