Exclude options
Use the exclude options to exclude objects from backup, image, or archive services.
- 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
- 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.
You can exclude remotely accessed files by specifying Universal Naming Convention (UNC) names in your exclude statement.
- When you exclude a file that was previously included, existing backup versions become inactive during the next incremental backup.
- With the exception of exclude.fs, when you exclude a file that was previously included, existing backup versions become inactive during the next incremental backup.
- The exclude statements are not case sensitive.
- The server can define exclude options with the inclexcl option.
- As 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.
Exclude any system files or images that could corrupt the operating system when recovered. Also exclude the directory containing the IBM Spectrum Protect client files.
To exclude an entire directory
called /any/test
, enter the following:
To exclude an entire directory called any\test
,
enter the following:
exclude.dir /any/test
exclude.dir c:\any\test
To exclude subdirectories that begin with test
under
the any
directory, enter the following:
To exclude subdirectories
that begin with test
under the /any
directory,
enter the following:
exclude.dir /any/test*
exclude.dir c:\any\test*
exclude.dir code
, excludes the code
directory
on any drive from processing.Supported Clients
This option is valid for all clients.
Options File
Place this option in the client system-options file (dsm.sys) within a server stanza. You can set these options on the Include-Exclude tab, Define Include-Exclude Options section of the Preferences editor.
Place 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
- exclude, exclude.backup, exclude.file, exclude.file.backup
- Use these options to exclude a file or group of files from backup services.
- exclude, exclude.backup, exclude.file, exclude.file.backup
- 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.archive
- Excludes a file or a group of files that match the pattern from archive services only.
- exclude.attribute.symlink
- Excludes a file or a group of files that are symbolic links or
aliases (aliases apply to Mac OS X) from backup processing only. Note: 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.
- exclude.dedup
- Excludes 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
- Image
- SYSTEMState
- Asr
The default is File.
- exclude.dir
- Excludes 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, the server 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. - exclude.dir
- Excludes 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 thec:\test\dan\data1
directory, its files, and all its subdirectories and their files.If you exclude a directory that was previously included, the server 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 asexclude.dir code
, excludes thecode
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.
- exclude.fs
- Excludes 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.
The exclude.fs option does NOT prevent the backup or archive of any virtual mount points that are subdirectories of the excluded file system.
Use exclude.image to exclude file systems from full image backup operations.
- exclude.fs.nas
- Excludes 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. - exclude.fs.nas
- Excludes 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. - exclude.image
- Excludes mounted file systems and raw logical volumes that match the specified pattern from
full image backup operations. This option is valid for AIX, 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.
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
- pattern
- Specifies 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.
For the exclude.image option, the pattern is the name of a mounted file system or raw logical volume.
- pattern
- Specifies 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:
-
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/.../*
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.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.