Tivoli Header
Tivoli Storage Manager for UNIX Backup-Archive Clients Installation and User's Guide
Authorized User
The include options specify one of the following:
- Objects within a broad group of excluded objects that you want to include
for backup, archive, image, and space management services, if you have the HSM
client installed.
- Files within a broad group of excluded files that you want to
include for encryption processing.
- Files within a broad group of excluded files that you want to
include for compression processing.
- Objects to which you want to assign a specific management class and a
management class name.
- A management class to assign to all objects to which you do not explicitly
assign a management class.
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.
Notes:
- The exclude.fs and exclude.dir
statements override all include statements that match the pattern.
- The server can also define these options with the inclexcl
option.
If you want to include specific files or groups of files for compression
processing during a backup or archive operation, consider the following:
- You must set the compression option to yes to enable
compression processing. If you do not specify the
compression option or you set the compression option to
no, Tivoli Storage Manager does not perform compression
processing. See Compression for more information.
- Tivoli Storage Manager processes exclude.fs,
exclude.dir, and other include-exclude statements first.
Tivoli Storage Manager then considers any
include.compression statements. For example, consider
the following include-exclude list:
include.compression /home/jones/proj1/file.txt
exclude /home/jones/proj1/file.txt
Tivoli Storage Manager examines the exclude
/home/jones/proj1/file.txt statement first and determines that
/home/jones/proj1/file.txt is excluded from processing and
is not a candidate for compression processing.
- Include-exclude compression processing is valid for backup and archive
processing only.
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:
- NAS nodes represent a new node type. The NAS node name uniquely
identifies NAS file server and its data to Tivoli Storage Manager. You
can 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 you specify applies to all NAS file
servers.
- Regardless of the client platform, NAS file system specifications use the
forward slash (/) separator, as in this example:
/vol/vol0.
- You cannot use wildcards with include.fs.nas and
exclude.fs.nas statements.
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 UNIX clients.
Options File
Place these options in the client system options file
dsm.sys.
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 AIX,
AIX 5L, and Solaris clients only.
- 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, Solaris, and Linux86 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 for file systems residing on a logical volume created by the
Linux Logical Volume Manager. Valid for Linux86 only.
- dynamic
- Replaces the dependency on the Copy Serialization value in the management
class to perform an image backup without unmounting and remounting the file
system read-only. Use this option only if the volume cannot be
unmounted and re-mounted read-only. Tivoli Storage Manager backs up the
volume as is without remounting it read-only. The backup may
be corrupted if applications write to the volume while the backup is in
progress. This may be corrected by running chkdsk after a
restore. Valid for AIX, AIX5L, Solaris, HP-UX, and Linux86
only.
- static
- Replaces the dependency on the Copy Serialization value in the management
class.Specifies that you want to perform an offline image
backup during which the volume is unmounted and remounted read only.
This is the default for AIX, AIX5L, Solaris, and HP-UX. Valid for AIX,
AIX5L, Solaris, HP-UX, and Linux86 only.
- snapshotcachesize
- Specifies an appropriate snapshot size so that all old data blocks can be
stored during an online image backup. A snapshot size of 100 percent
will ensure a valid snapshot. See Snapshotcachesize for more information. Valid for Linux86
only.
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 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 include.image option, the pattern is the
name of a mounted file system or raw logical volume.
- 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.
Examples
- Options file:
-
include /home/proj/text/devel.*
include /home/proj/text/* textfiles
include * managall
include.image /home/*/*
include.archive /home/proj/text/* myarchiveclass
include.backup /home/proj/text/* mybackupclass
include.compression /home/proj/text/devel.*
include.encrypt /home/proj/gordon/*
include.fs.nas netappsj/vol/vol0 homemgmtclass
include.image /home ALLIMAGES type=snapshot snapshotcachesize=40
- Command line:
-
Does not apply.
[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]