Using the Backup-Archive Clients


Chapter 8. Setting Common Options

You can use defaults for processing options or you can tailor the processing options to meet specific needs. This chapter:

As a quick reference, this chapter includes instructions for the following tasks:

Task Page
"Creating and Modifying a Client System Options File" "Creating and Modifying a Client System Options File"
"Creating and Modifying a Client User Options File" "Creating and Modifying a Client User Options File"
"Setting Options in a File" "Setting Options in a File"
"Using Options With Commands" "Using Options With Commands"

Creating and Modifying a Client System Options File

TSM authorized user

During installation, a sample client system options file called dsm.sys.smp is provided, that is used to specify one or more servers to contact for services, and communications options for each server. It can also include authorization options, backup and archive processing options, scheduling options, and HSM space management options.

If you are a TSM authorized user, you are responsible for copying the dsm.sys.smp file to dsm.sys in your installation directory and modifying the required options in the new copy according to your needs. Required options are those that provide information client programs need to establish communication with a TSM server.


Creating and Modifying a Client User Options File

During the installation of TSM, you are provided with a sample client user options file called dsm.opt.smp. This file contains processing options that are categorized as follows:

If you are a root user, you can create a default client user options file that can be used by all users on your workstation. If you are a user and want to use different options than those specified in the default client user options file, you can create your own client user options file.

To create and modify a default client user options file or client user options file, follow these steps:

  1. Select the Utilities menu> Setup Wizard item.

  2. Select the Help me configure the TSM Backup Archive Client checkbox.

  3. Select the create a new options file checkbox.

  4. Follow the instructions on the screen.

You can also create and modify a default client user options file, or client user options file by performing the following steps:

  1. Change to the directory where the sample file is stored. Contact the root user on your workstation to determine the location.
  2. Copy dsm.opt.smp to dsm.opt or a new file name of your choice.
  3. From the TSM GUI, select the Utilities menu> Preferences item and enter any options you want to change. See "Client Options Reference" for options supported on your platform, and detailed information about each option.

    All of the sample entries are entered as comments. Enter the appropriate value for an option and then remove the leading asterisk (*).

    The preferences editor updates the client configuration files, dsm.opt and dsm.sys if any options have changed.

    The preferences editor uses environment variables DSM_DIR and DSM_CONFIG to locate the dsm.opt and dsm.sys files. The preferences editor queries the server for options stored at the server, but only updates the client options file on the client. Client options sets on the server are not updated. The preferences editor groups the options into the following categories:

Some options are used only with commands. For more information about these options, see Chapter 9, "Using Options With Commands".


Communication Options

You use communication options to specify how your client node communicates with a TSM server.

For UNIX you can use one of the following communication protocols:

Use the commmethod option to specify the communication protocol. For more information, see Commmethod. Ask your TSM administrator for assistance in setting your communication options.

TCP/IP Options

To use the TCP/IP communication protocol, you must include the tcpserveraddress option in your client options file. The other TCP/IP options have default values which you can modify only if you want to change the default value.

For UNIX: If you plan to back up an NFS system, see Nfstimeout.

Figure 11. TCP/IP Options

Option Description Page
httpport Specifies a TCP/IP port address for the TSM Web client. Httpport
httpsport Specifies a TCP/IP port address for the HTTPS secure socket layer (SSL) interface to the TSM Web client. Httpsport
tcpbuffsize Specifies the size, in kilobytes, of the TSM internal TCP/IP communication buffer. Tcpbuffsize
tcpnodelay Specifies that TSM immediately send small transactions to the server. This is available for the AIX client only. Tcpnodelay
tcpport Specifies the TCP/IP port address for a TSM server. Tcpport
tcpserveraddress Specifies the TCP/IP address for a TSM server. Tcpserveraddress
tcpwindowsize Specifies the size, in kilobytes, of the TCP/IP sliding window for your client node. Tcpwindowsize

SNA LU6.2 (APPC) Options

To use SNA LU6.2 you must include either the symbolicdestination option or all three of the following options: cpicmodename, partnerluname, and tpname.

Figure 12. SNA LU6.2 (APPC) Options

Option Description Page
cpicbuffersize The buffer size for SNA LU6.2 communication. Cpicbuffersize
cpicmodename The mode name for SNA LU6.2 communication. Cpicmodename
partnerluname A logical unit name used by the transaction program to identify the TSM server in the SNA network. Partnerluname
symbolicdestination A symbolic TSM server name. Symbolicdestination
tpname A symbolic name for a transaction program in an SNA network. The transaction program identifies the target logical unit (LU), which is the TSM server. Tpname

Shared Memory Options

TCP/IP must be installed on your workstation to use the shared memory communication method.

Figure 13. Shared Memory Communication Options

Option Description Page
shmport Specifies the TCP/IP port address on which the server listens to establish a shared memory connection. Shmport

Server and Node Options

TSM authorized user

You can use the following options to specify the server you want to contact for backup-archive services, and the client node for which you want to request backup-archive services.

Server Options

Use the servername option in your client system options file to specify the server you want to contact for backup-archive services. The specified server name is a symbolic name which is used on the servername option in the client options file to select the server to be contacted. You enter options in stanzas in the client system options file. Each stanza begins with a servername option and must contain all options required to establish communication with a TSM server.

If your client system options file contains only one stanza -- Your client node contacts the server specified in that stanza for all services.

If your client system options file contains more than one stanza -- You can:

If you do not specify a default server or migration server, by default, TSM contacts the first server specified in your client system options file.

Place the defaultserver and migrateserver options at the beginning of your client system options file before any server stanzas.

Figure 14 shows a sample client system options file.

Figure 14. Sample Client System Options File


+--------------------------------------------------------------------------------+
|DEFAULTServer                 server2                                           |
|MIGRATEServer                 server1                                           |
|                                                                                |
|Servername     server1                                                          |
|  NODename                    node1                                             |
|  COMMmethod                  TCPip                                             |
|  TCPPort                     1500                                              |
|  TCPServeraddress            almvmd.almaden.ibm.com                            |
|  Passwordaccess              generate                                          |
|  Mailprog                    /usr/bin/xsend root                               |
|  Groups                      system adsm                                       |
|  Users                       ashton stewart kaitlin                            |
|  Inclexcl                    /adm/adsm/backup1.excl                            |
|                                                                                |
|Servername     server2                                                          |
|  COMMmethod                  SNAlu6.2                                          |
|  PARtnerluname               raptor                                            |
|  TPname                      appcdel                                           |
|  CPICMOdename                appc                                              |
|  Passwordaccess              prompt                                            |
|  Groups                      system adsm                                       |
|  Users                       danielle derek brant                              |
|  Inclexcl                    /adm/adsm/backup2.excl                            |
+--------------------------------------------------------------------------------+

You can use the servername option in your default client user options file, client options file, or on the command line to specify a server to contact for backup-archive services. This overrides the default server specified in your client system options file.

You cannot override the migration server specified in the client system options file.

Node Options

The following node option in the client system options file:

For the client user options file: Use the virtualnodename option in your client user options file, or with a command if you want to request services for a client node other than the one on which you are currently working. For example, if you have a hardware failure on your workstation, you can restore backup versions of files to a different workstation.

Note:You must supply the password for the client node that you specify. Any user who can supply the correct password becomes a virtual root user and can access all backup versions and archive copies of files that originated from the specified client node.

Figure 15. Server and Node Options

Option Description Page
defaultserver The name of the TSM server to contact for backup-archive services by default if more than one server is defined in the client system options file.

Also specifies the TSM server to contact for space management services if you have the HSM client installed and do not specify a server with the migrateserver option.

Defaultserver
migrateserver Specifies the TSM server to contact for space management services. Migrateserver
nodename Specifies one of the following:
  • The name of your workstation so that you can establish communications with the TSM server.
  • The name of another workstation. Use this if you want to restore or retrieve your files from a TSM server to a different workstation than the one from which you stored the files.
Nodename
servername In client system options file this option specifies the name of a server. In the client user options file this option specifies the TSM server to contact for services. Servername
virtualnodename Specifies the name of another client node. Use this option if you want to restore or retrieve your files from a TSM server to a client node other than the one on which you stored files. Virtualnodename

Backup and Archive Processing Options

You can use the following options to control some aspects of backup and archive processing.

Figure 16. Backup and Archive Processing Options

Option Description Page
archsymlinkasfile Specifies whether you want TSM to follow a symbolic link and archive the file or directory it points to, or archive the symbolic link only. Archsymlinkasfile
changingretries Specifies the number of retries when attempting to back up or archive a file that is in use. Changingretries
compressalways Whether to compress files or send them if compression causes them to grow. Compressalways
compression Specifies whether to compress files before sending them to the TSM server.

Note: The compression option also applies to migrated files if you have the TSM HSM client installed on your workstation.

Compression
dirmc Specifies the management class to use for directories. If not specified, TSM uses the management class with the longest retention period. Dirmc
domain Specifies the file systems to include in your default client domain for an incremental backup. Domain
domain.image Specifies the file systems included in your default client domain for an image back up. Domain.image
exclude Excludes a file or group of files from backup services and space management services (if the HSM client is installed). Any file in your client domain that is not specifically excluded with this option is considered for backup. Exclude Options
exclude.backup Excludes a file or a group of files from normal backup services, but not from HSM. Exclude Options
exclude.dir Excludes the specified directory, its files, and all its subdirectories and their files are excluded from backup services. Exclude Options
exclude.file Excludes files, but not directories, that match a pattern. Exclude Options
exclude.file.backup Excludes a file from normal backup services. Exclude Options
exclude.file.spacemgmt Excludes a file from hierarchical space management services (HSM) only. Use this option when you have both the backup-archive client and the HSM client installed. Exclude Options
exclude.fs Excludes file spaces matching a pattern. Exclude Options
exclude.image Excludes mounted file systems and raw logical volumes that match the pattern from image processing. This option is valid for AIX, HP-UX, and Solaris only. Exclude Options
exclude.spacemgmt Excludes a group of files from HSM backup only. Use this option when you have both the backup-archive client and the HSM client installed. Exclude Options
guitreeviewafterbackup Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. Guitreeviewafterbackup
inclexcl Specifies the path and file name of your include-exclude options file. Inclexcl
include Includes files or management classes for backup or archive processing. Include Options
include.file Includes a file for backup services, or assigns a management class to a file. Include Options
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 parameter is valid for UNIX (AIX, HP-UX, and Solaris) only. Include Options
memoryefficientbackup Specifies a memory-saving backup algorithm for incremental backups for use with the incremental command. Memoryefficientbackup
subdir Specifies whether to include subdirectories of a named directory. Subdir
tapeprompt Specifies whether you want TSM to wait for a tape required for a backup or archive to be mounted, or to prompt you for your choice. Tapeprompt
virtualmountpoint Specifies a directory to serve as a virtual mount point for a file system. This provides a direct path to the files you want TSM to consider for backup, saving processing time. Virtualmountpoint

Restore and Retrieve Processing Options

The following options relate to restore and retrieve processing.

Figure 17. Restore and Retrieve Processing Options

Option Description Page
followsymbolic Specifies that you want TSM to restore files to symbolic links, and permit a symbolic link to be used as a virtual mount point. Followsymbolic
guitreeviewafterbackup Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. Guitreeviewafterbackup
replace Specifies whether to overwrite an existing file, or to prompt you for your selection when you restore or retrieve files. Replace
restoremigstate Specifies whether TSM restore stub files for migrated files, or restore backup versions of migrated files. This option is valid only when the HSM client is also installed on an AIX workstation. Restoremigstate
subdir Specifies whether you want to include subdirectories of a named directory. Subdir
tapeprompt Specifies whether you want TSM to wait for a tape required for a restore or retrieve to be mounted, or to prompt you for your choice. Tapeprompt

Scheduling Options

You can use the following options to regulate central scheduling. TSM uses scheduling options only when the Scheduler is running.

Figure 18. Scheduling Options

Option Description Page
maxcmdretries Specifies the maximum number of times the client scheduler attempts to process a scheduled command that fails. Maxcmdretries
postschedulecmd, postnschedulecmd Specifies a command to process after running a schedule. Postschedulecmd
preschedulecmd, prenschedulecmd Specifies a command to process before running a schedule. Preschedulecmd
queryschedperiod Specifies the number of hours the client scheduler waits between unsuccessful attempts to contact the TSM server for scheduled work. Queryschedperiod
retryperiod Specifies the number of minutes the client scheduler waits between attempts to process a scheduled command that fails or between unsuccessful attempts to report results to the server. Retryperiod
schedlogname Specifies the name of the file where schedule log information is stored. Schedlogname
schedlogretention Specifies the number of days to keep log file entries in the schedule log, and whether to save pruned entries. Schedlogretention
schedmode Specifies which schedule mode to use, polling or prompted. Schedmode
tcpclientaddress Specifies the TCP/IP address of your client node. Use this only with the schedule command when you specify prompted as the schedule mode. Tcpclientaddress
tcpclientport Specifies the TCP/IP port number of your client node. Use this only with the schedule command when you specify prompted as the schedule mode. Tcpclientport

Format Options

You can use the following options to select different formats for date, time, and numbers.

Figure 19. Format Options

Option Description Page
dateformat Specifies the format for displaying dates. Dateformat
numberformat Specifies the format for displaying numbers. Numberformat
timeformat Specifies the format for displaying times. Timeformat

Command Processing Options

The following options apply only when you use certain TSM commands.

Figure 20. Command Processing Options

Option Description Page
editor Specifies if the command-line interface editor and command retrieve capability is turned on or off. Editor
guitreeviewafterbackup Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. Guitreeviewafterbackup
optionformat Specifies the format to use when you enter TSM HSM client commands.

Use this option only when you use TSM HSM client commands.

Optionformat
quiet Specifies that processing information does not display on your screen. This option can be overidden by the TSM server. Quiet
scrolllines Specifies the number of lines to display at one time when displaying a list of items. Use this option only when scrollprompt is set to yes. Scrolllines
scrollprompt Specifies whether TSM stops after displaying the number of lines specified by scrolllines, or it scrolls to the end of the list. Scrollprompt
verbose Specifies that processing information should display on your screen. The alternative is quiet. This option can be overridden by the TSM server. Verbose

Authorization Options

These options control access to a TSM server.

Figure 21. Authorization Options

Option Description Reference
groups Specifies the groups on your workstation that you want to authorize to request services from the TSM server. Groups
mailprog The program and user ID to which you want TSM to send a newly generated password when the old one expires. Mailprog
optfile The options file you want TSM to use when you start a TSM session. Optfile
password A TSM password. Password
passwordaccess How TSM handles a password if one is required for your workstation. Passwordaccess
passworddir The directory in which you want TSM to store an automatically generated password for your client node. Passworddir
revokeremoteaccess Restricts an administrator with client access privilege from accessing your workstation through the Web client. Revokeremoteaccess
users Particular users on your workstation who can request services from a TSM server. Users

Error Processing Options

These options specify the name of the error log file and how TSM treats the entries in the log file.

Figure 22. Error Processing Options

Option Description Page
errorlogname Specifies the path and name of the error log. Errorlogname
errorlogretention Specifies the number of days to keep log file entries in the error log, and whether to save pruned entries. Errorlogretention

Transaction Processing Options

These options control how TSM processes transactions between the client and server.

Figure 23. Transaction Processing Option

Option Description Page
commrestartduration Specifies the maximum number of minutes you want the TSM client to try to reconnect to a TSM server after a communication error occurs. Commrestartduration
commrestartinterval Specifies the number of seconds you want the TSM client to wait between attempts to reconnect to a TSM server after a communication error occurs. Commrestartinterval
largecommbuffers Specifies whether the client will use increased buffers to transfer large amounts of data between the client and the server. Largecommbuffers
nfstimeout Specifies the amount of time, in seconds, TSM waits for an NFS system call response before timing out. Nfstimeout
resourceutilization Specifies the number of sessions opened between the TSM server and client during processing. Resourceutilization
txnbytelimit Specifies the number of kilobytes TSM can buffer together in a transaction before sending data to the server. Txnbytelimit

Space Management Options

If you have the TSM HSM client installed on your workstation, these options affect automatic migration, recall, and reconciliation.

Figure 24. Space Management Options

Option Description Page
checkthresholds How often the space monitor daemon checks space usage on your file system. Checkthresholds
errorprog The path and file name of the program TSM notifies if a severe error occurs during HSM processing. Errorprog
kernelmessages Whether HSM related messages issued by the kernel are displayed. Kernelmessages
maxrecalldaemons The maximum number of recall daemons you want to run at one time. Maxrecalldaemons
maxreconcileproc The maximum number of automatic reconciliation processes HSM can perform at one time. Maxreconcileproc
maxthresholdproc The maximum number of automatic threshold migration processes TSM can perform at one time. Maxthresholdproc
migfileexpiration The number of days a migrated or premigrated file remains in TSM storage after the file is modified on the local file system or is erased from the local file system. Migfileexpiration
migrateserver The name of the server to which you want to migrate files for your client node. Migrateserver
minrecalldaemons The minimum number of recall daemons to retain. Minrecalldaemons
optionformat The format users must use when entering TSM HSM commands. Optionformat
reconcileinterval How often TSM automatically reconciles the file systems on your workstation. Reconcileinterval

Web Client Options

The following are options for the TSM Web Client.

Figure 25. Web Client Options

Option Description Page
httpport Specifies a TCP/IP port address for the Web Client. Httpport
httpsport Specifies a TCP/IP Secure Socket Layer (SSL) port address for the Web Client. Httpsport
revokeremoteaccess Restricts administrator access on a client workstation through the Web Client. Revokeremoteaccess

Setting Options in a File

This section describes how to set options in your client system options file or client user options file, and how to use options with commands.

To set an option in these files, enter the option name, followed by one or more blank spaces, followed by the option value. For example:

   compression  on
   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:

If you update the client user options file while a GUI or Web client session is active, you must restart the session to pick up the changes.


Using Options With Commands

You can override some of the options in your options file by entering them with appropriate backup-archive commands. You cannot override options by entering them with HSM commands.

Options are processed in the following order (precedence):

  1. Options defined on the server with server-enforced client options. The client cannot override the value.
  2. Options entered locally on the command line.
  3. Options defined on the server for a schedule using the options parameters.
  4. Options entered locally in the options file.
  5. Options received from the server with client options not enforced by the server. The client can override the value.
  6. Default option values.

TSM also includes a group of client command options that you can enter only on the command line with specific commands. For a complete list of command line options, a description, and where to go in this book for more information, see Chapter 9, "Using Options With Commands".

To use an option with a command, enter a dash (-), the option name, an equal sign (=), and the option parameters. For example,

   dsmc incremental -domain=/home

For options that do not include parameters, enter a dash (-) and the option name. For example,

   dsmc incremental -quiet

You can enter the entire option name, or its abbreviation. For information about how to read the syntax diagrams, see "Reading Syntax Diagrams".

Entering Options With a Command

Follow these general rules to enter options with a command:


Client Options Reference

The following sections contain detailed information about each of the TSM processing options. These options are arranged in alphabetical order. Information for each option includes:

The only options that can be placed before any server stanzas are the following:

Archsymlinkasfile

Options

The archsymlinkasfile option specifies whether you want TSM to follow a symbolic link and archive the file or directory it points to, or archive the symbolic link only.

The followsymbolic option is used only for restoring to a symbolic link that is a virtual mount point and is unrelated to, and has no dependencies with the archsymlinkasfile option.

Note:This option can also be defined on the server.

Options File

Place this option in the client options file (dsm.opt).

Syntax

                     .-Yes--.
>>-ARCHSYMLinkasfile-+------+----------------------------------><
                     '-No---'
 

Parameters

Yes
Specifies that TSM follows a symbolic link and archives the file or directory it points to. This is the default.

No
Specifies that TSM only archives the symbolic link, and not the file or directory associated with it.

Examples

Options file:
ARCHSYMLinkasfile no

Command line:
ARCHSYML no

Changingretries

Options

TSM authorized user

The changingretries option specifies how many additional times you want the TSM client program to attempt to back up or archive a file that is in use. This option is used only when serialization, an attribute in a management class copy group, is shared static or shared dynamic.

With shared static serialization, if a file is in use during the first backup or archive attempt, the operation is attempted again the number of times you specified. If the file is in use during each attempt, the operation does not complete.

With shared dynamic serialization, if a file is in use during the first backup or archive attempt, the operation is attempted again the number of times you specified. The backup or archive operation occurs during the last attempt whether the file is in use or not.

Note:This option can also be defined on the server.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-CHAngingretries- numberretries------------------------------><
 

Parameters

numberretries
Specifies the number of times a backup or archive operation is attempted if the file is in use. The range of values is zero through 4; the default is 4.

Examples

Options file:
changingretries 3

Command line:
Does not apply.   

Checkthresholds

Options

TSM authorized user

The checkthresholds option specifies how often the space monitor daemon checks space usage on your file systems. The space monitor daemon checks each file system to which you added space management.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.

Syntax

>>-CHEckthresholds- interval-----------------------------------><
 

Parameters

interval
Specifies the number of minutes that elapse before the space monitor daemon checks space usage on your file systems. The range of values is 1 through 9999; the default is 5.

Examples

Options file:
checkthresholds 10

Command line:
Does not apply.

Commmethod

Options

TSM authorized user

The commmethod option specifies the communication method you use to provide connectivity for client-server communication.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-COMMMethod-+- TCPip----+------------------------------------><
              +- SHAREmem-+
              '- SNALu6.2-'
 

Parameters

TCPip
The Transmission Control Protocol/Internet Protocol (TCP/IP) communication method.

SHAREdmem
The Shared Memory communication method can be used when the client and server are running on the same system. It can provide better performance over the TCP/IP protocol.

When specifying the Shared Memory communications method on AIX, the backup-archive client user must be logged in as root or have the same uid as the process running the server. This restriction does not apply if the passwordaccess option is set to generate in the client systems option file (dsm.sys).

SNALu6.2
The Systems Network Architecture Logical Unit 6.2 (SNALu6.2) communication method.

Examples

Options file:
commm tcp

Command line:
Does not apply.   

Commrestartduration

Options

TSM authorized user

The commrestartduration option specifies the maximum number of minutes you want the client to attempt to reconnect with a server after a communication error occurs.

Note:The connection and schedule will fail if a communication failure occurs while a schedule is running, and the client cannot reconnect with the server before the startup window for the schedule ends.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-COMMRESTARTDuration- minutes--------------------------------><
 

Parameters

minutes
The maximum number of minutes you want the client to attempt to reconnect with a server after a communication failure occurs. The range of values is zero through 9999; the default is 60.

Examples

Options file:
commrestartduration 90

Command line:
Does not apply.

Commrestartinterval

Options

TSM authorized user

The commrestartinterval option specifies the number of seconds you want the client to wait between attempts to reconnect with a server after a communication error occurs.

Note:This option is used only when commrestartduration is set to a value greater than zero.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-COMMRESTARTInterval- seconds--------------------------------><
 

Parameters

seconds
The number of seconds you want the client to wait between attempts to reconnect with a server after a communication failure occurs. The range of values is zero through 65535; the default is 15.

Examples

Options file:
commrestartinterval 30

Command line:
Does not apply.

Compressalways

Options

The compressalways option specifies whether to continue compressing an object if it grows during compression, or resend the object, uncompressed. This option is used with the compression option.

Note:This option can also be defined on the server.

Options File

Place this option in the client options file (dsm.opt).

Syntax

                  .-Yes--.
>>-COMPRESSAlways-+------+-------------------------------------><
                  '-No---'
 

Parameters

Yes
File compression continues even if the file grows as a result of compression. This is the default.

No
The object is resent uncompressed, if it grows during compression.

Examples

Options file:
compressalways yes

Command line:
-compressa=no

This option is valid only on the initial command line. It is not valid in loop or interactive mode.

Compression

Options

TSM authorized user

The compression option compresses files before you send them to the server. Compressing your files reduces data storage that is required to store backup versions and archive copies of your files. It can, however, affect TSM throughput. A fast processor on a slow network connection benefits from compression, but a slow processor on a fast network connection does not.

If compressalways=yes (the default) is specified, files continue compression even if the file size increases. To stop compression if the file size grows, and resend the file, uncompressed, specify compressalways=No.

This option controls compression only if your administrator specifies that your client node determines the selection.

Note:This option can also be defined on the server.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza.

Syntax

               .-No--.
>>-COMPRESSIon-+-----+-----------------------------------------><
               '-Yes-'
 

Parameters

No
Files are not compressed before they are sent to the server. This is the default.

Yes
Files are compressed before they are sent to the server.

Examples

Options file:
compression yes

Command line:
Does not apply.   

Cpicbuffersize

Options

TSM authorized user

The cpicbuffersize option specifies the size of the CPIC buffer for SNA LU6.2 communication. A larger buffer can improve communication performance, but uses more memory.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-CPICBuffersize- size----------------------------------------><
 

Parameters

size
Specifies the size, in kilobytes, of an SNA LU6.2 communication buffer. The range of values is 1 through 31; the default is 31.

Examples

Options file:
cpicbuffersize 31

Command line:
Does not apply.   

Cpicmodename

Options

TSM authorized user

The cpicmodename option defines the mode name for the SNA LU6.2 communication method. For CPIC, this option identifies the SNA connection to the gateway and target logical unit. The CPIC mode name is used if the symbolic destination is not provided, and the partner LU is located on another system. The mode name must be known on both the local and the remote systems.

If you use this option, you must also use the tpname and partnerluname options.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-CPICModename- name------------------------------------------><
 

Parameters

name
Specifies the mode name for SNA LU6.2 communication. Contact your system administrator for this name. There is no default.

Examples

Options file:
cpicmodename vmmode

Command line:
Does not apply.   

Dateformat

Options

The dateformat option selects the format you want to use to display dates.

The AIX, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. Solaris and HP-UX clients only support English, Simplified Chinese, Traditional Chinese, and Japanese locale information. The default directories for system-supplied locales are as follows:

The backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. Consult the documentation on your local system for details about setting up your locale definition.

Options File

Place this option in the client options file (dsm.opt).

Syntax

>>-DATEformat- format_number-----------------------------------><
 

Parameters

format_number
Displays the date using any one of the following formats. Select the number that corresponds to the date format you want to use:

0
Use the locale-specified date format. For AIX, HP-UX, and Solaris: This is the default if the locale-specified date format consists of digits and separator characters.

1
MM/DD/YYYY This is the default.

For AIX, HP-UX, and Solaris: This is the default if the locale-specified date format consists of anything but digits and separator characters.

2
DD-MM-YYYY

3
YYYY-MM-DD

4
DD.MM.YYYY

5
YYYY.MM.DD

For AIX, HP-UX, and Solaris: To set a particular date format, edit the source file for your locale and modify the d_fmt line to support your needs. Whatever date format you select applies both to output and to input; however, the input year can be either 2 or 4 digits.

"%m/%d/%y"
Displays the date in the form MM/DD/YY
"%d.%m.%Y"
Displays the date in the form DD.MM.YYYY

Examples

Options file:
dateformat 3

Command line:
-date=4

Defaultserver

TSM authorized user

The defaultserver option specifies the default server to which files are backed up and archived from your local systems.

If you have the HSM client installed on your workstation, and you do not specify a migration server with the migrateserver option, this option can also specify the server to which files are migrated from your local file systems.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas.

Syntax

>>-DEFAULTServer- servername-----------------------------------><
 

Parameters

servername
Specifies the name of the default server to which files are backed up and archived. The server to which files are migrated from your local file systems can also be specified with this option. If a migration server is not specified with the migrateserver option.

Examples

Options file:
defaults server_a

Command line:
Does not apply.

Dirmc

Options

TSM authorized user

The dirmc option specifies the management class you want to use for directories. If you do not specify this option to associate a management class with directories, the client program uses the management class in the active policy set of your policy domain with the longest retention period. Select a management class for individual directories that retains directories at least as long as it retains the files associated with them.

The dirmc option specifies the management class of directories being backed up, and does not effect archived directories. Archived directories are always bound to the default management class.

Note:This option can also be defined on the server.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-DIRMc- mgmtclassname----------------------------------------><
 

Parameters

mgmtclassname
Specifies the name of the management class you want to associate with directories. The management class name that you specify is used for all directories that you back up. If you do not use this option, the management class with the longest retention period is associated with directories.

Examples

Options file:
dirm managdir

Command line
Does not apply.

Domain

Options

The domain option specifies the file systems that you want to include for incremental backup in your client domain. When used in your client options file, the domain option defines your default client domain. Your default client domain is used in the following situations to determine which file systems to process during an incremental backup:

If you do not use the domain option to specify file systems in your client options file, the all-local parameter default is used.

When you use the domain option with the incremental command, it adds the file systems you specify to that which is defined in your client options file. For example, if you enter the following in your client options file:

   domain /home /usr /datasave     

and the following on the command line:

   dsmc incremental -domain="/fs1 /fs2"   

An incremental backup is performed for your /home, /usr, /datasave, /fs1, and /fs2 file systems .

If you use both the filespec parameter (for example, file system) and the domain option on the incremental command, the domain option is ignored and only those file systems in the file system parameter are processed.

When performing a backup with domain=all-local, files handled by automounter and loopback file systems are not backed up.

When performing a file system backup with domain=all-local, any subdirectories that are mountpoints for an automounted file system (autofs) are excluded from backup when the automounter has mounted these mountpoints. Any files that exist on the server for the automounted subdirectory are expired.

When performing a backup with domain=all-lofs, all explicit loopback file systems (lofs) are backed up and all automounted file systems are excluded. For loopback file systems handled by automounter, use domain=all-auto-lofs.

Only those automounted file systems that are mounted when the TSM client starts, can be backed up using the domain option or the GUI. Virtual mountpoints cannot be used with automounted file systems.

An automounted file system that is not mounted when starting the TSM client, can only be explicitly backed up by specifying the automounted file system with the incremental command. For example:

dsmc incremental Autofs_name/

For HP-UX: If you want to use the enhanced domain option for supporting automounted file systems, set the autofs parameter to 1 in the /etc/rc.config.d/nfsconf file. Changing this parameter requires a reboot.

The following UNIX platforms support autmounter, LOFS, or LOFS through automounter, as indicated:

Platform automounter LOFS LOFS through automounter
AIX yes yes yes
SUN yes yes yes
HP yes yes no
Note:This option can also be defined on the server.

Options File

Place this option in the client options file (dsm.opt).

Syntax

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

Parameters

all-local
Backs up all local file systems except LOFS file systems and LOFS through automounter. This is the default.

The /tmp directory is not included.

domain
Defines the file systems to include in your default client domain.

When you use domain with the incremental command, it processes these file systems in addition to those specified in your default client domain.

all-lofs
Backs up all loopback file systems, except those handled by automounter.

all-nfs
Backs up all network file systems, except those handled by automounter.

all-auto-nfs
Backs up all network file systems which are handled by automounter.

all-auto-lofs
Backs up all loopback file systems which are handled through automounter.

Examples

Options file:
domain /tst /datasave /joe  

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

Domain.image

Options

The domain.image option specifies the mounted file systems and raw logical volumes that you want to include for an image backup in your client domain. Raw logical volumes must be named explicitly. When you use this option in your client options file, it defines your default client image domain.

If you do not use the domain.image option to specify file systems in your client options file, and you do not specify a file system with the backup image command, a message is issued and no backup occurs.

When you use the domain.image option in your client options file to specify file systems and do not specify a file system with the backup image command, the file systems listed in the domain.image option are backed up.

When you specify a file system with the backup image command, the domain.image option is ignored.

Note:This option can also be defined on the server.

Options File

Place this option in the client options file (dsm.opt).

Syntax

                 .- ------------.
                 V              |
>>-DOMAIN.Image-----+--------+--+------------------------------><
                    '-domain-'
 

Parameters

domain
Defines the file systems or raw logical volumes to include in your default client image domain.

Examples

Options file:
domain.image /fs1 /fs2   

Command line:
Does not apply.

Editor

Options

The editor option turns the command line interface editor and retrieve capability on or off. If the editor and command retrieve functions are not working on a specific terminal setting, we recommend you turn off this function.

Options File

Place this option in the client system options file (dsm.sys) and the client options file (dsm.opt).

Syntax

          .-Yes--.
>>-EDitor-+------+---------------------------------------------><
          '-No---'
 

Parameters

Yes
Turns on the CLI editor and command retrieve capability. This is the default.

No
Turns off the CLI editor and command retrieve capability.

Examples

Options file:
editor yes

Command line:
Does not apply.

Errorlogname

TSM authorized user

The errorlogname option specifies the fully-qualified path and file name of the file where you want to store information about errors that occur during processing.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-ERRORLOGName- filespec--------------------------------------><
 

Parameters

filespec
The fully-qualified path and file name where you want to store error log information.

The default is the path in the DSM_LOG environment variable and in the dsmerror.log file located in the installation directory.

Examples

Options file:
errorlogname /tmp/adsmerr.log        

Command line:
Does not apply.       

Errorlogretention

Options

TSM authorized user

The errorlogretention option specifies how many days to maintain error log entries before pruning the , and whether to save the pruned entries. The error log is pruned when the first error is written to the log after a TSM session is started. If the only session you run is the client scheduler, and you run it twenty-four hours a day, the error log might not be pruned according to your expectations. Stop the session and start it again to prune the error log when the next error is written.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

                      .-N----.   .-D--.
>>-ERRORLOGRetention--+------+---+----+------------------------><
                      '-days-'   '-S--'
 

Parameters

N  or  days
Specifies how long to wait before pruning the error log.

N
Do not prune the error log. This permits the error log to grow indefinitely. This is the default.

days
The number of days to keep log file entries before pruning the log. The range of values is zero through 9999.

D  or  S
Specifies whether to save the pruned entries. Enter a space or comma to separate this parameter from the previous one.

D
Discard the error log entries when you prune the log. This is the default.

S
Save the error log entries when you prune the log.

The pruned entries are copied from the error log to the dsmerlog.pru file located in the same directory as the error log.

Examples

Options file:
errorlogretention 400 S

Command line:
Does not apply.   

Errorprog

TSM authorized user

The errorprog option specifies a program to which you want to send a message if a severe error occurs during space management processing.

Options File

Place this option in the client system options file (dsm.sys) and include it in a server stanza. The HSM client must be installed on your workstation.

Syntax

>>-ERRORProg- program-name-------------------------------------><
 

Parameters

program-name
Specifies the path and file name of the program to which you want to send a message if a severe error occurs during space management processing.

Examples

Options file:
errorprog /usr/bin/echo

Command line:
Does not apply.

Exclude Options

TSM authorized user

The exclude options exclude objects from backup, image, or archive services. For example, you might want to exclude all temporary files, any 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.

Exclude any system files or images that could corrupt the operating system when recovered. The client directory should also be excluded.

Note:If you change your include-exclude list so that a previously included file is now excluded, any pre-existing backup versions of that file expire the next time an incremental backup is run.

Use wildcard characters to exclude a broad range of files. See "Including and Excluding Groups of Files" for a list of wildcard characters that you can use. Then, if necessary, use the include option to make exceptions.

To exclude an entire directory called any/test, enter the following:

exclude.dir /any/test     

To exclude subdirectories that begin with test under the any directory, enter the following:

exclude.dir /any/test*     

Options File

Place this option in the Include-Exclude options file or the client system options file (dsm.sys).

Syntax

   .- -----------------.
   V                   |
>>----options pattern--+---------------------------------------><
 

Options

exclude
Excludes files that match the pattern from backup services. When you back up files, any files you exclude with this option are not considered for backup.

If you have the Backup-Archive client and the HSM client installed on your workstation, use this 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 migration.

exclude.backup
Excludes a file or a group of files that match the pattern from backup services only.

exclude.dir
Excludes an entire directory that matches the pattern from backup services only.

If a matching directory is found, that directory, its files, and all its subdirectories and their files are excluded from backup services. When you exclude a directory, you can still back up specific files within that 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.

exclude.file
Excludes files, but not directories, that match the pattern.

exclude.file.backup
Excludes files that match the pattern from normal backup services.

exclude.file.spacemgmt
Excludes files that match the pattern from hierarchical space management services (HSM) only. This parameter is valid for AIX and Solaris clients.

exclude.fs
Excludes file spaces that match the pattern.

exclude.image
Excludes mounted file systems and raw logical volumes that match the pattern from image processing. This parameter is valid for AIX, HP-UX, and Solaris clients only.

exclude.spacemgmt
Excludes files and directories that match the pattern from hierarchical space management services (HSM) only. This parameter is valid for AIX and Solaris clients.

Parameters

pattern
Specifies the file or group of files that you want to exclude from backup services. End the pattern with a file specification.

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.

You cannot use the match-all character (or any wildcard character) when specifying the high-level qualifier of an object, only use it for the low-level qualifier.

For the exclude.image option, the pattern is the name of a mounted file system or raw logical volume. Because this option excludes the entire named object and the files it contains from processing, you must use wildcards. For example, to exclude the /etc file system from image backup, enter the following:

   exclude.image /etc/*/*

Examples

Options file:
exclude            /unix/
exclude            /.../core
exclude            /home/jones/proj1/*
include            /home/jones/proj1/devplan/
exclude.backup     /home/jones/proj1/devplan/
include            /home/jones/proj1/status/
exclude.spacemgmt  /home/jones/proj1/status/
exclude.dir        /home/jones/tmp
exclude.backup     /users/home1/file1
exclude.spacemgmt  /users/home1/file1
exclude.image      /usr/*/*
 

Command line:
Does not apply.

Followsymbolic

Options

The followsymbolic option specifies whether you want to restore files to symbolic links, or use a symbolic link as a virtual mount point.

Options File

Place this option in the client options file (dsm.opt).

Syntax

                  .-No--.
>>-FOLlowsymbolic-+-----+--------------------------------------><
                  '-Yes-'
 

Parameters

No
Specifies that you do not want to restore to symbolic links, or to use symbolic links as virtual mount points. This is the default.

Yes
Specifies that you want to restore to symbolic links, or to use a symbolic link as a virtual mount point.

Examples

Options file:
followsymbolic Yes

Command line:
-fol=Yes

Groups

Options

TSM authorized user

The groups option specifies groups on your workstation that you want to authorize to request TSM services from the server. You can use the groups option more than once to specify a large number of group names.

If you do not specify group names with the groups option, or user IDs with the users option, all users can request TSM services. If you use the groups option, the users option, or both, only users included in one of the specified groups or those included in the list of users can request TSM services.

A root user is always authorized to request services.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

   .- -------------------------.
   |         .- ------------.  |
   V         V              |  |
>>----GRoups---- groupname--+--+-------------------------------><
 

Parameters

groupname
Specifies the name of a group you want to authorize to request TSM services.

Examples

Options file:
groups  dsmcdev  group1  test1  test2  design1
groups  endicott almaden qadev qadev1 tools23

Command line:
Does not apply.

Guitreeviewafterbackup

Options

The guitreeviewafterbackup option specifies whether the client returns to the Backup, Restore, Archive, or Retrieve window after a successful operation completes.

Options File

Place this option in the client options file (dsm.opt) and the client system options file (dsm.sys).

Syntax

                          .-No--.
>>-GUITREEViewafterbackup-+-----+------------------------------><
                          '-Yes-'
 

Parameters

No
Returns you to the TSM main window after a successful operation completes. This is the default.

Yes
Returns you to the Backup, Restore, Archive, or Retrieve window after a successful operation completes.

Examples

Options file:
guitreeviewafterbackup yes

Command line:
Does not apply.

Httpport

Options

TSM authorized user

The httpport option specifies a TCP/IP port address for the Web client.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-HTTPport- port_address--------------------------------------><
 

Parameters

port_address
Specifies the TCP/IP port address that is used to communicate with the Web client. The range of values is 1000 through 32767; the default is 1581.

Examples

Options file:
-httpport=1502.

Command line:
Does not apply

Httpsport

Options

TSM authorized user

The httpsport option specifies a TCP/IP port address for the HTTPS secure socket layer (SSL) interface to the Web client.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-HTTPSport- port_address-------------------------------------><
 

Parameters

port_address
Specifies the TCP/IP port address that is used by the HTTPS secure socket layer (SSL) interface to communicate with the Web client. The range of values is 0 and 1000 through 32767; the default is 0 which disables HTTPS.

Examples

Options file:
Does not apply.

Command line:
-httpsport=1548

Inclexcl

TSM authorized user

The inclexcl option specifies the path and file name of your include-exclude options file, if you use one. Use an include-exclude options file to exclude files from backup and to assign different management classes to specific files or groups of files.

If you have the HSM client installed on your workstation, you can use an include-exclude options file to exclude files from backup and space management, from backup only, from space management only, and to assign management classes to specific files or groups of files.

For information about creating an include-exclude options file, see Chapter 7, Creating an Include-Exclude File.

Ensure that your include-exclude options file is stored in a directory, such as /etc, to which all users have read access.

Note:This option can also be defined on the server.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-INCLExcl- filespec------------------------------------------><
 

Parameters

filespec
Specifies the path and file name of your include-exclude options file.

Examples

Options file:
inclexcl /usr/dsm/backup.excl
inclexcl /etc/inclexcl.def

Command line:
Does not apply.

Include Options

TSM authorized user

The include options specify one of the following:

If you do not assign a specific management class to objects, the default management class in the active policy set of your policy domain is used.

Note:You cannot use the include option to override an exclude.dir option.

See Chapter 7, "Creating an Include-Exclude File" for more information.

Options File

Place this option in the include-exclude options file or the client system options file (dsm.sys).

Syntax

   .- ------------------------------------.
   V                                      |
>>----options pattern-+----------------+--+--------------------><
                      '- mgmtclassname-'
 

Options

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

include.file
Includes a file for backup services, or assigns a management class to a file.

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 parameter is valid for UNIX (AIX, HP-UX, and Solaris) only.

Parameters

pattern
Specifies the objects to include for backup services or to assign a specific management class. End this variable with a file specification.

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.

mgmtclassname
Specifies the name of the management class to assign to the objects. If you do not specify a management class, the default management class is used.

Examples

Options file:
include /home/proj/text/devel.*
include /home/proj/text/* textfiles
include * managall
include.image /home/*/* 

Command line:
Does not apply.

Kernelmessages

Options

TSM authorized user

The kernelmessages option specifies whether to display HSM-related messages during processing.

Note:For transparent recall, if more than one process accesses the same migrated file at one time, the kernel displays a message for the first process that accesses the file only.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.

Syntax

                  .-Yes--.
>>-KERNelmessages-+------+-------------------------------------><
                  '-No---'
 

Parameters

Yes
Displays HSM-related messages sent by the kernel. This is the default.

No
Does not display HSM-related messages sent by the kernel.

Examples

Options file:
kernelmessages no

Command line:
Does not apply.

Largecommbuffers

Options

TSM authorized user

The largecommbuffers option specifies whether the client uses increased buffers to transfer large amounts of data between the client and the server. You can disable this option when your machine is running low on memory.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

                    .-No--.
>>-LARGECOMmbuffers-+-----+------------------------------------><
                    '-Yes-'
 

Parameters

No
Increased buffers are not used to transfer large amounts of data to the server. This is the default.

For AIX, the default is Yes.

Yes
Increased buffers are used to transfer large amounts of data to the server.

This is the default for AIX only.

Examples

Options file:
largecommbuffers yes

Command line:
Does not apply.

Mailprog

Options

TSM authorized user

The mailprog option specifies the program and user ID to which you want to send a newly-generated password when the old one expires. Use this option only when you select generate with the passwordaccess option.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-MAILprog filespec userid------------------------------------><
 

Parameters

filespec
Specifies the path and file name of the program to which you want to send a newly-generated password. The program you specify must accept standard output.

userid
Specifies the user ID of the user to whom you want to send a newly-generated password.

Examples

Options file:
mailprog /usr/bin/xsend root      (for AIX)
Note:Run the enroll command before you use xsend.

Command line:
Does not apply.

Maxcmdretries

TSM authorized user

The maxcmdretries option specifies the maximum number of times the client scheduler (on your workstation) attempts to process a scheduled command that fails. The command retry starts only if the client scheduler has not yet backed up a file, never connected to the server, or failed before backing up a file. This option is used only when the scheduler is running.

Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides what you specify in the client options file after your client node successfully contacts the server.

Note:This option can also be defined on the server.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-MAXCMDRetries- maxcmdretries--------------------------------><
 

Parameters

maxcmdretries
Specifies the number of times the client scheduler can attempt to process a scheduled command that fails. The range of values is zero through 9999; the default is 2.

Examples

Options file:
maxcmdr 4

Command line:
Does not apply.   

Maxrecalldaemons

Options

TSM authorized user

The maxrecalldaemons option specifies the maximum number of HSM recall daemons you want to run at one time to perform recalls for your client node. During normal operations, if the number of recall daemons running at one time is similar to the maximum number permitted, increase the value for the maxrecalldaemons option. For example, if you use an application that opens multiple files at one time, and all of the files it opens are migrated, that application can use all available recall daemons. If you cannot start a recall daemon for another process attempting to access a migrated file, that process stops until a recall daemon is available.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.

Syntax

>>-MAXRECAlldaemons number-------------------------------------><
 

Parameters

number
Specifies the maximum number of recall daemons you want to run at one time to perform recalls. The range of values is 2 through 99; the default is 20.

Examples

Options file:
maxrecalldaemons 5

Command line:
Does not apply.

Maxreconcileproc

Options

TSM authorized user

The maxreconcileproc option specifies the maximum number of reconciliation processes that the HSM program can start at one time.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.

Syntax

>>-MAXRECOncileproc maxreconcileproc---------------------------><
 

Parameters

maxreconcileproc
Specifies the maximum number of reconciliation processes that the HSM program can start at one time. The range of values is 1 through 99; the default is 3.

Examples

Options file:
maxreconcileproc 5

Command line:
Does not apply.

Maxthresholdproc

Options

TSM authorized user

The maxthresholdproc option specifies the maximum number of threshold migration processes that the HSM program can start at one time. When a file system runs out of space, the HSM program does not verify that the maximum number of threshold migration processes currently running. It starts threshold migration as part of the demand migration process regardless of the number of threshold migration processes in progress.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.

Syntax

>>-MAXThresholdproc maxthresholdproc---------------------------><
 

Parameters

maxthresholdproc
Specifies the maximum number of automatic threshold migration processes that HSM can start at one time. The range of values is 1 through 99; the default is 3.

Examples

Options file:
maxthresholdproc 5

Command line:
Does not apply.

Memoryefficientbackup

Options

The memoryefficientbackup option specifies a memory conserving algorithm for processing incremental backups, that backs up one directory at a time, using less memory. Use this option when your machine is memory constrained.

Note:This option can also be defined on the server.

Options File

Place this option in the client options file (dsm.opt).

Syntax

                         .-No--.
>>-MEMORYEFficientbackup-+-----+-------------------------------><
                         '-Yes-'
 

Parameters

No
Your client node uses the faster, more memory-intensive method when processing incremental backups. This is the default.

Yes
Your client node uses the method that requires less memory when processing incremental backups.

Examples

Options file:
memoryefficientbackup yes

Command line:
-memoryef=no

Migfileexpiration

Options

TSM authorized user

The migfileexpiration option specifies the number of days copies of migrated or premigrated files are kept on the server after they are modified on your local file system, or deleted from your local file system.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.

Syntax

>>-MIGFileexpiration days--------------------------------------><
 

Parameters

days
Specifies the number of days a copy of a migrated or premigrated file remains in storage after it is modified on your local file system, or deleted from your local file system. The range of values is zero through 9999; the default is 7.

Examples

Options file:
migfileexpiration 5

Command line:
Does not apply.

Migrateserver

TSM authorized user

The migrateserver option specifies the name of the server to which you want to migrate files from your client node. Specify only one migration server for each client node. Users cannot override the server you specify for migration in a client user options file or when entering a command.

If you do not specify a server with the migrateserver option, your files are migrated to the server specified with the defaultserver option. If you do not specify a server with either of these options, your files are migrated to the server identified in the first stanza of your client system options file.

After your files migrate to the server you specified, do not specify a different migration server, unless your administrator tranfers your migrated files from the specified server to another. Otherwise, the server cannot locate your migrated files until you specify the server to which your files were originally migrated.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.

Syntax

>>-MIGRateserver servername------------------------------------><
 

Parameters

servername
Specifies the name of the server to which you want to migrate files from your client node. Your client system options file must contain a stanza, beginning with the servername option, and containing the required communication options for the server you specify with the migrateserver option.

Examples

Options file:
MIGRATEServer  server_b
 
SErvername     server_a
  COMMmethod                TCPip
  TCPPort                   1500
  TCPServeraddress          almvmd.almaden.ibm.com
  Inclexcl                  /adm/adsm/excl.list
 
SErvername     server_b
  COMMmethod                SNAlu6.2
  PARtnerluname             raptor
  TPname                    appcdel
  CPICMOdename              appc
  Passwordaccess            generate
  Inclexcl                  /adm/adsm/migexl.list
 

Command line:
Does not apply.

Minrecalldaemons

Options

TSM authorized user

The minrecalldaemons option specifies the minimum number of recall daemons you want to run simultaneously to perform recalls for your client node.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.

Syntax

>>-MINRecalldaemons number-------------------------------------><
 

Parameters

number
Specifies the minimum number of recall daemons you want to run at one time to perform recalls. The range of values is 1 through 99; the default is 3.

Examples

Options file:
minrecalldaemons 5

Command line:
Does not apply.

Nfstimeout

Options

The nfstimeout option specifies the number of seconds the server waits for an NFS system call response before it times out. If you do not have any NFS-mounted file systems, or you do not want this time-out option, remove or rename the dsmstat file in the TSM program directory.

Note:This option can also be defined on the server.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza and the client options file (dsm.opt).

Syntax

>>-NFSTIMEout number-------------------------------------------><
 

Parameters

number
Specifies the number of seconds the server waits for an NFS system call response before timing out. The default is 10 seconds. A value of zero results in no timeout.

Examples

Options file:
nfstimeout 10

Command line:
-nfstimeout=10

Nodename

Options

TSM authorized user

The nodename option identifies your workstation to the server. You can use different node names to identify multiple systems on your workstation.

You can also use the nodename option if you want to restore or retrieve files from the server while you are working from a different workstation. When you use the nodename option, you are prompted for the TSM password assigned to the node you specify, if a password is required.

When connecting to a server, the client must identity itself to the server. This login identification is determined in the following manner:

Options File

Place this option in the client system options file (dsm.sys) within a server stanza.

Syntax

>>-NODename- nodename------------------------------------------><
 

Parameters

nodename
Specifies a 1 to 64 character node name for which you want to request TSM services. The default is the name of the machine.

Examples

Options file:
nodename cougar

Command line:
Does not apply.     

Numberformat

Options

The numberformat option specifies the format you want to use to display numbers.

The AIX, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. Solaris and HP-UX clients only support English, Simplified Chinese, and Japanese locale information. The default directories for system-supplied locales are as follows:

The backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. Consult the documentation on your local system for details about setting up your locale definition.

Options File

Place this option in the client options file (dsm.opt).

Syntax

>>-NUMberformat- number----------------------------------------><
 

Parameters

number
Displays numbers using any one of the following formats. Specify the number (1-6) that corresponds to the number format you want to use.

1
1,000.00 (This is the default.)

2
1,000,00

3
1 000,00

4
1 000.00

5
1.000,00

6
1'000,00

For AIX, HP-UX, and Solaris: To define number formats, modify the following lines in the source file of your locale. Whatever format you select applies both to output and to input.

decimal_point
The character that separates the whole number from its fractional part.
thousands_sep
The character that separates the hundreds from the thousands from the millions.
grouping
The number of digits in each group that is separated by the thousands_sep character.

Examples

Options file:
num 4

Command line:
-numberformat=4

Optfile

Options

The optfile option specifies the client user options file you want to use when you start a TSM session.

Syntax

>>-OPTFILE- file_name------------------------------------------><
 

Parameters

file_name
Specifies an alternate client options file, if you use the fully-qualified path name. If you specify only the file name, TSM assumes you want the current directory. The default is dsm.opt.

Examples

Options file:
Does not apply.

Command line:
dsm -optfile=myopts.opt     
dsmc query session -optfile=myopts.opt   

This option is valid only on the initial command line. It is not valid in interactive mode.

Optionformat

Options

The optionformat option specifies the format to use when you specify HSM client commands.

Options File

Place this option in the client options file (dsm.opt). The HSM client must be installed on your workstation.

Syntax

                .- STandard-.
>>-OPTIONFormat-+- SHort----+----------------------------------><
 

Parameters

STandard
Enter HSM client commands in a format similar to backup-archive client commands. This is the default. For example:
   dsmmigrate -Recursive -Detail /home/user1/file1
   dsmmigrate -r -d /home/user1/file1

SHort
Enter HSM client commands in a format similar to your operating system commands. For example:
   dsmmigrate -Rv /home/user1/file1
   dsmmigrate -v -R /home/user1/file1

Refer to Using the UNIX HSM Clients, SH26-4083, for details regarding these two command formats.

Examples

Options file:
optionformat short

Command line:
Does not apply.

Partnerluname

Options

TSM authorized user

The partnerluname option specifies a logical unit name that the transaction program uses to identify the server in the SNA network. The partner logical unit name is used if the symbolic destination name is not provided for SNA LU6.2 communications. If you use this option, also define the cpicmodename and tpname options.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-PARtnerluname- logical_unit_name----------------------------><
 

Parameters

logical_unit_name
Specifies a one- to eight-character logical unit name followed by a period (.), and one- to eight characters that identify the remote target in an SNA network. For example:
   partnerluname nameone.nametwo

Contact your system administrator for this name. There is no default.

Examples

Options file:
partnerlu sanjose.vm

Command line:
Does not apply.   

Password

Options

The password option specifies a TSM password. If this option is not used and your administrator has set authentication to On, you are prompted for a password when you start a TSM session.

Note:If you are prompted for a password, it is not displayed as you enter it. However, if you use the password option, your password is displayed when you enter it.

The password option is ignored when the passwordaccess option is set to generate.

Options File

Place this option in the client options file (dsm.opt).

Syntax

>>-PASsword- password------------------------------------------><
 

Parameters

password
Specifies a 1 to 64 character password. A password is not case-sensitive. Valid characters include:
Characters
Description
A-Z
Any letter, A through Z, uppercase or lowercase
0-9
Any number, 0 through 9
+
Plus
.
Period
_
Underscore
-
Hyphen
&
Ampersand

Examples

Options file:
password secretword

Command line:
-password=secretword

Passwordaccess

Options

TSM authorized user

The passwordaccess option specifies whether you want your TSM password generated automatically, or set as a user prompt. A password is required for your client node only when your administrator enables the authentication feature. Check with your administrator to verify that a password is required for your client node.

If a password is required, you can choose to:

Use the passworddir option in your client system options file to specify the directory location in which to store the encrypted password file. The default directory location depends on how the client was installed.

When the passwordaccess option is set to generate and you specify the password option, the password option is ignored.

When using the HSM client, set the passwordaccess option to generate.

When using the Web client, set the passwordaccess option to generate.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza.

Syntax

                  .-prompt---.
>>-PASSWORDAccess-+----------+---------------------------------><
                  '-generate-'
 

Parameters

prompt
You are prompted for your workstation password each time a client connects to the server. This is the default.

To keep your client node password secure, enter commands without the password, and wait for TSM to prompt you for the password.

Each user must know the TSM password for your client node. Any user who knows the password for your client node can gain access to all backups and archives that originate from your client node. For example:

generate
Encrypts and stores your password locally, and generates a new password when the old password expires. An encrypted password is kept on your workstation when a session starts.

A password prompt displays when registering a workstation with a server using open registration, or if your password was changed manually by the administrator.

You can use the mailprog option to specify a program and user ID that you want TSM to send the new password to each time the old password expires.

Users do not need to know the TSM password for your client node. Any user who knows the password for your client node can access only the backups and archives the user owns and those to which the user is granted access by other users. If a user enters the TSM password for your client node, the user becomes a virtual root user and can access all backups and archives that originated from your client node. If you change the name of your client node (using the nodename option in the dsm.sys file), and the same node name is specified in the dsm.opt file, TSM prompts the users for the TSM password for your client node. If a user enters the correct password, the user becomes a virtual root user. The same is true if a user specifies the same node name using the nodename option with a command.

Examples

Options file:
passwordaccess generate

Command line:
Does not apply.

Passworddir

Options

TSM authorized user

The passworddir option forces the directory location in which to store an encrypted password file. The default directory location depends upon how the client was installed.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-PASSWORDDIR- directoryname----------------------------------><
 

Parameters

directoryname
Specifies the path in which to store the encrypted password file. The actual name of the password file is derived from the servername option.

If root user, the default directory is /etc/security/adsm for AIX and /etc/adsm for other UNIX platforms. If non-root user, the default directory is the directory specified with the DSM_DIR variable. If no directory is specified with the DSM_DIR environment variable, the directory from which the executable was loaded is used.

Examples

Options file:
passworddir /etc/security/adsm    

Command line:
Does not apply.

Postschedulecmd

Options

TSM authorized user

The postschedulecmd option specifies a command that the client program processes after it runs a schedule. The client program waits for the command to complete before it continues with other processing.

If you do not want to wait, specify postnschedulecmd.

Note:The postschedulecmd option (and the postnschedulecmd option) can be defined on the server.

Options File

Place these options in the client system options file (dsm.sys).

Syntax

>>-+-POSTSchedulecmd--+--- "cmdstring"-------------------------><
   '-POSTNschedulecmd-'
 

Parameters

"cmdstring"
Specifies the command to process. You can enter a command after a schedule with this option. Use only one postschedulecmd option.

Use a blank, or null string for cmdstring if you want to prevent any commands from running that the administrator uses for postschedulecmd or preschedulecmd. If you specify a blank, or null string on either option, it prevents the administrator from using a command on both options.

If your administrator uses a blank, or null string on the postschedulecmd option, you cannot run a post-schedule command.

If the command string contains blanks, enclose it in double quotes. If you have double quotes within the command string, use single quotes to enclose them.

Examples

Options file:
postschedulecmd "restart database"

The command string is a valid command for restarting your database.

Command line:
Does not apply.

Preschedulecmd

Options

TSM authorized user

The preschedulecmd option specifies a command that the client program processes before it runs a schedule. The client program waits for the command to complete before it starts the schedule.

If you do not want it to wait, specify prenschedulecmd.

Note:The preschedulecmd option (and the prenschedulecmd option) can also be defined on the server.

Options File

Place these options in the client system options file (dsm.sys).

Syntax

>>-+-PRESchedulecmd--+--- "cmdstring"--------------------------><
   '-PRENSchedulecmd-'
 

Parameters

"cmdstring"
Specifies the command to process. Use only one preschedulecmd option. You can enter a command before a schedule using this option.

Use a blank, or null string for cmdstring if you want to prevent any commands from running that the administrator uses for postschedulecmd and preschedulecmd. If you specify a blank, or null string on either option, it prevents the administrator from using a command on both options.

If your administrator uses a blank, or null string on the preschedulecmd option, you cannot run a pre-schedule command.

If the command string contains blanks, enclose it in double quotes. If you placed double quotes within the command string, use single quotes to enclose them.

Examples

Options file:
preschedulecmd "quiesce database"

The command string is a valid command for quiescing your database.

Command line:
Does not apply.

Queryschedperiod

Options

TSM authorized user

The queryschedperiod option specifies the number of hours you want the client scheduler to wait between attempts to contact the server for scheduled work. This option applies only when you set the schedmode option to polling. This option is used only when the scheduler is running.

Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides the value set in your client options file after your client node successfully contacts the server.

Note:This option can also be defined on the server.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-QUERYSCHedperiod- hours-------------------------------------><
 

Parameters

hours
Specifies the number of hours the client scheduler waits between attempts to contact the server for scheduled work. The range of values is 1 through 9999; the default is 12.

Examples

Options file:
querysch 6

Command line:
-queryschedperiod=8

Quiet

Options

The quiet option prevents messages from displaying on your screen during processing. For example, when you run the incremental, selective, or restore backupset commands, information displays about each file that is backed up. Use the quiet option if you do not want TSM to display this information.

When you use the quiet option, some error information still displays on your screen, and messages are written to log files. If you do not specify quiet, the default option, verbose is used.

Note:Quiet can also be defined on the server and overrides the client setting.

Options File

Place this option in the client options file (dsm.opt).

Syntax

>>-QUIET-------------------------------------------------------><
 

Examples

Options file:
quiet

Command line:
-quiet

Reconcileinterval

Options

TSM authorized user

The reconcileinterval option specifies how often HSM reconciles your file systems. TSM reconciles each file system for which space management is active and builds a new Migration Candidates list.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.

Syntax

>>-RECOncileinterval interval----------------------------------><
 

Parameters

interval
Specifies the number of hours that must elapse between each successive time the file systems are automatically reconciled on your workstation. If you specify a value of zero, your file systems are not automatically reconciled. The range of values is zero through 9999; the default is 24.

Examples

Options file:
reconcileinterval 12

Command line:
Does not apply.

Replace

Options

The replace option specifies what you want the system to do when it restores files that already exist on your workstation. This option applies to the restore, retrieve and restore backupset commands only.

Options File

Place this option in the client options file (dsm.opt).

Syntax

           .-Prompt--.
>>-REPlace-+---------+-----------------------------------------><
           +-All-----+
           +-Yes-----+
           '-No------'
 

Parameters

Prompt
You are prompted whether to overwrite a file that already exists on your workstation. If the existing file read-only, you are prompted whether to overwrite it. This is the default.

All
All existing files are overwritten, including read-only files. If the file is access-denied, you are prompted to skip or overwrite the file. No action is taken on the file until there is a response to the prompt.

Yes
Any existing files are overwritten, except read-only files. If a file is read-only, you are prompted to overwrite the file or skip it. No action is taken on the file until there is a response to the prompt. If the file is access-denied, the file is skipped.

No
Existing files are not overwritten. No prompts are displayed.

Examples

Options file:
replace all

Command line:
-replace=no

Resourceutilization

Options

TSM authorized user

The resourceutilization option regulates the level of resources the TSM server and client can use during processing. For example, a setting of resourceutilization=1 uses less system resources than a setting of resourceutilization=10.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-RESOURceutilization- number---------------------------------><
 

Parameters

number
Specifies the number of sessions opened between the TSM server and client. The range of values is 1 through 10; the default is 2.

Examples

Options file:
resourceutilization 7

Command line:
Does not apply

Restoremigstate

Options

The restoremigstate option specifies whether you want to restore or retrieve stub files or backup-archive versions of migrated and premigrated files during a restore-retrieve operation.

You can restore or retrieve a stub file for a migrated or premigrated file only when:

When a stub file for a migrated file or the original copy of a premigrated file is erased from a local file system, the migrated file is marked for expiration the next time reconciliation is run. When the number of days specified with the migfileexpiration option elapse, the migrated file is removed from storage.

If you specify restoremigstate=Yes (the default), and if the migrated or premigrated file has not expired, the file is restored or retrieved to a stub file, regardless of whether it is marked for expiration.

The restoremigstate option restores a file if it is backed up after migration. If the file is backed up before migration, you cannot restore a stub because a server stub copy does not exist.

Attention:The restoremigstate option does not support hardlinked files. If you want to restore or retrieve a stub file for a hardlinked file, all of the files that are hardlinked together must be deleted from the local file system. When one file in a set of hardlinked files is migrated, all of the hardlinked files in the set become stub files. When you enter the restore command with the restoremigstate option, and restores a stub file for a hardlinked file, the stub file has the same name as the file that was originally migrated. Stub files are not restored for any other files that were previously in the hardlinked set of files.

Options File

Place this option in the client options file (dsm.opt). The HSM client must be installed on your workstation.

Syntax

                      .-Yes--.
>>-RESToremigstate----+------+---------------------------------><
                      '-No---'
 

Parameters

Yes
Restores or retrieves migrated and premigrated files to stub files on the local file system during a restore or retrieve operation. The files remain migrated. This is the default.
Note:A stub file created during a restore or retrieve operation contains the information necessary to recall the migrated file from storage. It does not contain any leading bytes of data from the file. Any recall mode previously set for the migrated file (for example, migrate-on-close or read-without-recall) is not stored in the stub file. The recall mode is set to normal for all files restored or retrieved to stub files.

No
Restores or retrieves backup-archive versions of migrated files to the local file system during a restore or retrieve operation. The files become resident.

Examples

Options file:
restoremigstate yes

Command line:
-restoremigstate=no

Retryperiod

Options

TSM authorized user

The retryperiod option specifies the number of minutes the client scheduler waits between attempts to process a scheduled command that fails, or between unsuccessful attempts to report results to the server. This option is used only when the scheduler is running.

Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides the value specified in your client options file after your client node successfully contacts the server.

Note:This option can also be defined on the server.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-RETRYPeriod- minutes----------------------------------------><
 

Parameters

minutes
Specifies the number of minutes the client scheduler waits between attempts to contact the server, or to process a scheduled command that fails. The range of values is 1 through 9999; the default is 20.

Examples

Options file:
retryp 10

Command line:
Does not apply.   

Revokeremoteaccess

Options

The revokeremoteaccess option restricts an administrator with client access privilege from accessing a client workstation that is running the Web client. This option does not restrict administrators with client-owner, system, or policy privilege from accessing your workstation through the Web client.

Options File

Place this option in the client options file (dsm.opt) and the client system options file (dsm.sys).

Syntax

                      .-None---.
>>-REVOKEremoteaccess-+--------+-------------------------------><
                      '-Access-'
 

Parameters

None
Does not revoke access to administrators who have client access authority for the client. This is the default.

Access
Revokes access to administrators who have client access authority for the client.

Examples

Options file:
revokeremoteaccess none

Command line:
Does not apply

Schedlogname

Options

TSM authorized user

The schedlogname option specifies the path and file name where you want to store schedule log information. This option applies when the scheduler is running.

When you run the schedule command, output from scheduled commands displays on your screen. Output is also sent to the file you specified with this option.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-SCHEDLOGName- filespec--------------------------------------><
 

Parameters

filespec
Specifies the path and file name where you want TSM to store schedule log information when processing scheduled work.

If you specify a file name only, the file is stored in your current directory. The default is the installation directory with a file name of dsmsched.log.

Examples

Options file:
schedlogname /home/mydir/schedlog.jan     

Command line:
Does not apply.     (for UNIX)

Schedlogretention

Options

TSM authorized user

The schedlogretention option specifies the number of days to keep entries in the schedule log, and whether to save the pruned entries. The schedule log is pruned after a scheduled event completes.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

                        .-N----.   .-D--.
>>-SCHEDLOGRetention----+------+---+----+----------------------><
                        '-days-'   '-S--'
 

Parameters

N  or  days
Specifies how long to wait before pruning the schedule log.

N
Do not prune the log. This permits the log to grow indefinitely. This is the default.

days
Specifies the number of days to keep log file entries before pruning. The range of values is zero through 9999.

D  or  S
Specifies whether to save the pruned entries. Use a space or comma to separate this parameter from the previous one.

D
Discards the log entries when pruning the log. This is the default.

S
Saves the log entries when pruning the log.

Pruned entries are copied from the log to the dsmsched.pru file that is stored in the same directory as the schedule log.

Examples

Options file:
schedlogretention 30 S

Command line:
Does not apply.   

Schedmode

Options

TSM authorized user

Note:This option applies only if you are using the TCP/IP communication method, and the schedule command is running.

The schedmode option specifies whether you want to use the client-polling mode (your client node periodically asks the server for scheduled work), or the server-prompted mode (the server contacts your client node when it is time to start a scheduled operation). All communication methods can use the client polling mode, but only TCP/IP can use the server prompted mode.

Your administrator can specify that the server support either mode or one mode. If your administrator specifies either mode, you can select the schedule mode. If your administrator specifies only one mode, specify that same mode in your client options file, or scheduled work will not process.

If the schedule mode is prompted, supply values for the tcpclientaddress and tcpclientport options on the schedule command. You can then be contacted at an address or port other than the one that made first contact with the server.

Note:This option can also be defined on the server.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

             .-POlling--.
>>-SCHEDMODe-+----------+--------------------------------------><
             '-PRompted-'
 

Parameters

POlling
The client scheduler queries the server for scheduled work at prescribed time intervals. Set the time intervals using the queryschedperiod option. This is the default.

PRompted
The client scheduler waits for the server to contact your client node when scheduled work needs to be done.

Examples

Options file:
schedmode prompted

Command line:
-schedmod=po

Scrolllines

Options

The scrolllines option specifies the number of lines you want to appear at one time when lists of information display on your screen. Use this option when you set the scrollprompt option to Yes, and you use commands.

Note:This option can also be defined on the server.

Options File

Place this option in the client options file (dsm.opt).

Syntax

>>-SCROLLLines- number-----------------------------------------><
 

Parameters

number
Specifies the number of lines you want to display at one time when lists of information display on your screen. The range of values is 1 through 80; the default is 20.

Examples

Options file:
scrolllines 25

Command line:
-scrolll=25

Scrollprompt

Options

The scrollprompt option specifies whether you want the client program to stop and wait after displaying the number of lines you indicated with the scrolllines option, or if you want the client program to scroll through all lines and stop at the end of the list.

Note:This option can also be defined on the server.

Options File

Place this option in the client options file (dsm.opt).

Syntax

                .-No--.
>>-SCROLLPrompt-+-----+----------------------------------------><
                '-Yes-'
 

Parameters

No
Scrolls to the end of the list and stops. This is the default.

Yes
Stops and waits after displaying the number of lines you indicated with the scrolllines option. The following prompt displays at the bottom of the screen:
   Press 'Q' to quit, 'C' to continuous scroll, or 'Enter' to continue.

Examples

Options file:
scrollprompt yes

Command line:
-scrollp=yes

Servername

Options

In your client system options file (dsm.sys), the servername option specifies the name you want to use to identify a server, and to begin a stanza containing options for that server. You can name and specify options for more than one server.

The following example demonstrates how to specify options for two different servers:

   SErvername     server_a
     COMMmethod                TCPip
     TCPPort                   1500
     TCPServeraddress          almvmd.almaden.ibm.com
     Passwordaccess            prompt
     Groups                    adsm
     Users                     sullivan  mushock  tallan
     Inclexcl                  /adm/adsm/backup.excl
 
   SErvername     server_b
     COMMmethod                SNAlu6.2
     PARtnerluname             raptor
     TPname                    appcdel
     CPICMOdename              appc
     Passwordaccess            generate
     Mailprog                  /usr/bin/xsend root
     Groups                    system adsm
     Inclexcl                  /adm/adsm/archive.excl

In your client options file (dsm.opt), the servername option specifies which server, of those named in dsm.sys, to contact for backup-archive services. When specified in a client options file or on the command line, the servername option overrides the default server specified in your client system options file.

Note:You cannot use the servername option to override the server that is specified for migration in your client system options file.

Options File

Place this option in both the client options file (dsm.opt) and the client system options file (dsm.sys).

Syntax

>>-SErvername servername---------------------------------------><
 

Parameters

servername
In your client system options file (dsm.sys), specify the name you want to assign to a particular server. In your client options file (dsm.opt) or on the command line, specify the name of the server you want to contact for backup-archive services. A server name is not case-sensitive; it can be as many as 64 characters.

Examples

Options file:
servername server_a

Command line:
-se=server_b

This option is valid only on the initial command line. It is not valid in interactive mode.

Shmport

Options

TSM authorized user

The shmport option specifies the TCP/IP port address that the server is listening on to establish a shared memory connection. See "Communication Options" for a list of clients on which the shared memory communication is supported. To use shared memory, TCP/IP must be installed on your workstation.

Note:The value specified for the shmport option in the client system options file must match the value specified for shmport in the server options file.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-SHMPort port_address----------------------------------------><
 

Parameters

port_address
Specifies the TCP/IP address that the server is listening on to establish a shared memory connection. The range of values is 1000 through 32767; the default is 1510.

Examples

Options file:
shmport 1520

Command line:
Does not apply.

Subdir

Options

The subdir option specifies whether you want to include subdirectories of named directories on the following commands:

Archive
Delete Archive
Incremental
Query Archive
Query Backup

Restore
Restore Backupset
Retrieve
Selective

Note:This option can also be defined on the server.

Options File

Place this option in the client options file (dsm.opt).

Syntax

          .-No--.
>>-SUbdir-+-----+----------------------------------------------><
          '-Yes-'
 

Parameters

No
Subdirectories are not processed. This is the default.

Yes
Subdirectories are processed. Because the client program searches all subdirectories of a directory that is processing, it can take longer to complete the requested task than if subdir were set to No. Specify Yes only when necessary.
Note:If you use the preservepath option in addition to subdir=yes, it can affect which subdirectories are are processed.

If a subdirectory is a mounted file system, it is not processed even if subdir is Yes.

Examples

Options file:
subdir no

Command line:

To restore the structure:

/path2/dir1
/path2/dir1/file1
/path2/dir1/dir2
/path2/dir1/dir2/file1

enter any of the following commands:

dsmc rest "/path/dir1/*" /path2/ -su=yes
dsmc rest "/path/dir1/file*" /path2/ -su=yes
dsmc rest "/path/dir1/file1*" /path2/ -su=yes 

Symbolicdestination

Options

TSM authorized user

The symbolicdestination option specifies a symbolic server name. Contact your administrator for the correct name. The symbolic destination name indexes SNA routing and security parameters that are stored in communication directory files.

When a symbolic destination is used with the commmethod option for SNA LU6.2 communication, you do not need to specify the tpname, partnerluname, or cpicmodename options.

This option is required if your communication protocol is SNA LU6.2 and a transaction program name or partner logical unit name is not provided.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-SYMbolicdestination- sym_dest_name--------------------------><
 

Parameters

sym_dest_name
Specifies a one- to eight-character symbolic destination name for the server. Contact your administrator for this name. There is no default.

Examples

Options file:
symbolicdestination adsm

Command line:
Does not apply.   

Tapeprompt

Options

The tapeprompt option specifies whether you want to wait for a tape to mount if it is required for a backup, archive, restore, or retrieve process, or to be prompted for a choice. If you have the HSM client installed on your workstation, the tapeprompt option also specifies whether you want to wait for a tape to mount if it is required for selective migration.

Tape prompting does not occur during a scheduled operation regardless of the setting for the tapeprompt option.

Note:This option can also be defined on the server.

Options File

Place this option in the client options file (dsm.opt).

Syntax

              .-No--.
>>-TAPEPrompt-+-----+------------------------------------------><
              '-Yes-'
 

Parameters

No
You are not prompted for your choice. The server waits for the appropriate tape to mount. This is the default.

Yes
You are prompted when a tape is required to back up, archive, restore, or retrieve data. At the prompt, you can wait for the appropriate tape to be mounted, always wait for a tape to be mounted, skip a particular object, skip all objects on a single tape, skip all objects on all tapes, or cancel the entire operation.

Examples

Options file:
tapeprompt yes

Command line:
-tapep=yes

Tcpbuffsize

Options

TSM authorized user

The tcpbuffsize option specifies the size to use for the internal TCP/IP communication buffer. Although it uses more memory, a larger buffer can improve communication performance.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-TCPBuffsize- size-------------------------------------------><
 

Parameters

size
Specifies the size, in kilobytes, that you want to use for the internal TCP/IP communication buffer. The range of values is one through 512; the default is 31.

As a result of the operating system communication settings, your system might not accept all values in the range of one through 512.

Examples

Options file:
tcpb 2

Command line:
-tcpb=32   

This option is valid only on the initial command line. It is not valid in interactive mode.

Tcpclientaddress

Options

TSM authorized user

The tcpclientaddress option specifies a TCP/IP address if your client node has more than one address, and you want the server to contact an address other than the one that was used to make the first server contact.

Use this option only if you use the prompted parameter with the schedmode option, or when the schedule command is running.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-TCPCLIENTAddress- client_address----------------------------><
 

Parameters

client_address
Specifies the TCP/IP address you want the server to use to contact your client node. Specify a TCP/IP Internet domain name or a dot address.

Examples

Options file:
tcpclienta dsmclnt.sanjose.ibm.com

Command line:
-tcpclientaddress=128.33.10.249   

This option is valid only on the initial command line. It is not valid in interactive mode.

Tcpclientport

Options

TSM authorized user

The tcpclientport option specifies a different TCP/IP port number for the server to contact other than the one that was used to make the first server contact. If the default port or the specified port is busy, the server attempts to use any other available port. Use this option only if you specify the prompted parameter with the schedmode option, or when the schedule command is running.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-TCPCLIENTPort- client_port_address--------------------------><
 

Parameters

client_port_address
Specifies the TCP/IP port address you want the server to use to contact your client node. The range of values is 1000 through 32767; the default is 1501.

Examples

Options file:
tcpclientp 1502

Command line:
-tcpclientport=1492   

This option is valid only on the initial command line. It is not valid in interactive mode.

Tcpnodelay

Options

TSM authorized user

Note:This option is for an AIX client only. All other UNIX clients buffer small transactions before sending them to the server.

The tcpnodelay option has a transaction sent immediately to the server, rather than having small transactions buffered before sending. A small transaction is one that is smaller than the byte limit set with the txnbytelimit option. The tcpnodelay option might improve performance in higher-speed networks.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

               .-No--.
>>-TCPNodelay--+-----+-----------------------------------------><
               '-Yes-'
 

Parameters

No
Do not send small transactions without buffering them first. This is the default.

Yes
Send small transactions without buffering them first. When you set the tcpnodelay option to Yes, data packets less than the maximum transmission unit (MTU) size are sent immediately. The tcpnodelay option might improve performance in higher-speed networks.

Examples

Options file:
tcpnodelay yes

Command line:
Does not apply.

Tcpport

Options

TSM authorized user

The tcpport option specifies a TCP/IP port address for a server. Obtain this address from your administrator.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-TCPPort- port_address---------------------------------------><
 

Parameters

port_address
Specifies the TCP/IP port address that is used to communicate with a server. The range of values is 1000 through 32767; the default is 1500.

Examples

Options file:
tcpp 1501

Command line:
Does not apply   

This option is valid only on the initial command line. It is not valid in interactive mode.

Tcpserveraddress

Options

TSM authorized user

The tcpserveraddress option specifies the TCP/IP address for a server. Obtain this server address from your administrator.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-TCPServeraddress- server_address----------------------------><
 

Parameters

server_address
Specifies a 1 to 64 character TCP/IP address for a server. Specify a TCP/IP domain name or a dot address.

Examples

Options file:
tcps dsmchost.endicott.ibm.com

Command line:
-tcpserveraddress=129.33.24.99   

This option is valid only on the initial command line. It is not valid in interactive mode.

Tcpwindowsize

Options

TSM authorized user

The tcpwindowsize option specifies the amount of data in kilobytes that is buffered when receiving data on a TCP/IP connection. To improve backup or archive performance, increase the tcpwindowsize on the TSM server. To improve restore or retrieve performance, increase the tcpwindowsize on the TSM client. For more information about improving communication performance, see the ADSM Performance Tuning Guide at URL: http://www.tivoli.com/tsm.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-TCPWindowsize- window_size----------------------------------><
 

Parameters

window_size
Specifies the size, in kilobytes, to use for your client node TCP/IP sliding window.

The range of values is one through 2048; the default is 32. For Solaris the maximum value is 1024.

Note:As a result of the operating system communication settings, your system might not accept all values in the range of values.

Examples

Options file:
tcpwindowsize 1

Command line:
-tcpw=24   

This option is valid only on the initial command line; not in interactive mode.

Timeformat

Options

The timeformat option specifies the format in which you want system time displayed.

The AIX, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. Solaris and HP-UX clients only support English, Simplified Chinese, and Japanese locale information. The default directories for system-supplied locales are as follows:

The backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. Consult the documentation on your local system for details about setting up your locale definition.

Options File

Place this option in the client options file (dsm.opt).

Syntax

>>-TIMEformat- format_number-----------------------------------><
 

Parameters

format_number
Displays time in one of the formats listed below. Select the format number that corresponds to the format you want to use.

0
Use the locale-defined time format.

For AIX, HP-UX, and Solaris: This is the default if the locale-specified format consists of digits, separator characters, and, if applicable, the AM or PM string.

1
23:00:00 This is the default.

For AIX, HP-UX, and Solaris: This is the default if the locale-specified format does not consist of digits, separator characters, and, if applicable, the AM or PM string.

2
23,00,00

3
23.00.00

4
12:00:00A/P

For AIX, HP-UX, and Solaris: To set a particular time format, edit the source file for your locale and modify the t_fmt line to support your needs. Whatever time format you select applies both to output and to input.

"%H:%M:%S"
Displays time in the form hh:mm:ss with hh ranging from 0 through 23.
"%H,%M,%S"
Displays time in the form hh,mm,ss with hh ranging from 0 through 23.
"%I,%M,%P"
Displays time in the form hh,mm,ss with hh ranging from 1 through 12. The "%p" represents the am and pm designator.

Examples

Options file:
timeformat 4

Command line:
-time=3

Tpname

Options

TSM authorized user

The tpname option specifies a symbolic name for the transaction program name. The transaction program name is required if the symbolic destination name is not provided for SNA LU6.2 communication.

If you use this option, define the cpicmodename and partnerluname options also.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-TPname- tp_name---------------------------------------------><
 

Parameters

tp_name
Specifies a one- to 64-character transaction program name of the target logical unit (the server). Contact your administrator for this name. There is no default.

Examples

Options file:
tpname adsm

Command line:
-tp=adsm   

This option is valid only on the initial command line. It is not valid in interactive mode.

Txnbytelimit

Options

TSM authorized user

The txnbytelimit option specifies the number of kilobytes the client program should buffer before it sends a transaction to the server.

Note:This option is adjusted by the server as required during self-tuning operations.
A transaction is the unit of work exchanged between the client and server. Because the client program can transfer more than one file or directory between the client and server before it commits the data to server storage, a transaction can contain more than one file or directory. This is called a transaction group.

This option permits you to control the amount of data sent between the client and server before the server commits the data and changes to the server database, thus changing the speed with which the client performs work. The amount of data sent applies when files are batched together during backup or when receiving files from the server during a restore procedure.

The server administrator can limit the number of files or directories contained within a group transaction using the txngroupmax option; the actual size of a transaction can be less than your limit. Once this number is reached, the client sends the files to the server even if the transaction byte limit is not reached.

Note:This option can also be defined on the server and adjusted as required during self-tuning operations.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

>>-TXNBytelimit- number----------------------------------------><
 

Parameters

number
Specifies the number of kilobytes the client program can buffer together in a transaction before it sends data to the server. The range of values is 300 through 25600 (25 MB); the default is 2048.

Examples

Options file:
txnb 2048

Command line:
-txnb=2048

This option is valid only on the initial command line; not in interactive mode.

Users

TSM authorized user

The users option authorizes specific users on your workstation to request services from a server. You can use this option more than once to specify a large number of user IDs. If you do not specify group names with the groups option, or user IDs with the users option, all users can request TSM services. If you use the groups option, the users option, or both, only users included in one of the specified groups, or included in the list of users, can request TSM services.

Define your root user name only with the users option to exclude all other users from accessing the server.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

   .- -----------------------.
   |        .- -----------.  |
   V        V             |  |
>>----USERs---- username--+--+---------------------------------><
 

Parameters

username
Names a user that you want to authorize to request TSM services.

Examples

Options file:
users  carol  larry  davecd  kathyba  michelle
users  amyb  tkaspar  kbsmith  egray  srjames

Command line:
Does not apply.

Verbose

Options

The verbose option specifies that you want processing information to display on your screen. This is the default. Specify the quiet option if you do not want processing information to display on your screen.

If either the quiet or verbose option is specified in the server client option set, then the server setting overrides the quiet or verbose option specified on the client, even if force is set to No on the server.

Note:This option can also be defined on the server and overrides the client setting.

Options File

Place this option in the client options file (dsm.opt).

Syntax

>>-VErbose-----------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Options file:
verbose

Command line:
-verbose

Virtualmountpoint

TSM authorized user

The virtualmountpoint option defines a virtual mount point for a file system if you want to consider files for backup that begin with a specific directory within that 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 it is to define that file system using the domain option, and then to use the exclude option in your include-exclude options file to exclude the files that you do not want to back up.

Use the virtualmountpoint option to define virtual mount points for multiple file systems, for local and remote file systems, and to define more than one virtual mount point within the same file system. Virtual mount points cannot be used in a file system handled by automounter. Use the AFS/DFS backup clients to process virtual mount points for AFS/DFS file systems.

Note:If the directory that you want to specify as a virtual mount point is a symbolic link, set the followsymbolic option to Yes. If that option is set to No (the default), you are not permitted to use a symbolic link as a virtual mount point.

After you define a virtual mount point, you can specify the path and directory name with the domain option in either the default client options file, or on 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 options files and on the incremental command.

Options File

Place this option in the client system options file (dsm.sys).

Syntax

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

Parameters

directory
Specifies the path and directory name for the directory you want to use as the virtual mount point for a file system. You cannot use wildcard characters in either the path or directory names.

Define only one virtual mount point with each virtualmountpoint option that 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 that you want to use.

Examples

Options file:
virtualmountpoint /afs/xyzcorp.com/home/ellen/
virtualmountpoint /afs/xyzcorp.com/home/ellen/test/data/

Command line:
Does not apply.

Virtualnodename

Options

The virtualnodename option identifies your workstation to the server. You can use different node names to identify multiple systems on your workstation. You can also use the virtualnodename option if you want to restore or retrieve files from the server while you work at a different workstation. When you use the virtualnodename option, you are prompted for the TSM password assigned (if one is required) to the node you specify, because TSM must scan all the files in the file system to determine if they should be excluded.

In your client options file (dsm.opt) or in a command, use the virtualnodename option only when you want to request services for a different client node than the one on which you are working (the one specified in your client system options file). When you use the virtualnodename option in your client options file or with a command:

When connecting to a server, the TSM client must identity itself to the server. This login identification is determined in the following ways:

Options File

Place this option in the client options file (dsm.opt).

Syntax

>>-VIRTUALNodename- nodename-----------------------------------><
 

Parameters

nodename
Specifies a one- to 64-character name that identifies the node for which you want to request TSM services. There is no default.

Examples

Options file:
virtualnodename cougar

Command line:
-virtualn=banshee


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