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. Tivoli Storage Manager backs up any file that is not explicitly excluded. You should exclude Tivoli Storage Manager client directories or folders (Macintosh) from backup services.
For Windows, NetWare, and Macintosh: Specify your include-exclude list in your client options file or Preferences file. This list can also contain include-exclude statements obtained from include-exclude files which you specify with the inclexcl option. For Windows: The include-exclude statements are not case sensitive.
For Windows NT or 2000 clients: The include-exclude file can be in Unicode or non-Unicode format. If you specify a non-Unicode include-exclude file, the file must be in the same code page that the client is running.
For UNIX: Specify the include-exclude list in your client system options file (dsm.sys). If you have more than one server defined in your dsm.sys file, each server must have its own include-exclude list. This list can also contain include-exclude statements obtained from the include-exclude files you specify with the inclexcl option.
When processing occurs, the include-exclude statements within the include-exclude file are placed at the position occupied by the inclexcl option in dsm.opt and processed accordingly.
See Inclexcl for detailed information about specifying an include-exclude file using the inclexcl option.
You can use one of the following methods to create an include-exclude list or specify an include-exclude file:
You can also create an include-exclude list by performing the following steps:
Note: For UNIX: Each server stanza must have its own include-exclude list.
For Windows NT and Windows 2000 Unicode-enabled clients, the include-exclude file can be in Unicode or non-Unicode format. If you specify a non-Unicode include-exclude file, that file must be in the same code page the client is running.
A Unicode include-exclude file provides the following benefits:
To create an include-exclude file in Unicode format, perform the following steps:
This section provides the following:
Use exclude.fs and exclude.dir
statements to exclude file spaces and directories from processing.
Tivoli Storage Manager evaluates all exclude.fs and
exclude.dir statements first, and removes the
excluded file spaces, directories, and files from the list of objects
available for processing. The exclude.fs and
exclude.dir statements override all include statements that
match the pattern.
Table 7. Options for Excluding File Spaces and Directories
Option | Description | Page |
---|---|---|
exclude.fs | Excludes file spaces matching the pattern. The client does not consider the specified file space for processing and the usual deleted-file expiration process cannot occur. If you exclude a file space that was previously included, existing backup versions remain on the server subject to retention rules specified in the associated management class definition. See Exclude Options for more information. This option is valid for UNIX clients only. | 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.fs and exclude.dir statements. This option is for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only. | Exclude Options |
exclude.dir | Excludes a directory, its files, and all its subdirectories and their
files from backup services. The exclude.dir option
works only if the excluded directory is a subdirectory. Use this option
to exclude a portion of your data in which no underlying files need to be
backed up.
When you exclude a directory, you can still back up specific files within that directory using a selective backup. 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 inactive during the next incremental backup. | Exclude Options |
After Tivoli Storage Manager evaluates all exclude.fs and 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 8. 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 and space management services (if the HSM client is installed). The exclude.backup option only excludes files from normal backup, but not from HSM. | 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 AIX, AIX 5L, HP-UX, and Solaris only. | 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.fs and exclude.dir statements. This option is for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only. | Exclude 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, AIX 5L, HP-UX, and Solaris clients 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, Windows 2000, AIX, AIX 5L, and Solaris 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.
| Include Options |
After Tivoli Storage Manager evaluates exclude.fs,
exclude.dir, and all other include-exclude statements,
the following options are evaluated against the remaining list of objects
available for processing.
Table 9. 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. | Exclude Options |
include.compression | Includes files for compression processing if compression=yes is specified. | Include Options |
Encryption Processing | ||
exclude.encrypt | Excludes files from encryption processing. This option is valid for Windows, UNIX, and NetWare clients. | Exclude Options |
include.encrypt | Includes files for encryption processing. This option is valid for Windows, UNIX, and NetWare clients. | Include Options |
Adaptive Subfile Backup Processing | ||
exclude.subfile | Excludes files from adaptive subfile backup processing. This option is valid for all Windows clients. | Exclude Options |
include.subfile | Includes files for adaptive subfile backup processing. This option is valid for all Windows clients. | Include Options |
We recommend at least the following minimum include-exclude lists:
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"
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.*
exclude /unix exclude /.../core exclude /.../.SpaceMan/.../*
If you are using AFS, also specify:
exclude /usr/vice/cache/* exclude /var/vice/cache/*
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.dir *:\recycled exclude.dir *:\recycler exclude.dir *:\...\system32\wins exclude.dir *:\...\system32\LServer exclude.dir *:\...\system32\dhcp exclude.dir *:\...\system32\config exclude.dir "*:\system volume information" exclude *:\...\system32\perflib*.dat exclude.dir "*:\...\temporary internet files" exclude "*:\documents and settings\...\ntuser.dat.LOG" exclude "*:\documents and settings\...\ntuser.dat" exclude "*:\documents and settings\...\usrclass.dat.LOG" exclude "*:\documents and settings\...\usrclass.dat"
These files are all system files that cannot be recovered without possibly corrupting the operating system.
To specify groups of files that you want to include or exclude, use the
wildcard characters listed in Table 10. This table applies to include and
exclude statements only. For information about
using wildcard characters in Tivoli Storage Manager commands, see the
individual Tivoli Storage Manager client publications.
Table 10. 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 match-all character. For example:
|
[ | 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 98, Me, NT, and 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 the drive letter or drive name
from the rest of the 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.
|
| 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, 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. Tivoli Storage Manager 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 |
Table 11. Using Wildcard Characters with Include and Exclude Patterns
Task | Pattern |
---|---|
Windows 98, Me, NT, and 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]:* |
Exclude the c:\mydir\test1 directory. |
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 all files in all directories on all drives (local, remote, and removable). |
exclude ?:\...\* |
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 |
Exclude the servera\volumed:mydir/test1 directory. |
exclude.dir servera\volumed:mydir/ test1 |
Exclude all directories under the mydir directory with names beginning with test. |
exclude.dir servera\volumed:mydir/ test* |
Exclude all directories directly under the mydir directory with names beginning with test, on any volume). |
exclude.dir servera\*:mydir/test* |
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 the /home/mydir/test1 directory. |
exclude.dir /home/mydir/test1 |
Exclude all directories under the /home/mydir directory with names beginning with test. |
exclude.dir /home/mydir/test* |
Exclude all directories directly under the /mydir directory with names beginning with test, on any file system. |
exclude.dir /.../mydir/test* |
Exclude any .obj file in any directory on the /usr1, /usr2, and /usr3 file systems. |
exclude /usr[1-3]/.../*.obj |
Exclude the raw logical volume from image backup. |
exclude.image /dev/hd0/*/* |
Exclude these file systems from backup processing: /test/myfs/fs01 and /test/myfs/fs02. |
exclude.fs /test/myfs/.../* exclude.fs /test/myfs/* |
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.
If the client options file (Windows, NetWare), client system options file (UNIX), or Preferences file (Macintosh) include-exclude list contains one or more inclexcl options that specify include-exclude files, the include-exclude statements in these files are placed in the list position occupied by the inclexcl option and processed accordingly.
Tivoli Storage Manager evaluates all exclude.fs and exclude.dir statements first, and removes the excluded file spaces, directories, and files from the list of objects available for processing. See "Excluding File Spaces and Directories" and Exclude Options for more information about the exclude.fs and exclude.dir options.
After evaluating all exclude.fs and exclude.dir statements, Tivoli Storage Manager evaluates 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 entered 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.
To display a list of all include-exclude statements in effect on your client workstation in the actual order they are processed, use the query inclexcl command. See the Tivoli Storage Manager client publications for more information.
The client program processes the include and exclude options as follows:
The following examples demonstrate bottom up processing.
exclude ?:\*.obj include c:\foo\...\*.obj exclude c:\foo\junk\*.obj
The file being processed is: c:\foo\dev\test.obj. Processing follows these steps:
exclude *.obj include /home/foo/.../*.obj exclude /home/foo/junk/*.obj
The file being processed is: /home/widg/copyit.bat. Processing follows these steps:
exclude servera\*:*.obj include servera\data:foo/.../*.obj exclude servera\data:foo/junk/*.obj
The current file being processed is: servera\data:foo/dev/test.obj. Processing follows these steps:
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:
When your files are included in a backup or archive, a management class defines how long they are kept on the server and how many versions of the file the server maintains.
The server administrator selects a default management class which you can override with your own management class.
The following is a UNIX example 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:
To specify your own default management class for files that are not explicitly included, specify:
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.