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:
During the installation of TSM, you are provided with a sample client options file called dsm.smp. This file contains processing options that are categorized as follows:
When the installation process completes, the setup wizard is launched automatically if no dsm.opt file is present, to help you configure an initial options file. You can also create your own options file by selecting the Utilities menu> Setup Wizard item.
You can also copy the sample options file, dsm.smp, to dsm.opt, or a name of your choice, and modifying the required options in the new copy. Required options provide information that the backup-archive client program needs to establish communication with a server.
The default location for the client options file is the installation directory, tsmcli. During installation, you can select a different name and location for your client options file. The environment variable, DSM_CONFIG, points to the directory where your client options file is located.
To view or modify the client options file, select the Edit menu> Preferences item on the backup-archive GUI. The Preferences editor updates the client configuration file, if any options have changed.
The Preferences editor groups the options in the following categories:
Some options are used only with commands. For more information about these options, see Chapter 9, "Using Options With Commands".
You use communication options to specify how your client node communicates with a TSM server.
For OS/2 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.
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.
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 |
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 |
The communication options for IPX/SPX have default values which can
be modified.
Option | Description | Page |
---|---|---|
ipxbuffersize | Specifies the size, in kilobytes, of the IPX/SPX communication buffer. | Ipxbuffersize |
ipxserveraddress | Specifies the IPX/SPX address for a TSM server. | Ipxserveraddress |
ipxsocket | Specifies the IPX/SPX socket number for a TSM server. | Ipxsocket |
The communication option for Named Pipes is:
Table 11. Named Pipes Communication Option
Option | Description | Page |
---|---|---|
namedpipename | Specifies the name of a named pipe to use for communications between a TSM client and a TSM server on the same Windows workstation. | Namedpipename |
The communication options for NETBIOS have default values which can be
modified.
Table 12. NETBIOS Communication Options
Option | Description | Page |
---|---|---|
lanadapter | Specifies a communication adapter number for NETBIOS. | Lanadapter |
netbiosbuffersize | Specifies the size, in kilobytes, of the NETBIOS communication buffer. | Netbiosbuffersize |
netbiosname | Specifies a NETBIOS name for your workstation. | Netbiosname |
netbiosservername | Specifies the NETBIOS name for a TSM server. | Netbiosservername |
netbiostimeout | Specifies the number of seconds that must elapse before a timeout occurs for a NETBIOS send or receive operation. | Netbiostimeout |
To use SNA LU6.2 you must include either the
symbolicdestination option or all three of the following
options: cpicmodename, partnerluname, and
tpname.
Table 13. 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 |
TCP/IP must be installed on your workstation to use the shared memory
communication method.
Table 14. 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 |
shmqueuename | Specifies the name of the TSM server's shared memory queue. | Shmqueuename |
You can use the following option to specify the client node for which you
want to request backup-archive services.
Table 15. Server and Node Options
Option | Description | Page |
---|---|---|
nodename | Specifies one of the following:
| Nodename |
You can use the following options to control some aspects of backup and
archive processing.
Table 16. Backup and Archive Processing Options
Option | Description | Page |
---|---|---|
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. | 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 drives to include in your default client domain for an incremental backup. | Domain |
exclude | Excludes a file or group of files from backup services. Any file in your client domain that is not specifically excluded with this option is considered for backup. | Exclude Options |
exclude.archive | Excludes a file or group of files from archive services. | Exclude Options |
exclude.backup | Excludes a file or a group of files from backup services only. | 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 |
guitreeviewafterbackup | Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. | Guitreeviewafterbackup |
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 |
memoryefficientbackup | Specifies a memory-saving backup algorithm for incremental backups for use with the incremental command. | Memoryefficientbackup |
os2lanservacpsupport | Specifies the OS/2 Lan Server local and network attached drives from which ACL data associated with files and directories is backed up. | Os2lanservacpsupport |
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 |
The following options relate to restore and retrieve processing.
Table 17. Restore and Retrieve Processing Options
Option | Description | Page |
---|---|---|
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 |
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 |
You can use the following options to regulate central scheduling.
TSM uses scheduling options only when the Scheduler is running.
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/Postnschedulecmd |
preschedulecmd, prenschedulecmd | Specifies a command to process before running a schedule. | Preschedulecmd/Prenschedulecmd |
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 |
You can use the following options to select different formats for date,
time, numbers, and different languages if you have the appropriate client
installed for that language.
Table 19. Format and Language Options
Option | Description | Page |
---|---|---|
dateformat | Specifies the format for displaying dates. | Dateformat |
language | Specifies the language used for messages. | Language |
numberformat | Specifies the format for displaying numbers. | Numberformat |
timeformat | Specifies the format for displaying times. | Timeformat |
The following options apply only when you use certain TSM commands.
Table 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 |
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 |
These options control access to a TSM server.
Table 21. Authorization Options
Option | Description | Reference |
---|---|---|
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 |
These options specify the name of the error log file and how TSM treats the
entries in the log file.
Table 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 |
These options control how TSM processes transactions between the client and
server.
Table 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 |
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 |
The following are options for the TSM Web Client.
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 |
This section describes how to set options in your client options file, and how to use options with commands.
To set an option in your client options file, enter the option name, followed by one or more blank spaces, followed by the option value. For example:
compression yes nodename client_a
Some options consist of only the option name, such as verbose and quiet. You can enter the entire option name, or its abbreviation. For example, you can specify the verbose option as either of the following:
verbose ve
Follow these additional rules when entering options in your client options file:
If you update the client options file while a GUI or Web client session is active, you must restart the session to pick up the changes.
You can override some of the options in your options file by entering them with appropriate backup-archive commands.
Options are processed in the following order (precedence):
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=c:
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".
Follow these general rules to enter options with a command:
dsmc selective -subdir=yes c:\devel\proj1\* dsmc selective c:\devel\proj1\* -subdir=yes
dsmc archive -description="Project A" c:\devel\proj1\*
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 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. Use this option with the archive, incremental, and selective commands.
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. |
Syntax
.-----------------. V | >>-CHAngingretries----numberretries--+-------------------------><
Parameters
Examples
The commmethod option specifies the communication method you use to provide connectivity for client-server communication.
Syntax
>>-COMMMethod-+- TCPip------+---------------------------------->< +- IPXspx-----+ +- NAMedpipes-+ +- NETBios----+ +- SHAREdmem--+ '- SNALu6.2---'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The commrestartduration option specifies the maximum number of minutes you want the client to spend in an attempt to reconnect with a server after a communication error occurs.
Note: | When a schedule is running, the connection and schedule fail if a communication failure occurs and the client cannot reconnect with the server before the startup window for the schedule ends. |
You can use the commrestartduration option and the commrestartinterval in busy or unstable network environments to decrease connection failures.
Syntax
>>-COMMRESTARTDuration- minutes--------------------------------><
Parameters
Examples
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. |
You can use the commrestartduration option and the commrestartinterval in busy or unstable network environments to decrease connection failures.
Syntax
>>-COMMRESTARTInterval- seconds--------------------------------><
Parameters
Examples
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.
The compressalways option is used with the archive, incremental, and selective commands.
Note: | This option can also be defined on the server. |
Syntax
.-Yes--. >>-COMPRESSAlways-+------+------------------------------------->< '-No---'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in loop or interactive mode.
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.
The compression option is used with the archive, incremental, and selective commands.
Note: | This option can also be defined on the server. |
Syntax
.-No--. >>-COMPRESSIon-+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
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.
Syntax
>>-CPICBuffersize- size----------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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 remote systems.
If you use this option, you must also use the tpname and partnerluname options.
Syntax
>>-CPICModename- name------------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The dateformat option selects the format you want to use to display dates.
Note: | When the date format is changed and the schedlogretention option is used to prune the schedule log, all entries in the schedule log with a different date format are removed when the log is pruned. When the date format is changed and the errorlogretention option is used to prune the error log, then all entries in the error log with a different date are removed when the log is pruned. When changing the date format, copy the schedule log and error log if you wish to preserve log entries that contain a different date format. |
Syntax
>>-DATEformat- format_number-----------------------------------><
Parameters
Examples
This option is valid on the initial command line and in interactive mode.
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. |
Syntax
>>-DIRMc- mgmtclassname----------------------------------------><
Parameters
Examples
The domain option specifies the drives that you want to include for incremental backup in your client domain. This option can also be defined on the server.
When used in your client options file , the domain option defines your default client domain. TSM uses your default client domain in the following situations to determine which local drives to process during an incremental backup:
If you do not use the domain option to specify local drives 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 local drives 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 c: d: e:
and the following on the command line:
dsmc incremental -domain="g: h:"
An incremental backup is performed for your c: d: e: g: and h: local drives.
If you use both a file specification and the domain option with the incremental command to specify drives to process, the domain option is ignored and only those drives specified in the file specification are processed. For example, if you enter:
dsmc incremental e: f: -domain="g: h:"TSM performs an incremental backup for the e: and f: drives only.
Note: | The Linux and OS/390 UNIX clients are not enabled for automounter support. |
Syntax
.- ----------------. V .-all-local--. | >>-DOMain-----+------------+--+-------------------------------->< '-domain-----'
Parameters
When you use domain with the incremental command, it processes these drives in addition to those specified in your default client domain.
Examples
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 workstation setting, we recommend that you turn off this function.
Syntax
.-Yes--. >>-EDitor-+------+--------------------------------------------->< '-No---'
Parameters
Examples
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.
Syntax
>>-ERRORLOGName- filespec--------------------------------------><
Parameters
The default is the path indicated by the DSM_LOG environment variable. If DSM_LOG is not specified, the dsmerror.log file is located in the default installation directory. For UNIX: The dsmerror.log file cannot be a symbolic link.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The errorlogretention option specifies how many days to maintain error log entries before pruning, 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.
Syntax
.-N----. .-D--. >>-ERRORLOGRetention--+------+---+----+------------------------>< '-days-' '-S--'
Parameters
The pruned entries are copied from the error log to the dsmerlog.pru file located in the same directory as the error log.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The exclude options exclude objects from backup, 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 that could corrupt the operating system when recovered. The client directory where TSM is stored should be excluded, also.
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 become inactive 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 c:\any\test
To exclude subdirectories that begin with test under the any directory, enter the following:
exclude.dir c:\any\test*
Syntax
.- -----------------. V | >>----options pattern--+---------------------------------------><
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.
Parameters
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.
Examples
exclude ?:\...\swapper.dat exclude "*:\ea data. sf" exclude ?:\io.sys exclude ?:\...\spart.par exclude c:\*\budget.fin exclude c:\devel\* exclude.dir c:\home\jodda exclude.archive c:\home\*.obj
The guitreeviewafterbackup option specifies whether the client returns to the Backup, Restore, Archive, or Retrieve window after a successful operation completes.
Syntax
.-No--. >>-GUITREEViewafterbackup-+-----+------------------------------>< '-Yes-'
Parameters
Examples
The httpport option specifies a TCP/IP port address for the Web client.
Syntax
>>-HTTPport- port_address--------------------------------------><
Parameters
Examples
The httpsport option specifies a TCP/IP port address for the HTTPS secure socket layer (SSL) interface to the Web client.
Syntax
>>-HTTPSport- port_address-------------------------------------><
Parameters
Examples
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 List" for more information.
Syntax
.- ------------------------------------. V | >>----options pattern-+----------------+--+-------------------->< '- mgmtclassname-'
Parameters
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.
Examples
include c:\proj\text\devel.* include c:\proj\text\* textfiles include ?:* managall
Does not apply.
The ipxbuffersize option specifies the IPX buffer size needed to transfer data between the client node and the server. A larger buffer can improve communication performance, but uses more memory.
Syntax
>>-IPXBuffersize- size-----------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The ipxserveraddress option specifies the IPX/SPX address of a server on an OS/2 or AIX host that is not in the same network as the client node. If the IPX/SPX address is not specified, the server must be in the same network as the client node.
Syntax
>>-IPXSErveraddress- server_address----------------------------><
Parameters
If an IPX/SPX address is not specified, the default address for the server is the same address as the client workstation.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The ipxsocket option specifies the socket number for a server on a OS/2 host.
Syntax
>>-IPXSOcket- socketnumber-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The lanadapter option specifies a communication adapter number when you use the NETBIOS communication method.
Syntax
>>-LANAdapter- adapter_number----------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The language option specifies the national language in which to present client messages.
You can use American English (AMENG) with all clients.
Syntax
>>-LANGuage- language------------------------------------------><
Parameters
Examples
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.
Syntax
.-No--. >>-LARGECOMmbuffers-+-----+------------------------------------>< '-Yes-'
Parameters
Examples
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. |
Syntax
>>-MAXCMDRetries- maxcmdretries--------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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 with the incremental command when your machine is memory constrained.
Note: | This option can also be defined on the server. |
Syntax
.-No--. >>-MEMORYEFficientbackup-+-----+------------------------------->< '-Yes-'
Parameters
Examples
The namedpipename option specifies the name of a named pipe to use for communications between a client and a server on the same workstation.
Syntax
>>-NAMedpipename- name-----------------------------------------><
Parameters
Examples
The netbiosbuffersize option specifies the size, in kilobytes, that you want to use for the NETBIOS communication buffer.
Syntax
>>-NETBIOSBuffersize- size-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The netbiosname option specifies a NETBIOS name for your workstation.
Syntax
>>-NETBIOSName- name-------------------------------------------><
Parameters
The default is TSM concatenated to a time-of-day value.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The netbiosservername option specifies a NETBIOS name for a server.
Syntax
>>-NETBIOSServername- name-------------------------------------><
Parameters
The default is adsmserv1.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The netbiostimeout option specifies the number of seconds that elapse before a timeout occurs for a NETBIOS send or receive. If your LAN environment has slow response times or you are backing up directly to tape, we recommend that you use a value of zero.
Syntax
>>-NETBIOSTimeout- seconds-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The nodename option identifies your workstation to the server. You can use different node names to identify multiple systems on your workstation. For example, if your machine is running Windows and OS/2, you can specify winuser for the Windows client system, and os2user for the OS/2 client system.
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.
Note: | The machine name is not necessarily the TCP/IP host name. |
Syntax
>>-NODename- nodename------------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The numberformat option specifies the format you want to use to display numbers.
Syntax
>>-NUMberformat- number----------------------------------------><
Parameters
Examples
This option is valid on the initial command line and in interactive mode.
The optfile option specifies the client options file you want to use when you start a TSM session.
Syntax
>>-OPTFILE- file_name------------------------------------------><
Parameters
Examples
dsmc query session -optfile= myopts.opt
This option is valid only on the initial command line. It is not valid in interactive mode.
The os2lanservacpsupport option specifies the OS/2 Lan Server local and network attached drives from which ACL data associated with files and directories is backed up. To back up or restore ACL data on network attached drives you must be logged on as an administrator.
If ACL data is not backed up for a file or directory, TSM will not restore this ACL data. This can result in unwanted residual ACL data, if ACL data was added to a file after the last backup.
If the HPFS386_local or All_local parameters are specified for a restore operation, TSM processes data using the All parameter. If ACL data is backed up for a file or directory, during a restore operation any existing ACL data for that file or directory is overwritten.
Faster processing of ACL data can be expected using, for example, the HPFS386_local option as opposed to the All option.
Format
.-HPFS386_local--. >>-OS2LANSERVACPsupport-+----------------+--------------------->< +-None-----------+ +-All_local------+ '-All------------'
Parameters
Note: | If a file or directory is deleted, its associated ACL data is also deleted. This is because the ACL data is stored with the file or directory. |
Note: | You may prefer this option if you have an OS/2 Lan Server-entry using only HPFS or FAT systems. OS/2 Lan Server file NET.ACC, which contains ACL data for all files and directories, can be backed up separately to preserve ACL data. |
Note: | For FAT, HPFS, HPFS386, and JFS drives, if you delete a file or directory you must also delete its associated ACL data using the OS/2 Lan Server Net Access command. This prevents residual ACL data after deletion. ACL data is not stored with the file or directory. |
Examples
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.
Syntax
>>-PARtnerluname- logical_unit_name----------------------------><
Parameters
partnerluname nameone.nametwo
Contact your system administrator for this name. There is no default.
Examples
-par=sanjose.vm
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
Syntax
>>-PASsword- password------------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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 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 Web client, set the passwordaccess option to generate.
Syntax
.-prompt---. >>-PASSWORDAccess-+----------+--------------------------------->< '-generate-'
Parameters
To keep your client node password secure, enter commands without the password, and wait for TSM to prompt you for the password.
A password prompt displays when registering a workstation with a server using open registration, or if your password was changed manually by the administrator.
Examples
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.
Syntax
>>-PASSWORDDIR- directoryname----------------------------------><
Parameters
The default directory is the directory specified with the DSM_DIR environment variable. If no directory is specified with the DSM_DIR environment variable, the default directory is the C:\ directory.
Examples
passworddir c:\security\tsm
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. |
Syntax
>>-+-POSTSchedulecmd--+--- "cmdstring"------------------------->< '-POSTNschedulecmd-'
Parameters
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
The command string is a valid command for restarting your database.
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. |
Syntax
>>-+-PRESchedulecmd--+--- "cmdstring"-------------------------->< '-PRENSchedulecmd-'
Parameters
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
The command string is a valid command for quiescing your database.
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. |
Syntax
>>-QUERYSCHedperiod- hours-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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. |
Syntax
>>-QUIET-------------------------------------------------------><
Examples
This option is valid on the initial command line and in interactive mode.
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.
Syntax
.-Prompt--. >>-REPlace-+---------+----------------------------------------->< +-All-----+ +-Yes-----+ '-No------'
Parameters
Examples
The resourceutilization option regulates the level of resources the TSM server and client can use during processing.
When a backup or archive operation is requested, the TSM client may use more than one session to the TSM server. The default is to use a maximum of two sessions; one to query the server, and one to send file data. The client is restricted to a single server session when a resourceutilization setting of 1 is specified.
A TSM client can be permitted to use more than the default number of sessions when connecting to a TSM server that is Version 3.7 or higher. For example, resourceutilization=10 permits up to eight sessions with the server. Multiple sessions may be used for querying the server and sending file data.
Multiple query sessions will only be used when multiple file specifications are used with a backup or archive command. For example, if you enter:
inc filespaceA filespaceB
and you specified resourceutilization=5, the TSM client may start a second session to query files on filespaceB. Whether or not the second session starts depends on how long it takes to query the server about files backed up on filespaceA. The client may also try to read data from the file system and send it to the server on multiple sessions.
The following factors may affect the throughput of multiple sessions:
You should also consider potentially undesirable aspects of running multiple sessions, such as the following:
Note: | This option can also be defined on the server. |
Syntax
>>-RESOURceutilization- number---------------------------------><
Parameters
Examples
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. |
Syntax
>>-RETRYPeriod- minutes----------------------------------------><
Parameters
Examples
-retryperiod=15
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
Syntax
.-None---. >>-REVOKEremoteaccess-+--------+------------------------------->< '-Access-'
Parameters
Examples
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.
Syntax
>>-SCHEDLOGName- filespec--------------------------------------><
Parameters
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. For UNIX: The dsmsched.log file cannot be a symbolic link.
Examples
schedlogname c:\mydir\schedlog.jan
-schedlogn=c:\mydir\schedlog.jan
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
Syntax
.-N----. .-D--. >>-SCHEDLOGRetention----+------+---+----+---------------------->< '-days-' '-S--'
Parameters
Pruned entries are copied to the dsmsched.pru file that is stored in the same directory as the schedule log.
Examples
-schedlogretention=30,S
This option is valid only on the initial command line. It is not valid in interactive mode.
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 polling mode (your client node periodically queries the server for scheduled work), or the 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 both modes or just one mode. If your administrator specifies that both modes are supported, you can select either schedule mode. If your administrator specifies only one mode, you must specify that mode in your client options file, or scheduled work will not process.
If the prompted mode is specified, 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. |
Syntax
.-POlling--. >>-SCHEDMODe-+----------+-------------------------------------->< '-PRompted-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The scrolllines option specifies the number of lines of information that display on your screen at one time. 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. |
Syntax
>>-SCROLLLines- number-----------------------------------------><
Parameters
Examples
This option is valid on the initial command line and in interactive mode.
The scrollprompt option specifies whether you want TSM to stop and wait after displaying the number of lines of information you specified with the scrolllines option, or scroll through and stop at the end of the information list.
Note: | This option can also be defined on the server. |
Syntax
.-No--. >>-SCROLLPrompt-+-----+---------------------------------------->< '-Yes-'
Parameters
Press 'Q' to quit, 'C' to continuous scroll, or 'Enter' to continue.
Examples
This option is valid on the initial command line and in interactive mode.
The shmport option specifies the TCP/IP port address that the server is listening on to establish a shared memory connection. To use shared memory, TCP/IP must be installed on your workstation.
Note: | The value specified for the shmport option in the client options file must match the value specified for shmport in the server options file. |
Syntax
>>-SHMPort port_address----------------------------------------><
Parameters
Examples
The shmqueuename option specifies the name of the server shared memory queue.
Syntax
>>-SHMQueuename- name------------------------------------------><
Parameters
Examples
The subdir option specifies whether you want to include subdirectories of named directories for processing on the following commands:
Note: | This option can also be defined on the server. |
Options File
Place this option in your client options file (dsm.opt).
Syntax
.-No--. >>-SUbdir-+-----+---------------------------------------------->< '-Yes-'
Parameters
Note: | If you use the preservepath option in addition to subdir=yes, it can affect which subdirectories are are processed. For more information, see Preservepath. |
If a subdirectory is a mounted file system, it is not processed even if subdir=yes is specified.
Examples
To restore the structure:
\path2\dir1 \path2\dir1\file1 \path2\dir1\dir2 \path2\dir1\dir2\file1
enter any of the following commands:
rest \path\dir1\* \path2\ -su=yes rest \path\dir1\file* \path2\ -su=yes rest \path\dir1\file1* \path2\ -su=yes
The symbolicdestination option specifies a symbolic server name that indexes SNA routing and security parameters stored in communication directory files. Contact your administrator for the correct name.
When a symbolic destination is used with the SNA LU6.2 communication protocol, 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.
Syntax
>>-SYMbolicdestination- sym_dest_name--------------------------><
Parameters
Examples
-sym=anrserv
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
Tape prompting does not occur during a scheduled operation regardless of the setting for the tapeprompt option.
The tapeprompt option can be used with the following commands:
Note: | This option can also be defined on the server. |
Syntax
.-No--. >>-TAPEPrompt-+-----+------------------------------------------>< '-Yes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpbuffsize option specifies the size of the internal TCP/IP communication buffer. Although it uses more memory, a larger buffer can improve communication performance.
Syntax
>>-TCPBuffsize- size-------------------------------------------><
Parameters
Depending on the operating system communication settings, your system might not accept all values in the range of one through 512.
Examples
-tcpbuffsize=31
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
Syntax
>>-TCPCLIENTAddress- client_address----------------------------><
Parameters
Examples
-tcpclientaddress=128.33.10.249
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpclientport option specifies a different TCP/IP port number for the server to contact, 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 available port. Use this option only if you specify the prompted parameter with the schedmode option, or when the schedule command is running.
Syntax
>>-TCPCLIENTPort- client_port_address--------------------------><
Parameters
Examples
-tcpclientport=1492
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpport option specifies a TCP/IP port address for a server. You can obtain this address from your administrator.
Syntax
>>-TCPPort- port_address---------------------------------------><
Parameters
Examples
-tcpport=1501
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpserveraddress option specifies the TCP/IP address for a server. You can obtain this server address from your administrator.
Syntax
>>-TCPServeraddress- server_address----------------------------><
Parameters
Examples
-tcpserveraddress=129.33.24.99
This option is valid only on the initial command line. It is not valid in interactive mode.
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/storage.
Syntax
>>-TCPWindowsize- window_size----------------------------------><
Parameters
The range of values is one through 2048; the default is 31.
Note: | Depending on the operating system communication settings, your system might not accept all values in the range of values. |
Examples
-tcpw=24
This option is valid only on the initial command line. It is not valid in interactive mode.
The timeformat option specifies the format in which you want system time displayed.
Syntax
>>-TIMEformat- format_number-----------------------------------><
Parameters
Examples
This option is valid on the initial command line and in interactive mode.
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.
Syntax
>>-TPname- tp_name---------------------------------------------><
Parameters
Examples
-tp=adsm
This option is valid only on the initial command line. It is not valid in interactive mode.
The txnbytelimit option specifies the number of kilobytes the client program buffers before it sends a transaction to the server.
Note: | This option can also be defined and adjusted by the server as required during self-tuning operations. |
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.
Syntax
>>-TXNBytelimit- number----------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The verbose option specifies that you want processing information to display on your screen. This is the default. 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.
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. |
Syntax
>>-VErbose-----------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
This option is valid on the initial command line and in interactive mode.