Tivoli Storage Manager for NetWare Using the Backup-Archive Client


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 Options File" "Creating and Modifying a Client Options File"
"Setting Options in the Client Options File" "Setting Options in the Client Options File"
"Using Options With Commands" "Using Options With Commands"

Creating and Modifying a Client Options File

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:

If you want to use different options than those specified in dsm.smp you can create your own options file by copying 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, sys:tivoli. During installation, you can select a different volume and directory name on your NetWare server, or you can select a volume and directory on a remote NetWare server. The search add line in your autoexec.ncf file points to the directory where your client options file is located.

To view or modify the client options file use the NetWare load edit command which starts the NetWare text editor.

Attention: When editing is required, use the NetWare load edit command with caution because a loss of data can occur. The NetWare text editor is normally used to modify small text files. Do not edit large text files with this utility.

Some options are used only with commands. For more information about these options, see "Command Processing Options".


Communication Options

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

For NetWare 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.

Table 10. TCP/IP Options

Option Description Page
httpport Specifies a TCP/IP port address for the TSM Web client. Httpport
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

IPX/SPX Options

The communication options for IPX/SPX have default values which can be modified.

Table 11. IPX/SPX Options

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

SNA LU6.2 (APPC) Options

For NetWare: First, install SNA LU6.2 on the NetWare server. For information about how to install SNA, see Novell NetWare for SAA Version 1.3 Administration Guide (Document Number 100-001166-002).

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

Table 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

Node Option

You can use the following option to specify the client node for which you want to request backup-archive services.

Table 13. Node Options

Option Description Page
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

Backup and Archive Processing Options

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

Table 14. 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 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. 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 volumes 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 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
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 when used with the incremental command. Memoryefficientbackup
nwignorecompressbit Specifies whether you want to ignore the setting of the compressed file (Co) attribute during selection processing for incremental backups. Nwignorecompressbit
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

Restore and Retrieve Processing Options

The following options relate to restore and retrieve processing.

Table 15. Restore and Retrieve Processing Options

Option Description Page
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

Scheduling Options

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

Table 16. 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 Specifies a command to process after running a schedule. Postschedulecmd
preschedulecmd 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 option 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 option only with the schedule command when you specify prompted as the schedule mode. Tcpclientport

Format and Language Options

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 17. 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 time. Timeformat

Command Processing Options

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

Table 18. Command Processing Options

Option Description Page
editor Specifies if the command-line interface editor and command retrieve capability is turned on or off. Editor
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.

Table 19. Authorization Options

Option Description Reference
nwpwfile Specifies whether TSM encrypts a NetWare user's ID and password and saves them to a .pwd file. Nwpwfile
nwuser Specifies a user ID and password to connect to a NetWare server when you start a TSM session. Nwuser
optfile Specifies the options file you want TSM to use when you start a TSM session. Optfile
password Specifies a TSM password. Password
passwordaccess Specifies how TSM handles a password if one is required for your workstation. Passwordaccess
passworddir Specifies 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

Error Processing Options

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

Table 20. 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
nwwaitonerror Specifies whether an error message is displayed if an error occurs while exiting a TSM session. If this option is set to no, the TSM window closes automatically, and the client program returns to the NetWare console. Nwwaitonerror

Transaction Processing Options

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

Table 21. 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

Web Client Options

The following are options for the TSM Web Client.

Table 22. Web Client Options

Option Description Page
httpport Specifies a TCP/IP port address for the Web Client. Httpport
revokeremoteaccess Restricts administrator access on a client workstation through the Web Client. Revokeremoteaccess

Setting Options in the Client Options File

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

To view or modify the options file, select the Edit menu> Preferences item on the backup-archive GUI. The graphical options editor updates the client configuration options file, if any options have changed.

The options file can also be edited with your favorite text editor.

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 command line 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.

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,

   load dsmc incremental -domain=sys:

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

   load 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:

Changingretries

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.

If the open file has the share flag set to deny_read, the client program cannot back it up.

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

Syntax

                   .-----------------.
                   V                 |
>>-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:
-cha=0

Commmethod

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

Syntax

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

Parameters

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

IPXspx
The Internetwork Packet Exchange/Sequenced Packet Exchange (IPX/SPX) communication method. Use this communication method with an AIX server only.

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

Examples

Options file:
commm tcp

Command line:
-commmethod=tcp

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

Commrestartduration

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

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

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

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

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

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

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

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:
-compressi=no

Cpicbuffersize

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

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

Examples

Options file:
cpicbuffersize 31

Command line:
-cpicbuffersize=31

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

Cpicmodename

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

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:
-cpicmodename=vmmode

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

Dateformat

The dateformat option selects the format used 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 want to preserve log entries that contain a different date format.

Syntax

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

Parameters

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

1
MM/DD/YYYY (This is the default)

2
DD-MM-YYYY

3
YYYY-MM-DD

4
DD.MM.YYYY

5
YYYY.MM.DD

Examples

Options file:
dateformat 3

Command line:
-date=4

This option is valid on the initial command line and in interactive mode.

Dirmc

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

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

The domain option specifies the volumes 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 volumes to process during an incremental backup:

If domain is not used to specify volumes in your client options file, TSM uses the all-local parameter as the default.

When domain is used with the incremental command, TSM adds volumes that you specify to the volumes that is defined in your client options file. For example, if you enter the following in your client options file:

   domain sys: data: bindery:     

and the following on the command line:

   load dsmc incremental -domain=usr:        

TSM performs an incremental backup for your sys:, data:, and usr: volumes and the bindery: .

If you use both a file specification and the domain option with the incremental command, TSM ignores the domain option and processes only those volumes specified in the file specification.

Syntax

           .- ----------------------.
           V  .-all-local--------.  |
>>-DOMain-----+------------------+--+--------------------------><
              +-domain-----------+
              +-BINdery----------+
              '-DIRectory or NDS-'
 

Parameters

all-local
Backs up all local volumes. This is the default.

The NDS is not included in the all-local domain. To include the NDS, add the directory to the domain entry.

domain
Defines the volumes to include in your default client domain.

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

BINdery
Backs up the three system files comprising the bindery database.

DIRectory or NDS
Specifies the NDS.

The NDS is not included in the all-local domain. To include the NDS, add the directory to the domain entry.

Examples

Options file:
domain sys:tsm\nds 

Command line:
-domain="servera\sys: serverb/sys:" 

Editor

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

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

No
Turns off the CLI editor and command retrieve capability.

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

Examples

Options file:
editor yes

Command line:
Does not apply.

Errorlogname

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. The value for this option overrides the DSM_LOG environment variable.

Syntax

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

Parameters

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

The default file name is dsmerror.log; it is placed in installation directory.

Examples

Options file:

errorlogname dmmock\sys:tmp\tsmerr.log

Command line:

-errorlog=dmmock\sys:tmp\tsmerr.log

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

Errorlogretention

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

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:
-errorlogr=400,S

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

Exclude Options

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.

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 nw2:\sys:any/test     

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

  exclude.dir nw2:\sys:any/test*     

Wildcards are not supported for the server name or volume name. If you do not specify a server name, TSM uses the local server name.

Notes:

  1. 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.

  2. These options can be defined on the server with the inclexcl option.

Syntax

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

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.

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

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 a selective backup. However, the next time you perform an incremental backup, these backup versions are expired.

The exclude.dir option works only if the excluded directory is a subdirectory.

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

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

Parameters

pattern
Specifies the file or group of files that you want to exclude from backup services. End the pattern with a file specification.
Note:If you do not specify a server name, TSM uses the local server name.

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

Options file:
exclude servera\*:.../swapper.dat
exclude n1\*:io.sys
exclude tfr\*:.../spart.par
exclude nw2\sys:*/budget.fin
exclude nw6\sys:devel/*
exclude.archive severa*:/.../events.log

Command line:
Does not apply.

Httpport

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

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:

does not apply

Command line:

-httpport=1502.

Include Options

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.

Note:These options can be defined on the server with the inclexcl option.

Syntax

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

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.

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 servera\sys:proj/text/devel.*
include servera\sys:proj/text/* textfiles
include *:* managall
 

Command line:
Does not apply.

Ipxbuffersize

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

size
Specifies the size, in kilobytes, that you want to use for the IPX/SPX communication buffer. The range of values is 1 through 16; the default is 16.

Examples

Options file:
ipxb 8

Command line:
-ipxbuffersize=12

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

Ipxserveraddress

The ipxserveraddress option specifies the IPX/SPX address of a server on an 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

server_address
Specifies a twenty-hexadecimal digit IPX/SPX address for a server. Pad each field with leading zeros if the value is shorter than the specified length. An IPX/SPX address is a concatenation of the following digits:

If an IPX/SPX address is not specified, the default address for the server is the same address as the client workstation.

Examples

Options file:
ipxse 0000000210005af6e7cc

Command line:
-ipxserveraddress=0000000210005af6e7cc

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

Ipxsocket

The ipxsocket option specifies the socket number for a server on a NetWare host.

Syntax

>>-IPXSOcket- socketnumber-------------------------------------><
 

Parameters

socketnumber
Specifies a four-digit server socket number in a hexadecimal value. Contact your system administrator for the value. The default is 214A.

Examples

Options file:
ipxso 8524

Command line:
-ipxsocket=8524

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

Language

The language option specifies the national language in which to present client messages.

You can use American English (AMENG) with all clients. Currently, you can use American English (AMENG) only.

Syntax

>>-LANGuage- language------------------------------------------><
 

Parameters

language
Specifies the language you want to use.

Examples

Options file:
language ameng

Command line:
Does not apply.

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

Largecommbuffers

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

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

Yes
Specifies that increased buffers are used to transfer large amounts of data to the server.

Examples

Options file:
largecommbuffers yes

Command line:
Does not apply.

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

Maxcmdretries

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

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:
-maxcmdretries=3

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

Memoryefficientbackup

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

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

Nodename

The nodename option identifies your workstation to the server. You can use different node names to identify multiple operating 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.

Syntax

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

Parameters

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

Permit the node name to default to the machine name.

Examples

Options file:
nodename cougar

Command line:
-nod=banshee

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

Numberformat

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

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

Examples

Options file:
num 4

Command line:
-numberformat=4

This option is valid on the initial command line and in interactive mode.

Nwignorecompressbit

The nwignorecompressbit option specifies whether you want to ignore the setting of the compressed file (Co) attribute during selection processing for incremental backups. This option is valid only on NetWare clients sending an incremental backup on a NetWare 4 file system.

Syntax

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

Parameters

No
Specifies that the NetWare client should interrogate the compressed file attribute during selection processing for incremental backups. This is the default.

Yes
Specifies that the NetWare client should ignore the setting of the compressed file attribute during selection processing for incremental backups. If nwignorecompressbit is set to yes and the only change to the file is compression by the NetWare 4 operating system, the file is not backed up incrementally.

Examples

Options file:
nwignorecompressbit yes

Command line:
Does not apply.

Nwpwfile

The nwpwfile option encrypts the user ID and password for a local or remote NetWare server and saves them in a file in the installation directory.

Syntax

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

Parameters

Yes
Encrypts the user ID and password the first time a command is sent for a local or remote NetWare server. The encrypted information is stored with the extension, .pwd, in your installation directory. When you enter subsequent commands for that server, the password information is obtained instead of sending a prompt. This is the default.

No
Does not encrypt the user ID and password. Each time you send a command to back up or archive files stored on a remote NetWare server, you are prompted for the user ID and password for the server.

Examples

Options file:
nwpwf yes

Command line:
-nwpwfile=no

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

Nwuser

The nwuser option specifies a user ID and password to connect to a local or remote NetWare server. The user must have NetWare supervisor authority. Use this option in your client options file for each NetWare server. If you do not use this option, you are prompted for a user ID and password for each target service when you start a backup or archive operation.

When logging into a NetWare server from TSM, enter one of the following:

For example, if you received the following message:

   Please enter NetWare user for "ELLAS":

You can specify either: .CN=Zorba.OU=Islands.O=Greece or Zorba (if the Bindery Context is set to OU=Islands.O=Greece. TSM rejects the typeless name:

   Zorba.Islands.Greece
Note:Bindery context does not affect TSM NDS processing; it is not necessary to specify it.

Syntax

   .- ---------------------------------.
   V                                   |
>>----NWUSer servername\user:password--+-----------------------><
 

Parameters

servername
A one to 48 character NetWare server name to which your client node has access.

user
A one to 48 character NetWare user name with supervisor authority on the NetWare server.

password
A one to 128 character password for a user with supervisor authority on the NetWare server.

Examples

Options file:
nwus servera\supervisor:secret

To specify a user ID and password to back up an NDS tree, you would enter: nwuser treea:.admin.ibm:secret where treea is the NDS tree name.

Command line:
-nwuser=serverb\mary:secret1

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

Nwwaitonerror

The nwwaitonerror option specifies that the client program responds in one of the following ways, if an error occurs while exiting:

Note:You can use the nwwaitonerror option when running DSMC in an automated mode, such as, from an .NCF file. By default, you are asked to press any key to continue before you exit the DSMC program. If you specify yes, DSMC will not prompt.

Syntax

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

Parameters

Yes
Specifies that the client program displays an error message if it encounters an error. Press Enter to return to the NetWare console. This is the default.

No
Specifies that the client program returns immediately to the NetWare console if it encounters an error while exiting. An error message is not displayed.

Examples

Options file:
nww yes

Command line:
Does not apply.

Optfile

The optfile option specifies the client 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:
   load dsmc query session -optfile=
   sys:tsm/spike.opt 

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

Partnerluname

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

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:
-par=sanjose.vm   

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

Password

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

password
Specifies a one 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

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

Passwordaccess

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

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.

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.

Examples

Options file:
passwordaccess generate

Command line:
Does not apply.

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

Passworddir

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

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.

Examples

Options file:
passworddir dmmock\sys:security\tsm    

Command line:
Does not apply.

Postschedulecmd

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.

Note:The postschedulecmd option can be defined on the server.

Syntax

>>---POSTSchedulecmd----- "cmdstring"--------------------------><
 

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.

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

Preschedulecmd

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.

Note:The preschedulecmd option can also be defined on the server.

Syntax

>>---PRESchedulecmd----- "cmdstring"---------------------------><
 

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.

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

Processorutilization

The processorutilization option specifies the amount of CPU time assigned to the client program. Because this option can affect other applications on your client node, use it only when speed is a high priority.

Syntax

>>-PROCESSORutilization- number--------------------------------><
 

Parameters

number
Specifies the amount of time the client program will control the CPU, in hundredths of a second, before giving it to another application. For example, if the number is 1000, the client program controls the CPU for 10 seconds. The minimum value is zero. There is no maximum value. The default is zero.

Examples

Options file:
processor 2

Command line:
-processorutilization=10

Queryschedperiod

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

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

Examples

Options file:
querysch 6

Command line:
-queryschedperiod=8

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

Quiet

The quiet option limits the number of messages that display on your screen during processing. 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, error and processing information is displayed on your screen, and messages are written to log files. If you do not specify quiet, the default option, verbose is used.

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

Syntax

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

Examples

Options file:
quiet

Command line:
-quiet

This option is valid on the initial command line and in interactive mode.

Replace

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

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

All
All existing files are overwritten, including read-only files. If access to a file is 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 access to a file is 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

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 can 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 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 file space B. Whether or not the second session starts depends on how long it takes to query the server about files backed up on file space A. The client may also try to read data from the file system and send it to the server on multiple sessions.

The following factors can affect the throughput of multiple sessions:

Potentially undesirable aspects of running multiple sessions include:

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

Syntax

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

Parameters

number
Specifies the level of resources the TSM server and client can use during processing. The range of values that you can specify is one through 10.

Examples

Options file:
resourceutilization 7

Command line:
Does not apply

Retryperiod

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

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 one through 9999; the default is 20.

Examples

Options file:
retryp 10

Command line:
-retryperiod=15 

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

Revokeremoteaccess

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

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

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

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 dmmock\sys:mydir/schedlog.jan 

Command line:
-schedlogn=dmmock\sys:mydir/schedlog.jan 

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

Schedlogretention

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

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 to the dsmsched.pru file that is stored in the same directory as the schedule log.

Examples

Options file:
schedlogretention 30 S

Command line:
-schedlogretention=30,S 

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

Schedmode

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

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

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

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

Scrolllines

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

number
Specifies the number of lines of information that display on your screen at one time. The range of values is one through 80; the default is 20.

Examples

Options file:
scrolllines 25

Command line:
-scrolll=25

This option is valid on the initial command line and in interactive mode.

Scrollprompt

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

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 specified 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

This option is valid on the initial command line and in interactive mode.

Subdir

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

archive
delete archive
incremental (if the file specification is not a domain)
query archive
query backup
query backupset
restore
restore backupset
retrieve
selective
Note:This option can also be defined on the server.

Options File for Novell NetWare Platforms

Place this option in your 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, processing can take longer to complete. 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. For more information, see Preservepath.

If a subdirectory is a mounted file system, it is not processed even if subdir=yes is specified.

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:

load dsmc rest sys:path/nds1/* sys:path2/ -su=y
load dsmc rest sys:path/nds1/file* sys:path2/ -su=y
load dsmc rest sys:path/nds1/file1* sys:path2/ -su=y

Symbolicdestination

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

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 tsm

Command line:
-sym=anrserv   

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

Tapeprompt

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

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

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

Tcpbuffsize

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

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.

Depending on 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:
-tcpbuffsize=31    

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

Tcpclientaddress

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

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

Examples

Options file:

tcpclienta 128.33.10.249

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

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

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.

Tcpport

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

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:
-tcpport=1501    

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

Tcpserveraddress

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

server_address
Specifies a one to 64 character TCP/IP address for a server. Specify a TCP/IP domain name or a dot address. For NetWare 5.0, specify only the 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

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/support/storage_mgr/tivolimain.html.

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 64; the default is 32.

Note:Depending on 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. It is not valid in interactive mode.

Timeformat

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

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.

1
23:00:00 (This is the default)

2
23,00,00

3
23.00.00

4
12:00:00 A/P

Examples

Options file:
timeformat 4

Command line:
-time=3

This option is valid on the initial command line and in interactive mode.

Tpname

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

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 tsm

Command line:
-tp=tsm     

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

Txnbytelimit

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.
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.

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 2097152 (2 GB); the default is 2048.

Examples

Options file:
txnb 2048

Command line:
-txnb=2048

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

Verbose

The verbose option specifies that you want processing information to display on your screen. This is the default. 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

Options file:
verbose

Command line:
-verbose

This option is valid on the initial command line and in interactive mode.


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