Exclude options

Use the exclude options to exclude objects from backup, image, or archive services.

Windows operating systemsFor example, you might want to exclude this type of information:

Windows operating systems
  • All temporary files
  • Any local caches of network files
  • All files that contain compiled object code that you can easily reproduce using other methods
  • Your operating system files

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsFor example, you might want to exclude this type of information:

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systems
  • All temporary files
  • Any local caches of network files
  • All files that contain compiled object code that you can easily reproduce using other methods
  • Your operating system files

You can exclude specific files from encryption processing during a backup.

Windows operating systemsYou can exclude remotely accessed files by specifying Universal Naming Convention (UNC) names in your exclude statement.

Note:
  1. Windows operating systemsWhen you exclude a file that was previously included, existing backup versions become inactive during the next incremental backup.
  2. AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsWith the exception of exclude.fs, when you exclude a file that was previously included, existing backup versions become inactive during the next incremental backup.
  3. Windows operating systemsThe exclude statements are not case sensitive.
  4. The server can define exclude options with the inclexcl option.
  5. Windows operating systemsAs with other include-exclude statements, you can use the inclexcl option to specify a file that can be in Unicode format, containing exclude statements with file names in Unicode.

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsWindows operating systemsExclude any system files or images that could corrupt the operating system when recovered. Also exclude the directory containing the Tivoli® Storage Manager client files.

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsTo exclude an entire directory called /any/test, enter the following:

Windows operating systemsTo exclude an entire directory called any\test, enter the following:

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systems
  exclude.dir /any/test
Windows operating systems
  exclude.dir c:\any\test

Windows operating systemsTo exclude subdirectories that begin with test under the any directory, enter the following:

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsTo exclude subdirectories that begin with test under the /any directory, enter the following:

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systems
  exclude.dir /any/test*
Windows operating systems
  exclude.dir c:\any\test*
Windows operating systemsNote: Defining an exclude statement without using a drive letter, such as exclude.dir code, excludes the code directory on any drive from processing.
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsWindows operating systems

Supported Clients

This option is valid for all clients.

Options File

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsPlace this option in the dsm.sys file within a server stanza. You can set these options on the Include-Exclude tab, Define Include-Exclude Options section of the Preferences editor.

Windows operating systemsPlace these options in the client options file (dsm.opt). You can set these options on the Include-Exclude tab, Define Include-Exclude Options section of the Preferences editor.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-options-- --pattern-----------------------------------------><

Windows operating systemsexclude, exclude.backup, exclude.file, exclude.file.backup
Windows operating systemsUse these options to exclude a file or group of files from backup services.
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsexclude, exclude.backup, exclude.file, exclude.file.backup
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsUse 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.archive
Excludes a file or a group of files that match the pattern from archive services only.
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsexclude.attribute.symlink
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsExcludes a file or a group of files that are symbolic links or aliases (aliases apply to Mac OS X) from backup processing only.
Mac OS X operating systemsNote: For Mac OS X aliases are excluded.
exclude.compression
Excludes files from compression processing if the compression option is set to yes. This option applies to backups and archives.
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsWindows operating systemsexclude.dedup
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsWindows operating systemsExcludes files from client-side data deduplication. To control a client-side data deduplication operation, specify ieobjtype as the value of the exclude.dedup option.
Valid ieobjtype parameters are:
  • File
  • AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsImage
  • Windows operating systemsSYSTEMState
  • Windows operating systemsAsr

The default is File.

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsexclude.dir
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsExcludes a directory, its files, and all its subdirectories and their files from backup processing. For example, the statement exclude.dir /test/dan/data1 excludes the /test/dan/data1 directory, its files, and all its subdirectories and their files.

If you exclude a directory that was previously included, Tivoli Storage Manager expires existing backup versions of the files and directories beneath it during the next incremental backup. Use this option to exclude a portion of your data that has no underlying files to back up.

Note: Avoid performing a selective backup, or a partial incremental backup, of an individual file within an excluded directory. The next time that you perform an incremental backup, any files backed up in this manner is expired.
Windows operating systemsexclude.dir
Windows operating systemsExcludes a directory, its files, and all its subdirectories and their files from backup processing. For example, the statement exclude.dir c:\test\dan\data1 excludes the c:\test\dan\data1 directory, its files, and all its subdirectories and their files.

If you exclude a directory that was previously included, Tivoli Storage Manager expires existing backup versions of the files and directories beneath it during the next incremental backup. Use this option to exclude a portion of your data that has no underlying files to back up.

Note: Avoid performing a selective backup, or a partial incremental backup, of an individual file within an excluded directory. The next time that you perform an incremental backup, any files backed up in this manner is expired.
Note: Defining an exclude statement without using a drive letter, such as exclude.dir code, excludes the code directory on any drive from processing.
exclude.encrypt
Excludes the specified files from encryption processing. This option does not affect whether files are excluded from backup or archive processing, only whether they are excluded from encryption processing.
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsexclude.fs
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsExcludes file systems that match the specified pattern from backup, incremental image backup, and archive operations. If files from the excluded file systems were ever backed up, then management class rebinding and deleted file expiration does not occur. However, existing backup versions remain on the server subject to associated management class settings. The files that were previously archived from the excluded file system remain on the server as archive copies.

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsThe exclude.fs option does NOT prevent the backup or archive of any virtual mount points that are subdirectories of the excluded file system.

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsUse exclude.image to exclude file systems from full image backup operations.

AIX operating systemsOracle Solaris operating systemsexclude.fs.nas
AIX operating systemsOracle Solaris operating systemsExcludes file systems on the NAS file server from an image backup when used with the backup nas command. The NAS node name must be prefixed to the file system name, for example: netappsj1/vol/vol1. To apply the exclude to all NAS nodes, replace the NAS node name with a wildcard, for example: */vol/vol1. The backup nas command ignores all other exclude statements including exclude.fs and exclude.dir statements. This option is valid for AIX® and Solaris clients only.
Windows operating systemsexclude.fs.nas
Windows operating systemsExcludes file systems on the NAS file server from an image backup when used with the backup nas command. The NAS node name must be prefixed to the file system name, for example: netappsj1/vol/vol1. To apply the exclude to all NAS nodes, replace the NAS node name with a wildcard, for example: */vol/vol1. The backup nas command ignores all other exclude statements including exclude.dir statements. This option is valid for all Windows clients.
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsexclude.image
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systems Excludes mounted file systems and raw logical volumes that match the specified pattern from full image backup operations. This option is valid for AIX, HP-UX, all Linux clients, and Solaris only. Use exclude.fs to exclude file systems from incremental image backup operations.
Restriction: This option does not apply to Mac OS X.
Windows operating systemsexclude.subfile
Windows operating systemsExcludes files from adaptive subfile backup processing. This option does not apply to archive processing.
Windows operating systems
Table 1. System services components and corresponding keywords
Component Keyword
Background Intelligent Transfer Service BITS
Event log EVENTLOG
Removable Storage Management RSM
Cluster Database CLUSTERDB
Remote Storage Service RSS
Terminal Server Licensing TLS
Windows Management Instrumentation WMI
Internet Information Services (IIS) metabase IIS
DHCP database DHCP
Wins database WINSDB

Parameters

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemspattern
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systemsSpecifies the file or group of files that you want to exclude.
Note: For NAS file systems: You must prefix the NAS node name to the file specification to specify the file server to which the exclude statement applies. If you do not specify a NAS node name, the file system identified refers to the NAS node name specified in the client system-options file (dsm.sys) or on the command line.

If the pattern begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks.

AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsFor the exclude.image option, the pattern is the name of a mounted file system or raw logical volume.

Windows operating systemspattern
Windows operating systemsSpecifies the file or group of files that you want to exclude.
Note: For NAS file systems: You must prefix the NAS node name to the file specification to specify the file server to which the exclude statement applies. If you do not specify a NAS node name, the file system identified refers to the NAS node name specified in the client options file (dsm.opt) or on the command line.

If the pattern begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks.

  • For the exclude.image option, the pattern is the name of a file system or raw logical volume.

Examples

Options file:
AIX operating systemsHP-UX operating systemsLinux operating systemsOracle Solaris operating systemsMac OS X operating systems
exclude /unix/
exclude /.../core
exclude /home/jones/proj1/*
exclude.archive /.../core
exclude.backup /home/jones/proj1/devplan/
exclude.dir /home/jones/tmp
exclude.backup /users/home1/file1
exclude.image /usr/*/*
exclude.encrypt /users/home2/file1
exclude.compression /home/gordon/proj1/*
exclude.fs.nas netappsj/vol/vol0
exclude.attribute.symlink /.../*
exclude.dedup /Users/Administrator/Documents/Important/.../*
Windows operating systems
exclude ?:\...\swapper.dat 
exclude "*:\ea data. sf" 
exclude ?:\io.sys 
exclude ?:\...\spart.par 
exclude c:\*\budget.fin 
exclude c:\devel\* 
exclude.dir c:\home\jodda 
exclude.archive c:\home\*.obj
exclude.encrypt c:\system32\mydocs\*
exclude.compression c:\test\file.txt
exclude.subfile c:\test\file.txt
exclude.fs.nas  netappsj/vol/vol0
exclude.dedup c:\Users\Administrator\Documents\Important\...\*
exclude.dedup e:\*\* ieobjtype=image
exclude.dedup ALL ieobjtype=systemstate
exclude.dedup ALL ieobjtype=ASR
Command line:
Does not apply.