![]() |
![]() |
[ | | | ]
Attention |
---|
For current configuration information for the Tivoli Storage Manager program product, refer to the README file that is shipped on the product installation media. |
After successfully installing the Tivoli Storage Manager client, you must configure the client before performing any operations.
Note: If you are upgrading your Tivoli Storage Manager client, it is unnecessary to reconfigure the scheduler, Web client, or other configuration settings. If the dsm.opt and dsm.sys files used by the previous client installation are available in the default installation directory or the directory pointed to by the DSM_CONFIG and DSM_DIR environment variables, Tivoli Storage Manager accesses these files for configuration information.
Required configuration tasks include the following:
Optional configuration tasks include the following:
The phrases root user and Authorized User identify tasks that only root users and Authorized Users can perform. An Authorized User is any user running with a real user ID of 0 (root) or who owns the Tivoli Storage Manager executable with the owner execution permission bit set to s.
Table 14 shows the tasks that can be performed by the root user,
Authorized User, and the non-Authorized User.
Table 14. Root user, Authorized User, and non-Authorized user tasks
Task | Root User | Authorized User | Non-Authorized User |
---|---|---|---|
Install the backup-archive client. | Root users can install the backup-archive client. | Authorized Users cannot install the backup-archive client. | Non-Authorized Users cannot install the backup-archive client. |
Registering new nodes with Tivoli Storage Manager server. | Root users can register new nodes on the Tivoli Storage Manager server. | Authorized Users can register new nodes on the Tivoli Storage Manager server. | Non-Authorized Users cannot register a new node, even when the registration set to open on the server. |
Set or change the Tivoli Storage Manager password for client workstations. | Root users can set or recreate the password file if it is deleted. | Authorized Users can set or recreate the password file if it is deleted, if they have write permission to the file. | Non-Authorized Users cannot set or recreate the password file if it is deleted. |
Create and modify the client system options file (dsm.sys). | Root users can create and modify the dsm.sys file. | Authorized Users can create and modify the dsm.sys file if they have write permission to the file. | Non-Authorized Users do not have access to create or modify the dsm.sys file. |
Create and modify the client user options file (dsm.opt). | Root users can create and modify the dsm.opt file. | Authorized Users can create and modify a default dsm.opt file if they have write permission to the file. | Non-Authorized Users can create and modify a dsm.opt file that they own. |
Create and modify an include-exclude list. | Root users can create and modify an include-exclude list. | Authorized Users can create and modify an include-exclude list. | Non-Authorized Users cannot create and modify an include-exclude list. |
Backup | Root users can back up any file. | Authorized Users can back up files for which they have read permission, regardless of ownership. | Non-Authorized Users can back up only files that they own. |
Restore | Root users can restore any file. When restoring to a new location or same location, files permission and ownership are preserved. | Authorized Users can restore any files (even files backed up by other users). However, only the operating system will prevent writing to the same location if the file has only read permission. Ownership of all restored objects will be changed to Authorized User. | Non-Authorized Users can restore files that they own or files to which they are granted access. The ownership of the restored file will change to the non-Authorized user. |
Archive | Root users can archive any file. | Authorized Users can archive files they have read access to, regardless of ownership. | Non-Authorized Users can archive files they have read access to, regardless of ownership. |
Retrieve | Root users can retrieve any file. When retrieving to a new location or the same location, file permissions and ownership are preserved. | Authorized Users can retrieve any files (even files archived by other users). However, only the operating system will prevent writing to the same location if the file has only read permission. Ownership of all retrieved objects will be changed to Authorized User. | Non-Authorized Users can retrieve any file they archived regardless of the ownership or files to which they are granted access. Ownership of all retrieved objects will be changed to the non-Authorized user. |
Client scheduler | Root users can use the client scheduler to perform scheduled task for a client node. | Authorized Users can use the client scheduler to perform scheduled task for a client node. | Non-Authorized Users cannot use the client scheduler to perform scheduled task for a client node. |
Grant user access to files on the Tivoli Storage Manager server. | Root users can grant user access to files owned by any user on the Tivoli Storage Manager server. | Authorized Users can grant user access to files owned by any user on the Tivoli Storage Manager server. | Non-Authorized Users can grant user access only to files they own on the Tivoli Storage Manager server. |
Delete Tivoli Storage Manager server file spaces. | Root users can delete Tivoli Storage Manager server file spaces if they are granted backup or archive delete authority by a Tivoli Storage Manager server administrator. | Authorized Users can delete Tivoli Storage Manager server file spaces if they are granted backup or archive delete authority by a Tivoli Storage Manager server administrator. | Non-Authorized Users cannot delete Tivoli Storage Manager server file spaces. |
During installation, the sample client system options file dsm.sys.smp is placed in the installation directory.
If you are a root user or authorized user, copy the dsm.sys.smp file to dsm.sys. You must name the client system options file (dsm.sys). It is assumed that the dsm.sys file is controlled by the system administrator.
Attention: If you are reinstalling and you want to keep your existing dsm.sys file intact, do not copy the dsm.sys.smp file to dsm.sys.
Use the client system options file (dsm.sys) to specify one or more servers to contact for services, and communications options for each server. This file can also include authorization options, backup and archive processing options, and scheduling options.
Edit dsm.sys to include the server or servers to which you want to connect. The following is an example of a client system options file stanza which contains the required options for a server you want users to contact. You can specify options for more than one server:
+--------------------------------------------------------------------------------+ | Servername server_a | | COMMmethod TCPip | | TCPPort 1500 | | TCPServeraddress node.domain.company.com | +--------------------------------------------------------------------------------+
As the default, your client node contacts the first server identified in the client system options file (dsm.sys). You can specify a different server to contact by entering the servername option in your own client user options file (dsm.opt), or by entering that option with a command.
You can also specify a default server and a migration server (if you have the HSM client installed on your workstation) in your client system options file (dsm.sys). For more information, see Defaultserver.
The dsm.sys file can also contain the following option categories:
You can modify your client system options file (dsm.sys) using one of the following methods:
If you update the dsm.sys file during a session, you must restart the session to pick up the changes.
See Setting options in an options file for information on how to set options in the dsm.sys file.
During installation, a sample client user options file called dsm.opt.smp is placed in the installation directory.
Copy the dsm.opt.smp file to dsm.opt in your installation directory and modify the required options according to your needs.
This file contains the following options:
See Chapter 9, Using processing options for more information about these options.
If you are a root user, you can create or modify a default client user options file for all users on your workstation. From the UNIX command line:
Attention: If you are reinstalling and you want to keep your existing dsm.opt file intact, do not copy the dsm.opt.smp file to dsm.opt.
We recommend that you use full path names instead of relative path names when you set environment variables.
For the Bourne or Korn shell, enter the DSM_CONFIG variable in the .profile file in your $HOME directory. For example:
DSM_CONFIG=/home/monnett/dsm.opt export DSM_CONFIG
For the C shell, add the DSM_CONFIG variable to the .cshrc file in your $HOME directory. For example:
setenv DSM_CONFIG /home/monnett/dsm.opt
You can then edit your dsm.opt file as appropriate for your system. From the GUI, you can edit this file using the Preferences editor by opening the Edit menu and selecting Preferences. The Preferences editor updates the client configuration files, dsm.opt and dsm.sys, if any options have changed. If you update the dsm.opt file during a session, you must restart the session to pick up the changes.
The Preferences editor uses the environment variable DSM_DIR to locate the client system options file (dsm.sys) and DSM_CONFIG to locate the client user options file (default name dsm.opt). The Preferences editor queries the server for options on the server, but only updates the client options file.
See Setting options in an options file for more information about setting options in a file.
If you are a user and want to use different options than those specified in the default client user options file (dsm.opt), you can create your own client user options file. You can set all the options that can be set in the default user options file.
For example, in the client user options file, you can use the domain option to specify the file systems you want to incrementally back up. The default is all locally mounted file systems except for /tmp.
To create or modify a client user options file, use the following method:
See Setting options in an options file for more information about setting options in a file.
This section describes how to set options in your client system options file (dsm.sys) or client user options file (dsm.opt), and how to use options with commands.
To view or modify an options file, click Edit -> Preferences from the Tivoli Storage Manager client GUI. The Preferences editor updates the client system options file or client user options file.
You can also edit an options file with your favorite text editor.
To set an option in these files, enter the option name and one or more blank spaces, followed by the option value. For example:
compression yes nodename client_a
Some options consist of only the option name, such as verbose and quiet. You can enter the entire option name or its abbreviation. For example, you can specify the verbose option as either of the following:
verbose ve
Follow these additional rules when entering options in your client user options file (dsm.opt):
domain /home /mfg /planning /mrkting /mgmt
If you update the client user options file while a session is active, you must restart the session to pick up the changes.
You can use the query options command to display all or part of your options and their current settings. This command accepts an argument to specify a subset of options. The default is to display all options. See Query Options for more information.
The Tivoli Storage Manager client automatically detects the language of the system locale and displays Tivoli Storage Manager for that language. For example, a French operating system displays Tivoli Storage Manager in French by default. If Tivoli Storage Manager cannot load the French message catalog, it will default to the English (United States) language pack. For example, if the client is running on an unsupported language/locale combination, such as French/Canada or Spanish/Mexico, Tivoli Storage Manager defaults to English (United States).
You can use the LANG environment variable to specify the language for the AIX, HP-UX, Linux, and Solaris clients. For all other UNIX clients, only English (United States) is available.
Tivoli Storage Manager supports the following language
locales:
Languages | AIX | HP-UX | Solaris | All Linux clients |
---|---|---|---|---|
English (United States) | en_US | en_US |
en_US, en_US.ISO8859-1 | en_US |
Simplified Chinese | zh_CN | zh_CN | zh |
zh_CN, |
Traditional Chinese | zh_TW, Zh_TW.BIG5 | zh_TW.eucTW |
zh_TW.EUC, Zh_TW.big5 | zh_TW.big5 |
Czech | cs_CZ | cs_CZ | cs | cs_CZ |
French (Standard) | fr_FR | fr_FR | fr | fr_FR |
German (Standard) | de_DE | de_DE | de | de_DE |
Hungarian | hu_HU | hu_HU | hu | hu_HU |
Italian (Standard) | it_IT | it_IT | it | it_IT |
Japanese | ja_JP, Ja_JP | ja_JP.eucJP | ja, ja_JP.eucJP | ja_JP.eucJP |
Korean | ko_KR | ko_KR | ko | ko_KR |
Polish | pl_PL | pl_PL | pl | pl_PL |
Portuguese (Brazil) | pt_BR | pt_BR | pt | pt_BR |
Russian | ru_RU | ru_RU | ru | ru_RU |
Spanish | es_ES | es_ES | es | es_ES |
To set the LANG environment variable to French, type the following:
export LANG=fr_FR
On the Solaris platform, you also need to export the LC_ALL environment variable.
Notes:
NLSPATH=/usr/dt/lib/nls/msg/%L/%N.cat:$NLSPATH export NLSPATH
If the LANG environment variable is set to C, POSIX (limiting the valid characters to those with ASCII codes less than 128), or other values with limitations for valid characters, the backup-archive client skips files which have file names containing invalid characters with ASCII codes higher than 127.
If you are using a single-byte character set (SBCS) like English as your language environment, all file names are valid and backed up by the backup-archive client. Multi-byte characters are interpreted as a set of single bytes all containing valid characters. If you are using multi-byte character sets (MBCS) as your language environment, the backup-archive client backs up file names that consist of valid characters in the current environment.
For example, a file name consisting of Japanese characters may contain invalid multi-byte characters if the current language environment is a Chinese character set. Files containing invalid multi-byte characters are not backed up and are not shown by the graphical user interface. If such files are found during backup, the dsmerror.log file will list the skipped files.
When using the backup-archive client scheduling mode to back up a whole system, it is strongly recommended to set the LANG environment variable to en_US (or some other SBCS language) to avoid skipped files.
Running the backup-archive GUI outside the CDE desktop could result in errors due to unresolved fonts. Ensure that all required fonts are available for your language environment when running the backup-archive GUI outside the CDE desktop.
When running the backup-archive GUI under Motif, and outside the CDE desktop, add the following entry to the .Xdefaults file in your home directory:
dsm*fontList: -dt-interface system-medium-r-normal-xs*-*-*-*-*-*-*-*-*:
For Linux X86, add the following entries to the .Xdefaults file in your home directory. Remove the ! (exclamation point) in front of the dsm*fontList entry to activate the appropriate locale.
+--------------------------------------------------------------------------------+ |! | |! ja_JP locale | |! | |!dsm*fontList: -adobe-helvetica-medium-r-*--14-*-*-*-*-*-*-*;\ | |! -misc-*-medium-r-*--14-*-*-*-*-*-*-*: | | | |! | |! zh_CN locale | |! | |!dsm*fontList: -*-helvetica-medium-r-normal-*-*-120-*-*-*-*-iso8859-*;\ | |! -isas-fangsong ti-medium-r-normal--16-160-72-72-c-160-gb2312.1980-0&| | | |! | |! zh_TW locale | |! | |!dsm*fontList: -*-helvetica-medium-r-normal-*-*-140-*-*-*-*-iso8859-*;\ | |! -default-ming-medium-r-normal--16-*-*-*-c-160-big5-0: | | | |! | |! ko_KR | |! | |!dsm*fontList: -*-helvetica-medium-r-*-*-*-120-*-*-*-*-iso8859-*;\ | |! -daewoo-mincho-medium-r-normal--16-120-100-100-c-160\ | |! -ksc5601.1987-*;*-r-*: | | | |! | |! ru_RU | |! | |!dsm*fontList: \ | |! -sony_windows_1251-fixed-medium-r-normal--16-120-100-100-c-80-\ | |! microsoft-cp1251 | |! | |! European (de_DE, fr_FR, etc.) | |! | |!dsm*fontList: -*-helvetica-medium-r-normal-*-*-120-*-*-*-*-iso8859-* | +--------------------------------------------------------------------------------+
Generally, setting the environment variables is an optional task. Setting them will make it more convenient for you to use the command line. However, you must set the environment variables if you need to run in either of the following environments:
There are three environment variables you can set which affect Tivoli Storage Manager processing:
When you request an image or a NAS backup or restore, Tivoli Storage Manager uses the DSM_DIR environment variable to locate the corresponding plug-in library. If DSM_DIR is not set, the client will look for the plug-in library in the following directories:
If DSM_CONFIG is not set, the client user options file is expected to satisfy both of these requirements:
However, if DSM_DIR is not set, then dsm.opt is expected in the default installation directory.
If you define DSM_LOG, Tivoli Storage Manager writes messages to the dsmerror.log, dsmwebcl.log, and dsmsched.log files in the directory you specify.
If you define DSM_DIR, but not DSM_LOG, Tivoli Storage Manager writes messages to the dsmerror.log, dsmwebcl.log, and dsmsched.log files in the directory specified by DSM_DIR.
If you do not define DSM_LOG or DSM_DIR, Tivoli Storage Manager writes messages to the dsmerror.log, dsmwebcl.log, and dsmsched.log files in the current directory.
Notes:
For the Bourne or Korn shell, enter the environment variables in the .profile file in your $HOME directory. For example:
DSM_DIR=/home/davehil DSM_CONFIG=/home/davehil/dsm.opt DSM_LOG=/home/davehil export DSM_DIR DSM_CONFIG DSM_LOG
where /home/davehil/dsm.opt is the path and file name for your client user options file, and the /home/davehil directory is where you want to store the dsmerror.log file, executable file, resource files, and dsm.sys file.
For the C shell, add the DSM_CONFIG, DSM_LOG and DSM_DIR variables to the .cshrc file in your $HOME directory. For example:
setenv DSM_DIR /home/davehil setenv DSM_CONFIG /home/davehil/dsm.opt setenv DSM_LOG /home/davehil
where /home/davehil/dsm.opt is the path and file name for your client user options file, and the /home/davehil directory is where you want to store the dsmerror.log file, executable file, resource files, and dsm.sys file.
If you installed the Tivoli Storage Manager client API, set the following environment variables:
Note: End users of applications developed with the API should consult the installation directions for that application for special path names or guidelines for options. Ensure that directories in the environment variables are specified in the path statement. The location of the API library is especially important.
For more information about the Tivoli Storage Manager client API, see IBM Tivoli Storage Manager Using the Application Programming Interface, GC32-0793.
You can use the command line to configure the Web client.
To configure the Web client from the command line, perform the following steps:
dsmc query session
when prompted, enter your user ID and password.
dsmcad
The Tivoli Storage Manager Remote Client Agent daemon must not be started manually. It is automatically started by the Tivoli Storage Manager Client Acceptor daemon when needed.
The only options applicable to the dsmcad program are optfile, httpport, managedservices, and webports. You can use the managedservices option to specify whether the Tivoli Storage Manager Client Acceptor daemon (CAD) also manages the Tivoli Storage Manager scheduler. See Chapter 9, Using processing options for more information about these options.
All Web client messages are written to the Web client log file, dsmwebcl.log. Error messages are written to the error log file dsmerror.log, or the file you specify with the errorlogname option. The dsmwebcl.log and dsmerror.log files reside in the directory you specify with the DSM_LOG environment variable or in the current working directory.
http://your_machine_name:1581
where your_machine_name is the host name of the machine running the Web client.
Port 1581 is the default port number. You can set a different port number using the httpport option. See Httpport for more information.
After installing and configuring the Web client on your workstation you can use the Web client to perform backup, archive, restore, and retrieve operations from any browser with JRE (Java Runtime Environment) 1.3.1 or higher. See Starting a Web client session for more information.
Your Tivoli Storage Manager administrator can schedule Tivoli Storage Manager to perform tasks automatically. For example, you can automatically back up files at the end of each day or archive some of your files every Friday. This procedure, known as central scheduling, is a cooperative effort between the server and your client node. Your administrator associates clients with one or more schedules that are part of the policy domain maintained in the server database. The Tivoli Storage Manager administrator defines central scheduling on the server and you start the client scheduler on your workstation. Once you start the client scheduler, further intervention is not necessary.
With client scheduling, you can also:
See Chapter 7, Automating tasks for more information. See Appendix A, Using the Tivoli Storage Manager central scheduler for supplemental information about the Tivoli Storage Manager central scheduler.
The Tivoli Storage Manager Client Acceptor daemon (CAD) can manage the scheduler. In this case, the CAD serves as an external timer for the scheduler. When the scheduler is started, it queries the server for the next scheduled event. The event is either executed immediately or the scheduler exits. The CAD restarts the scheduler when it is time to execute the scheduled event. This reduces the number of background processes on your workstation and resolves memory retention problems that can occur when running the scheduler service without CAD management. It is recommended that you use the Client Acceptor daemon to manage the client scheduler.
Use the managedservices option in your client system options file (dsm.sys) to specify whether the CAD manages the scheduler. See Managedservices for more information.
Perform the following steps to configure the CAD to manage the client scheduler:
Notes:
To start the client scheduler on your client node and connect to the server schedule, change to the Tivoli Storage Manager installation directory and enter the following command:
dsmc schedule
In most cases, the Tivoli Storage Manager server and clients can work across a firewall. Because every firewall is different, the firewall administrator may need to consult the instructions for the firewall software or hardware in use.
There are two methods for enabling client and server operations through a firewall:
Note: The client may not use the port specified by the tcpadminport option (on the server) for client session. That port may be used for administrative sessions only.
To use the administrative Web interface for a server across a firewall, the Tivoli Storage Manager administrator must open the HTTP port for the server using the httpport option in the server options file. The default HTTP port is 1580.
The Tivoli Storage Manager server must set the SESSIONINITiation parameter on the REGISTER NODE and UPDATE NODE commands for each node. If the server specifies SESSIONINITiation=clientorserver, the default, the client can decide which method to use. If the server specifies SESSIONINITiation=serveronly, all sessions are initiated by the server.
Notes:
A similar problem can occur if an encryption key is required for backup operations. In this case, you can execute the scheduler from the command line (dsmc schedule), wait until a scheduled backup starts, and enter the encryption key when prompted. After the password and encryption key are updated, you must restart the scheduler.
If you set the sessioninitiation option to client, the client will initiate sessions with the server (Method 1) by communicating on the TCP/IP port defined with the server option tcpport. This is the default. Server prompted scheduling may be used to prompt the client to connect to the server.
See Sessioninitiation for more information about the sessioninitiation option.
When using Tivoli Storage Manager across a firewall, please consider the following:
In an enterprise environment, we strongly recommend that you use the Tivoli
Storage Manager Secure Web Administrator Proxy for Web administration of the
Tivoli Storage Manager server. Install the proxy on a Web server that
sits on the firewall so that the Web server can access resources on both sides
of the firewall (this is sometimes called the demilitarized
zone). When you set up the proxy, you can use it to administer
any Tivoli Storage Manager server at Version 3.7 or higher. For
more information on how to install and use the proxy, see the appendix about
the Web proxy in the Tivoli Storage Manager Quick Start manuals listed in Table 15.
Table 15. Tivoli Storage Manager Quick Start publications
Publication title | Order number |
---|---|
IBM Tivoli Storage Manager for AIX Quick Start | GC32-0770 |
IBM Tivoli Storage Manager for HP-UX Quick Start | GC32-0774 |
IBM Tivoli Storage Manager for Linux Quick Start | GC23-4692 |
IBM Tivoli Storage Manager for OS/390 and z/OS Quick Start | GC32-0777 |
IBM Tivoli Storage Manager for OS/400 PASE Quick Start | GC23-4696 |
IBM Tivoli Storage Manager for Sun Solaris Quick Start | GC32-0780 |
IBM Tivoli Storage Manager for Windows Quick Start | GC32-0784 |
Root user or Authorized User
Before you can use Tivoli Storage Manager, your node must be registered with the server. The process of setting up a node name and password is called registration. There are two types of registration: open and closed. Your Tivoli Storage Manager administrator chooses the type of registration for your site.
If you plan to use a Web client, you must have an administrative user ID with system privilege, policy privilege, client access authority, or client owner authority. When a new node is registered, an administrative user ID is automatically created for the node. By default, this node has client owner authority.
With closed registration, a Tivoli Storage Manager administrator must register your workstation as a client node with the server. If your enterprise uses closed registration, you must provide the following information to your Tivoli Storage Manager administrator:
In addition to possibly defining certain options in your options file, your Tivoli Storage Manager administrator defines the following for you:
With open registration, a system administrator can register your workstation as a client node with the server.
The first time you start a session, Tivoli Storage Manager prompts you for information necessary to register your workstation with the server identified in your client options file. You need to supply your node name, a password, and contact information.
When you use open registration:
If necessary, your Tivoli Storage Manager administrator can change these defaults later.
The GUIDs help uniquely identify a particular machine (for reporting purposes), regardless of how many node names are used on the machine or which network adapter is used to connect to the Tivoli Storage Manager server, or which Tivoli Storage Manager servers the nodes connect to. For example, if you use nodes GORDON, DONNA, and DAGORDON to connect to a Tivoli Storage Manager server from your desktop machine, all three nodes will have the same GUID. Similarly, if nodes GORDON, DONNA, and DAGORDON connect to multiple Tivoli Storage Manager servers, each server will show the same GUID for these nodes.
When you install the Tivoli software, the tivguid program is run to generate a GUID which is stored in the /etc/tivoli directory on a UNIX system. The GUID for a client node on the server can change if the host system machine is corrupted, if the file entry is lost, or if a user uses the same node name from different host systems. You can perform the following functions from the command line:
Function | Enter on the command line: |
---|---|
Create and store a new GUID on the host if one does not exist. If a GUID already exists, the current value is displayed. | tivguid -Create |
Display help for the tivguid commands. | tivguid -Help |
Return the value of the current GUID. | tivguid -Show |
Write the GUID that is specified in the -GUID option to the file.
For example, -Write GUID = 'string' uses the value in
'string' rather than creating a new GUID. The string must be
a valid Tivoli GUID (32 hexadecimal values).
This function is useful in the following cases:
|
tivguid -Write -guid=38.70.92.a1.9a.93 .11.d6.a2.f9.00.04.ac.dd.76.38 |
Create a new GUID even if one exists. | tivguid -Write -New |
Authorized User
This is an optional task but an important one. If you do not create an include-exclude list, Tivoli Storage Manager considers all files for backup services and uses the default management class for backup and archive services. For information on management classes and policy domains, see Chapter 8, Understanding storage management policies.
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 from backup services. You can use the query inclexcl command to display a list of include and exclude statements in the order they are examined when determining whether an object is to be included.
Attention: There are some system files that you should exclude. See Excluding system files for more information.
Specify the include-exclude list in your client system options file (dsm.sys). If you define more than one server 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 the client processes include-exclude statements, the include-exclude statements within the include-exclude file are placed at the position occupied by the inclexcl option in dsm.sys, in the same order, and processed accordingly.
See Inclexcl for important detailed information about specifying an include-exclude file using the inclexcl option.
You can use the following method to create an include-exclude list or specify an include-exclude file:
You can create an include-exclude list by performing the following steps:
Note: Each server stanza must have its own include-exclude list.
include /home/usr/includefile.txt exclude /home/usr/.../*
However, in the following include-exclude list the includefile.txt file is backed up:
exclude /home/usr/.../* include /home/usr/includefile.txt
This section provides the following information:
Use exclude.fs and exclude.dir
statements to exclude file spaces and all files and sub-directories in the
specified directory from processing. Tivoli Storage Manager evaluates
all exclude.fs and exclude.dir statements
first (regardless of their position within the include-exclude
list), 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 17. 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. | Exclude options |
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. Using the exclude.dir option is preferable over the standard exclude option to exclude large directories containing many files that you do not want to back up. You cannot use include options to override an exclude.dir statement. Only use exclude.dir when excluding an entire directory branch. | Exclude options |
|After Tivoli Storage Manager evaluates all exclude.fs and
|exclude.dir statements and removes the excluded file spaces
|and directories, Tivoli Storage Manager evaluates any include-exclude
|statements for controlling symbolic link processing
|(exclude.attribute.symlink and
|include.attribute.symlink) against the remaining list
|of objects available for processing. Table 18 defines options for controlling symbolic link
|processing.
|
|Table 18. Options for controlling symbolic link processing
Option | Description | Page |
---|---|---|
exclude.attribute.symlink | Excludes a file or a group of files that are symbolic links from backup processing only. | Exclude options |
include.attribute.symlink | Includes a file or a group of files that are symbolic links within broad group of excluded files for backup processing only. | Include options |
After Tivoli Storage Manager evaluates all exclude.fs,
exclude.dir, exclude.attribute.symlink, and
include.attribute.symlink statements, the following
options are evaluated against the remaining list of objects available for
processing.
Table 19. Options for controlling backup, archive, and image 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 from image backup mounted file systems and raw logical volumes that match the pattern when used with the backup image command. This option is valid for AIX, HP-UX, Solaris, Linux86, Linux IA64, Linux iSeries, and Linux pSeries. | 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 AIX and Solaris clients only. | Exclude options |
include.image | Includes a file space or logical volume, assigns a management class, or allows you to assign one of several image backup processing options to a specific logical volume when used with the backup image command. The backup image command ignores all other include options. This option is valid for AIX, HP-UX, Solaris, Linux86, Linux IA64, Linux iSeries, and Linux pSeries only. | Include options |
include.fs.nas | Use the include.fs.nas option to bind a management class to Network Attached Storage (NAS) file systems. You can also specify whether Tivoli Storage Manager saves Table of Contents (TOC) information during a NAS file system image backup, using the toc option with the include.fs.nas option in your client system options file (dsm.sys). See Toc for more information. This option is valid for AIX and Solaris clients only. | Include options |
After Tivoli Storage Manager evaluates exclude.fs,
exclude.dir, and any other include-exclude options
controlling symbolic links, backup, archive, and image processing, it uses the
following options to determine which files undergo compression and encryption
processing.
Table 20. Options for controlling compression and encryption processing
Option | Description | Page |
---|---|---|
Compression processing | ||
exclude.compression | Excludes files from compression processing if compression=yes is specified. This option applies to backups and archives. | Exclude options |
include.compression | Includes files for compression processing if compression=yes is specified. This option applies to backups and archives. | Include options |
Encryption processing | ||
exclude.encrypt | Excludes files from encryption processing. | Exclude options |
include.encrypt | Includes files for encryption processing. | Include options |
Note: Objects that have a type of rhap and a creator of lcmt will be excluded from processing. Generally, these are special file system objects, but can also be created with the mknod command or are Unix mount points. An entry will be made in the error log indicating which objects have been skipped.
We recommend that you have the following minimum include-exclude list in your include-exclude options file:
exclude /unix/ exclude.dir /unix/ exclude /.../core
These are 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 21. This table applies to include and exclude statements only. For information about using wildcard characters in Tivoli Storage Manager commands, see Using wildcard characters.
Notes:
Table 21. 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 match-n character matches zero or more directories. |
[ | 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. |
\ | 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 treated in this way. For example, if you want to include the ']' in a character class, enter [...\]...]. The escape character removes the usual meaning of ']' as the close character-class character. |
] | The close character-class character ends the enumeration of a character class. |
Table 22 contains examples of ways you might use wildcard characters with include and exclude patterns. For more information about using the exclude.backup option, see Exclude options.
include /u/tmp/save.fil
enter:
include /home/tmp/save.fil
Table 22. Using wildcard characters with include and exclude patterns
Task | Pattern |
---|---|
Exclude all files during backup 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 in 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 any .o file in any directory on the /usr1, /usr2, and /usr3 file systems. |
exclude /usr[1-3]/.../*.o |
Exclude the .o files found in the root directory in the usr2 file system only. |
exclude /usr2/*.o |
Exclude any file that resides under the tmp directory found in any file system. |
exclude /.../tmp/.../* |
Exclude the entire directory structure /var/spool from all processing. |
exclude.dir /var/spool |
Exclude a single file system from backup processing. |
exclude.fs /fs1 |
Exclude all file systems mounted anywhere in the /test/myfs/fs01 and /test/myfs/fs02 directory tree from backup processing. |
exclude.fs /test/myfs/.../* exclude.fs /test/myfs/* |
Exclude the /home/mydir/test1 directory and any files and subdirectories under it. |
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 the raw logical volume from image backup. |
exclude.image /dev/hd0 |
Exclude all symbolic links from backup processing, except those that exist under the /home/spike directory. |
exclude.attribute.symlink /.../* include.attribute.symlink /home/spike/.../* |
The Tivoli Storage Manager server can define include-exclude options using the inclexcl parameter in a client option set. The include-exclude statements specified by the server are evaluated along with those in the client system options file (dsm.sys). 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 system options file (dsm.sys) 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.
When performing an incremental backup, 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 statements for controlling symbolic link processing (exclude.attribute.symlink and include.attribute.symlink) from the bottom up and stops if it finds an include or exclude statement that matches the file it is processing. After the include-exclude statements for controlling symbolic link processing are processed, Tivoli Storage Manager evaluates the remaining 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 9, Using 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 Query Inclexcl for more information.
The client program processes the list of include-exclude statements according to the following rules:
The following examples demonstrate bottom up processing.
exclude *.o include /home/foo/.../*.o exclude /home/foo/junk/*.o
The file being processed is: /home/foo/dev/test.o. Processing follows these steps:
exclude *.obj include /home/foo/.../*.o exclude /home/foo/junk/*.o
The file being processed is: /home/widg/copyit. Processing follows these steps:
exclude /.../*.o include /home/foo/.../*.o exclude /home/foo/junk/*.o
The current file being processed is: /home/lib/objs/printf.o. Processing follows these steps:
| exclude.attribute.symlink /.../* | exclude /.../*.o | include /home/foo/.../*.o | exclude /home/foo/junk/*.o |
|The current file being processed is: |/home/lib/objs/printf.o. Processing follows these steps: |