Tivoli Header

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

Include Options

The include options specify one of the following:

If you do not assign a specific management class to objects, Tivoli Storage Manager uses the default management class in the active policy set of your policy domain.

You can include remotely accessed files by specifying Universal Naming Convention (UNC) names in your include statement. See Excluding Files with UNC Names for example statements using UNC file names.

Notes:

  1. The exclude.dir statements override all include statements that match the pattern.
  2. The include statements are not case sensitive.
  3. The server can also define these options with the inclexcl option.

Compression Processing

If you want to include specific files or groups of files for compression processing during a backup or archive operation, consider the following:

Adaptive Subfile Backup Processing

If you want to include files for adaptive subfile backup processing using the include.subfile option, consider the following:

Processing NAS File Systems

Use the include.fs.nas option to bind a management class to Network Attached Storage (NAS) file systems for backup processing.

A NAS file system specification uses the following conventions:

For example, to assign a management class to the /vol/vol1 file system of a NAS node called netappsj, specify the following include statement:

include.fs.nas netappsj/vol/vol1 nasMgmtClass

See "Creating an Include-Exclude List (Optional)" for more information.

Supported Clients

This option is valid for all Windows clients.

Options File

Place these options in the client options file dsm.opt.

Syntax

>>-options pattern -+----------------+-------------------------><
                    '- mgmtclassname-'
 
 

include, include.backup, include.file
These options are equivalent. Use these options to include files or assign management classes for backup processing.

include.archive
Includes files or assigns management classes for archive processing.

include.compression
Includes files for compression processing if you set the compression option to yes. This option applies to backups and archives.

include.encrypt
Includes the specified files for encryption processing. By default, Tivoli Storage Manager does not perform encryption processing.

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 file servers. The backup nas command ignores all other include statements. This option is for Windows NT, 2000, XP, and Windows.Net clients only.

include.image
Includes a file space or logical volume, or assigns a management class when used with the backup image command. For Windows 2000: When performing a server-free image backup, you must bind the volume to a management class that has a nonblocked destination storage pool; server-free paths must exist between all of the client disk(s), data mover, and storage pool. The backup image command ignores all other include options. This option is valid for Windows 2000 only.

For Windows 2000 only: The include.image option will accept the following values:

imagetype

snapshot
Specifies that you want to perform an online image backup during which the volume is available to other system applications. This is the default if the Logical Volume Snapshot Agent (LVSA) is installed and configured.

static
Specifies that you want to perform an offline image backup during which the volume is locked and unavailable to other system applications.

snapshotcachesize
Specifies the maximum size of the OBF file (Old Blocks File), in which old data blocks are stored during an online image backup. See Snapshotcachesize for more information. Valid for only.

snapshotcachelocation
Specifies the valid path to the location where the LVSA will place OBF file (Old Blocks File) during an online image backup. The default location is x:\tsmlvsa where x: is the system drive. See Snapshotcachelocation for more information.

snapshotfsidlewait
Use this option with the backup image command or the include.image option when performing an online image backup to specify the amount of time that must pass in which there is no write activity on a volume before a snapshot is taken. See Snapshotfsidlewait for more information.

snapshotfsidleretries
Use this option with the backup image command or the include.image option when performing an online image backup to specify the number of additional times the LVSA should try to achieve the Snapshot FS Idle Wait time before the online image backup operation fails. See Snapshotfsidleretries for more information.

presnapshotcmd
Allows you to quiesce an application before the LVSA starts the snapshot during an online image backup. See Presnapshotcmd for more information.

postsnapshotcmd
Allows you to bring up an application after the LVSA starts a snapshot during an online image backup. See Postsnapshotcmd for more information.

imagegapsize
Specifies the minimum size of empty regions in a formatted logical volume that should be skipped during an image backup. See Imagegapsize for more information.

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.systemobject
Assigns management classes for backup of Windows 2000, XP, and Windows.Net 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, XP, and Windows.Net 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.

Parameters

pattern
Specifies the objects to include for backup or archive processing or to assign a specific management class. End the pattern with a file specification.
Note:
For NAS file systems: You must prefix the NAS node name to the file specification to specify the file server to which the include 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 include.image option, the pattern is the name of a file system or raw logical volume.

Note: When using include.systemobject, the only valid pattern is ALL (all types of system objects). By default, Tivoli Storage Manager binds all system objects to the default management class.

mgmtclassname
Specifies the name of the management class to assign to the objects. If a management class is not specified, the default management class is used. For Windows 2000: When performing a server-free image backup, you must bind the volume to a management class that has a nonblocked destination storage pool; server-free paths must exist between all of the client disk(s), data mover, and storage pool.

Examples

Options file:
include c:\proj\text\devel.*
include c:\proj\text\* textfiles
include ?:* managall
include.backup c:\win98\system\* mybackupclass
include.archive c:\win98\system\* myarchiveclass
include.encrypt c:\win98\proj\gordon\*
include.compress c:\test\file.txt
include.subfile c:\test\file.txt
include.image h: MYMC type=snapshot snapshotcachesize=40
include.fs.nas netappsj1/vol/vol0 homemgmtclass
 

Command line:
Does not apply.


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