Tivoli Storage Manager AFS/DFS Backup Clients


Setting Processing Options

This chapter provides information about AFS/DFS options for AFS/DFS file backup clients. The table below lists the processing options, their function, and where to go to in this book for more information. For all other options, please refer to TSM for UNIX Using the Backup-Archive Clients.

Table 6. Processing Options

Option Function Page
afsbackupmntpnt Specifies whether you want TSM to see an AFS mount point as a mount point or as a directory. afsbackupmntpnt
dfsbackupmntpnt Specifies whether you want TSM to see a DFS mount point as a mount point or as a directory. dfsbackupmntpnt
dfsinclexcl Specifies the path and file name of your DFS include-exclude options file. dfsinclexcl
domain Specifies the file systems you want to include in your client domain for incremental backup. domain
exclude Excludes files, directories, and file systems from TSM backup services. exclude
virtualmountpoint Defines a virtual mount point for a file system if you want TSM to consider files for backup beginning with a specific directory within that file system. Virtualmountpoint

afsbackupmntpnt

Root User

The afsbackupmntpnt option specifies whether you want TSM to see an AFS mount point as a mount point or as a directory. If TSM sees it as a mount point, it backs up only the name of the mounted volume during a backup operation. It does not back up the subtree by starting from the mount point directory.

Options File

This option is placed in the client system options file or the client user options file. It is valid only when you use dsmafs and dsmcafs.

Syntax

                     .-yes-.
>>-AFSBackupmntpnt-+-+-----+--+--------------------------------><
                   '-no-------'
 

Parameters

yes
If you choose yes, the afsbackupmntpnt option views all AFS mount points as mount points. TSM backs up only the mount point information (the name of the mounted volume) for any mount point it encounters during a backup operation. This is the default.

no
If you choose no, the afsbackupmntpnt option views all AFS mount points as directories. TSM backs up the contents of files and subdirectories of any mount point it encounters during a backup operation.

Examples

Options file:
afsbackupmntpnt no

Command line:
Not applicable

dfsbackupmntpnt

Root User

The dfsbackupmntpnt option specifies whether you want TSM to see a DFS mount point as a mount point or as a directory. If TSM sees it as a mount point, it backs up only the name of the mounted fileset during a backup operation. It does not back up the subtree by starting from the mount point directory.

Options File

This option is placed in the client system options file or the client user options file. It is valid only when you use dsmdfs and dsmcdfs.

Syntax

                       .-yes-.
>>-DFSBackupmntpnt-+- -+-----+--+------------------------------><
                   '- no--------'
 

Parameters

yes
If you choose yes, the dfsbackupmntpnt option views all DFS mount points as mount points. TSM backs up only the mount point information (the name of the mounted fileset) for any mount point it encounters during a backup operation. This is the default.

no
If you choose no, the dfsbackupmntpnt option views all DFS mount points as directories. TSM backs up the contents of files and subdirectories of any mount point it encounters during a backup operation.

Examples

Options file:
dfsbackupmntpnt no

Command line:
Not applicable

dfsinclexcl

Root User

If you use a DFS include-exclude options file, the dfsinclexcl option specifies the path and file name. You can use a DFS include-exclude options file to exclude DFS files or directories from backup. And to assign different management classes to specific files or groups of files.

A DFS include-exclude options file that the dfsinclexcl option points to is used only when DFS files are examined for backup.

Note:A separate DFS include-exclude options file is required because the prefix /... means the global root in DFS. In a DFS include-exclude options file, the /... prefix is interpreted as the global root of DFS, and the /... prefix is used to match zero or more directories.

Options File

This option is placed in the client system options file.

Syntax

>>-DFSInclexcl filespec----------------------------------------><
 

Parameters

filespec
The filespec parameter specifies the path, and file name of your DFS include-exclude options file.

Examples

Options file:
dfsinclexcl /usr/lpp/adsm/bin/backup.excl.dfs

Command line:
Not applicable

domain

The domain option specifies the file systems to include for incremental backup in your client domain. When you select this option in your client user options file, it defines your default client domain. TSM uses your default client domain in the following situations to determine which file systems to process during an incremental backup:

Use the domain option to specify the file systems. If you do not select the domain option, the default is selected (all locally-mounted file systems, excluding /tmp).

Note:You can include a virtual mount point in your client domain. For information about defining a virtual mount point, see Virtualmountpoint.

When you select this option, the incremental command adds the file systems specified on the command to those defined in your client user options file. For example, if you enter:

   dom /u /usr /datasave

in your client user options file, and you enter:

   dsmc incremental -domain="/fs1 /fs1"

on the command line, TSM performs an incremental backup for these file systems: /u, /usr, /datasave, /fs1, and /fs2.

If you select both the filesystem parameter and the domain option on the incremental command, TSM ignores the domain option and processes only those file systems in the filesystem parameter. For example, if you enter the following, TSM performs an incremental backup only for the /usr and /data file systems:

   dsmc incremental /usr /data -domain="/fs1 /fs2"

When you specify a file system to include in your domain, you can specify the file system name, or specify the file system symbolically.

Options File

This option is placed in the client user options file.

Note:Environment variables are valid only when you use dsmafs, dsmdfs, dsmcafs, and dsmcdfs.

Syntax

   .-------------------------.
   V                         |
>>----DOMain-+- all-local-+--+---------------------------------><
             '- domain----'
 

Parameters

domain
The domain option specifies the file systems to include in your default client domain. When you use domain with the incremental command, you specify the file systems to process in addition to those specified in your default client domain. The default value, all-local, specifies all local file systems are backed up.

A file system specification can contain environment variables. For example, if you define these variables in the .profile file in a Bourne or Korn shell:

   export localcell=almaden.ibm.com
   export user=shaw

Or, if you add these environment variables to .login in your $home directory in the C shell:

   setenv localcell almaden.ibm.com
   setenv user shaw

You can enter this domain specification:

   dom /afs/${localcell}/u/${user}
Note:Precede the environment variable names with a dollar sign ($) and enclose it in braces.

The specification above resolves to:

   domain /afs/almaden.ibm.com/u/shaw

Examples

Options file:
domain /u /usr /fs1

Command line:
-domain="/fs1 /fs2"

exclude

The exclude option excludes a file or group of files from TSM backup services.For example, you might exclude all temporary files, local caches of network files, all files that contain compiled object code that you can easily reproduce using other methods, or your operating system files.

If you have the TSM backup-archive client and the TSM HSM client installed on your workstation, use the exclude option to exclude a file or group of files from both backup and space management services. Any files you exclude with this option are not considered for backup or for migration.

To exclude a file from backup only, use the exclude.backup option. To exclude a file from space management only, use the exclude.spacemgmt option.

To exclude an entire directory from TSM backup services, use the exclude.dir option. For example, you might want to exclude a particular subdirectory within a directory when you back up the directory. When you exclude a directory, you can still choose to back up specific files within the directory, using selective backup.

The exclude.dir option works only if the excluded directory is a subdirectory. If you explicitly specify the directory or the files within it, the file is backed up. To exclude a subdirectory during backup, specify -subdir=yes.

Use wildcard characters to exclude a broad range of files. Then, if necessary, use the include option to make exceptions. You cannot, however, specify wildcard characters on the directory name when you exclude a directory. For example

exclude.dir /afs/sanjose.ibm.com/usr/.../test*

would exclude any directories at /afs/sanjose.ibm.com/usr/.../ that start with test and all directories that follow.

In a path name for a file specification, you cannot specify a directory whose name is an asterisk (*) or a question mark (?). TSM recognizes those characters only as wildcard characters.

Table 7 shows a list of valid wildcard characters.

Table 7. 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. Use it in the file name only; do not use it in a directory name.
* The match-all character matches zero or more characters; it does not cross a directory boundary. Use it in the file name; do not use it in a directory name.
/... The match-n character matches zero or more directories (afs).
/.... The match-n character matches zero or more directories (dfs).
/ The directory separator character limits the scope of the search for the matching n characters and directories. If a pattern does not begin with a directory separator (or one does not follow the file system specification), a match all directories is appended to the pattern. For example, these patterns are equivalent:
   core
   /.../core
[ Use the open character class character to begin 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 specified up to and including the last character specified. For example:
  xxx[a-z] matches xxxa, xxxb, xxxc, ... xxxz.
] The close character class character ends the enumeration of a character class.
\ The literal escape character. When used within a character class, it causes the next character to be treated literally. When used outside a character class, it is not treated in this way.

See Using the UNIX Backup-Archive Clients for more information on including and excluding groups of files.

Options File

This option is placed in an include-exclude options file or in a DFS include-exclude options file.

An include-exclude options file is identified with the inclexcl option in the client system options file. Place include-exclude statements for AFS in this file.

A DFS include-exclude options file is identified with the dfsinclexcl option in the client system options file, and is used only when DFS files are examined for backup or archive. Place include-exclude statements for DFS, only, in this file.

Note:In a DFS include-exclude options file, the /... prefix is interpreted as the global root of DFS. Select the /.... prefix to match zero or more directories.

Syntax

   .--------------------------------------.
   V                                      |
>>----EXCLUDE-+--------------+-- pattern--+--------------------><
              +-.Backup------+
              +-.Dir---------+
              +-.FS----------+
              +-.File--------+
              '-.FILE.Backup-'
 

Parameters

.backup
The .backup parameter excludes a file or group of files from backup services only. For example:
   exclude.backup /users/home1/file1
                  /..../*.0

.dir
The .dir parameter excludes an entire directory from backup and space management services. For example:
   exclude.dir /var/vice/cache
   exclude.dir /.../tmp
   exclude.dir /.:/fs/usr/nshaw

.fs
The .fs parameter excludes an entire filespace or an entire AFS or DFS tree from backup and space management services. For example:
   exclude.fs /afs
   exclude.fs /...

.file.backup
The .file.backup parameter excludes a file from backup services only. For example:
   exclude.file.backup /afs/.../file1
   exclude.file.backup /..../file1

.file
The .file parameter excludes a file from backup and space management services.

pattern
The pattern parameter identifies the file or group of files that you want to exclude from backup services. When used with exclude.backup or exclude.spacemgmt, end the pattern with a file specification. If the pattern contains a blank space, enclose it in quotation marks.

Examples

Options file specified by the inclexcl option:
exclude            /unix
exclude            /.../core
exclude            /.../.SpaceMan/.../*
 
exclude            /home/shaw/proj1/*
include            /home/shaw/proj1/devplan
exclude.backup     /home/shaw/proj1/devplan
include            /home/shaw/proj1/status
exclude.dir /afs/sanjoseibm.com/home/nshaw/dir1
exclude.dir /.../tmp
exclude.fs         /afs

DFS Options file specified by the dfsinclexcl option:
exclude /.../testdce.sanjose.ibm.com/fs/usr/shaw/*
exclude /.../testdce.sanjose.ibm.com/temp
exclude /..../core
exclude /..../temp
exclude.dir /..../tempdir
exclude.fs /...

Command line:
Not applicable

Virtualmountpoint

TSM Authorized User

The virtualmountpoint option defines a virtual mount point for a file system. The virtual mount point is typically a specific directory. Use this option when you want to backup up files that begin with that directory within the file system. Using the virtualmountpoint option to identify a directory within a file system provides a direct path to the files you want to back up, saving processing time. It is more efficient to define a virtual mount point within a file system than to define the file system using the domain option and then use the exclude option in your include-exclude options file to exclude the files you do not want to back up.

You can use the virtualmountpoint option to define virtual mount points for multiple file systems and for local and remote file systems. You can also define more than one virtual mount point within the same file system.

Note:If the directory you want to specify as a virtual mount point is a symbolic link, set the followsymbolic option to yes. If this option is set to no (the default), TSM does not let you use a symbolic link as a virtual mount point.

After you define a virtual mount point, you can specify the path and directory name in the domain option in either the default client user options file or in the incremental command to include it for incremental backup services. Users can also specify the path and directory name of the virtual mount point with the domain option in their own client user options files and on the incremental command.

Options File

This option is placed in the client system options file.

Syntax

   .-------------------------------.
   V                               |
>>----VIRTUALMountpoint directory--+---------------------------><
 

Parameters

directory
The directory parameter defines the path and directory name you want to use as the virtual mount point for a file system, or a symbolic specification for the directory.

If you want to specify the directory symbolically, first define the full path or a subset of the path as an environment variable. For example, if you define the following variable in the .profile file in a Bourne or Korn shell:

   export afscell=/afs/almaden.ibm.com
   export dfscell=testdce.ibm.com

Or, if you add this environment variable to .login in your $home directory in the C shell:

   setenv afscell /afs/almaden.ibm.com
   setenv dfscell = testdce.ibm.com

You can define a virtual mount point like this:

   virtualmountpoint ${afscell}/u/shaw
   virtualm /.../${dfscell}/fs/usr/shaw
Note:You can use a single environment variable to define multiple virtual mount points. For example:
export virtualm="/afs/almaden.ibm.com/u/luan/project1\
                    /afs/almaden.ibm.com/u/luan/project2\
                    /afs/almaden.ibm.com/u/luan/project3"
 

Then you can set the virtualmountpoint option in your client system options file like this:

virtualmountpoint $(virtualmountpoint)

If you want to include the virtual mount points in your client domain, set the domain option like this:

domain $(virtualm)
Note:You cannot use wildcard characters in the path or in the directory names.

Define only one virtual mount point with each virtualmountpoint option you include in your client system options file. Use the virtualmountpoint option as many times as necessary to define all of the virtual mount points you want to use.

Examples

Options file:
virtualmountpoint /afs/xyzcorp.com/u/bob
virtualmountpoint /afs/xyzcorp.com/u/bob/test/data
virtualmountpoint /.../testdce/fs/usr/shaw

Command line:
Not applicable


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