Tivoli Storage Manager for Windows 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 sample client options files called ba_dsm.opt (backup-archive client) and sa_dsm.opt (administrator client). These files contain processing options that are categorized as follows:

TSM provides sample options files called ba_dsm.opt (backup-archive client) and sa_dsm.opt (administrator client). These are generic configuration files that contain communication parameters normally used in a Windows environment.

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 use one of the following methods to edit your client options file:

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

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


Communication Options

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

For Windows NT or Windows 2000 you can use one of the following protocols:

For Windows 95 and 98, you can use one of the following 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 12. TCP/IP Options

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

IPX/SPX Options

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

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

Named Pipes Option

The communication option for Named Pipes is:

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

NETBIOS Options

The communication options for NETBIOS have default values which can be modified.

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

SNA LU6.2 (APPC) Options

If you use commmethod=SNALU6.2 using the TCP/IP protocol to connect from the Microsoft SNA client on NT and Windows 9x to the Microsoft SNA server and through SNA to the TSM server and are using the default settings, you may receive the following message when performing backup, archive, restore, or retrieve functions:

   Session is lost; initializing session reopen procedure

A warning message similar to the following will be in the Application Event Log:

   Connection to client <ip address> has been
   aborted due to too many pending writes.

This is a Microsoft SNA product configuration problem. To resolve this problem, make a copy of your registry for recovery purposes, then use regedit and add the Name - Value pair under the key as follows:

   Hkey_Local_Machine
    System
     CurrentControlSet
      Services
       SnaBase
        Parameters
         SnaTcp
          MaxPendingWrites:reg_word:0x1F4    

This problem does not occur when using an IPX/SPX or NETBIOS connection from a Microsoft SNA client to a Microsoft SNA server connection.

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

Table 16. 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 Options

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

Table 17. Server and Node Options

Option Description Page
clusternode Specifies whether Tivoli Storage Manager is running as a cluster node. Clusternode
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 18. Backup and Archive Processing Options

Option Description Page
backupregistry Specifies whether to back up the Windows registry. Backupregistry
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
dfsbackupmntpnt Specifies whether TSM sees a DFS mount point as a mount point or as a directory. Dfsbackupmntpnt
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
skipntpermissions Specifies whether to back up Windows NT and Windows 2000 security information. Skipntpermissions
skipntsecuritycrc Specifies whether to compute the security CRC for permission comparison during subsequent backups. Use this option on Windows NT and Windows 2000 only. Skipntsecuritycrc
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 19. Restore and Retrieve Processing Options

Option Description Page
activatekey Specifies whether TSM activates the registry key to update the registry after restoring files. Activatekey
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

Scheduling Options

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

Table 20. Scheduling Options

Option Description Page
maxcmdretries Specifies the maximum number of times the client scheduler attempts to process a scheduled command that fails. Maxcmdretries
postschedulecmd, postnschedulecmd Specifies a command to process after running a schedule. Postschedulecmd/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
runasservice Forces the client command process to continue running, even if the account that started the client logs off. Use this option on Windows NT and Windows 2000 only. Runasservice
schedlogname Specifies the name of the file where schedule log information is stored. Schedlogname
schedlogretention Specifies the number of days to keep log file entries in the schedule log, and whether to save pruned entries. Schedlogretention
schedmode Specifies which schedule mode to use, polling or prompted. Schedmode
tcpclientaddress Specifies the TCP/IP address of your client node. Use this only with the schedule command when you specify prompted as the schedule mode. Tcpclientaddress
tcpclientport Specifies the TCP/IP port number of your client node. Use this only with the schedule command when you specify prompted as the schedule mode. Tcpclientport

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

Command Processing Options

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

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

Authorization Options

These options control access to a TSM server.

Table 23. 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
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 24. Error Processing Options

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

Transaction Processing Options

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

Table 25. 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 26. Web Client Options

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

Setting Options in the Client Options File

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. If you use the setup wizard to make changes, the changes are effective immediately.


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,

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

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:

Activatekey

The activatekey option specifies whether TSM should activate the registry key to update the registry after restoring files. Use this option with the restore registry command.

Supported Clients

This option is for Windows 95, Windows 98, Windows NT, and Windows 2000 clients only.

Syntax

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

Parameters

No
Specifies that Tivoli Storage Manager should not update the registry after restoring files.

Yes
Specifies that Tivoli Storage Manager should update the registry after restoring files. This is the default.

Examples

The following examples show what you would enter to instruct Tivoli Storage Manager to update the registry after restoring files.

Options file:
activate yes

Command line:
-activate=yes

Backupregistry

The backupregistry option specifies whether the registry is backed up during incremental backups.

Syntax

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

Parameters

Yes
The TSM program backs up the registry during incremental backups that include the system drive. This is the default.

No
The TSM program does not back up the registry.

Examples

Options file:
backupreg no

Command line:
-backupreg=yes

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

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.

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

Clusternode

The clusternode option specifies whether TSM is responsible for managing cluster drives in a Microsoft Cluster Server (MSCS) environment. For information on how to configure a cluster server, see the Appendix in Installing the Clients.

Supported Clients

This option is for Windows NT and Windows 2000 clients only.

Syntax

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

Parameters

Yes
Specifies that you want to back up cluster resources.

No
Specifies that you want to back up local disks. This is the default.

Examples

Options file:
cluster no

Command line:
-cluster=yes

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

Commmethod

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

Syntax

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

Parameters

TCPip
The Transmission Control Protocol/Internet Protocol (TCP/IP) communication method. This protocol is the default for the Windows client, and it is the only supported protocol for use with MVS and VM servers.

IPXspx
The Internetwork Packet Exchange/Sequenced Packet Exchange (IPX/SPX) communication method. Use this communication method only with OS/2, AIX, and NT servers.

NAMedpipes
The interprocess communication method that permits message data streams to pass between a client and a server. Use this communication method with a Windows NT or 2000 server running on the same machine as the client.

NETBios
The Network Basic Input/Output System (NETBIOS) communication method. Use the NETBIOS communication method with Windows NT and OS/2 servers.

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

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

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.

Dfsbackupmntpnt

The dfsbackupmntpnt option specifies whether TSM views a Microsoft DFS junction as a junction or a directory. If TSM views Microsoft DFS junction as a junction, only the name of the mounted junction is backed up. The subtree under the junction point is not backed up.

This option is effective only when you back up a Microsoft DFS root. This option is ignored when you back up a Microsoft DFS junction.

Supported Clients

This option is for Windows NT, Windows 2000, and AIX DFS clients only.

Syntax

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

Parameters

Yes
Specifies that TSM views all Microsoft DFS junctions as junctions. When TSM encounters any junction during a backup operation, only the name of the mounted junction is backed up. This is the default

No
Specifies that TSM should view all Microsoft DFS junctions as directories. TSM backs up the contents of files and subdirectories of any junction it encounters during a backup operation.

Examples

Options file:
dfsbackupmntpnt no

Command line:
not applicable

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

all-local
Backs up all local hard drives. This is the default.

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

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

Examples

Options file:
domain c: d: e:

Command line:
-domain="c: d:"

Editor

For Windows 95 and Windows 98 systems, the editor option turns the command line interface editor and retrieve capability on or off. For Windows NT and 2000, this option is always off, even if you explicitly specify yes. This is because the client uses the command line history capabilities of the Windows NT and 2000 command line console. 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. However, for Windows NT or 2000 the value for this option is always editor=No.

No
Turns off the CLI editor and command retrieve capability.

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.

Syntax

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

Parameters

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

The default is the path 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

Options file:
errorlogname c:\temp\dsmerr.log

Command line:
-errorlog=c:\temp\dsmerr.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.

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*     
 

For remotely-accessed files, specify Universal Naming Convention (UNC) based names in your exclude statement. See Chapter 7, "Creating an Include-Exclude List" for more information. See also "Excluding System Files" for a list of files that you should always exclude.

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

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.

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 ?:\...\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   

Command line:
Does not apply.

Guitreeviewafterbackup

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

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

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

Examples

Options file:
guitreeviewafterbackup yes

Command line:
Does not apply.

Httpport

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.

Httpsport

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

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

Examples

Options file:
httpsport 1548

Command line:
Does not apply.

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.

For remotely-accessed files, specify UNC-based names in your include statement.

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

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 c:\proj\text\devel.*
include c:\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 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

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

Lanadapter

The lanadapter option specifies a communication adapter number when you use the NETBIOS communication method.

Syntax

>>-LANAdapter- adapter_number----------------------------------><
 

Parameters

adapter_number
Specifies an adapter number for a communication adapter that NETBIOS uses. The number must be zero or 1; the default is zero.

Examples

Options file:
lana 0

Command line:
-lanadapter=1

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.

Syntax

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

Parameters

language
Specifies the language you want to use. The available languages include:

Examples

Options file:
language ameng

Command line:
Does not apply.

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.

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

Namedpipename

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

name
The name of a named pipe. The default is \pipe\dsmserv.

Examples

Options file:
namedpipename \pipe\dsmser1

Command line:
-namedpipename=\pipe\dsmser1

Netbiosbuffersize

The netbiosbuffersize option specifies the size, in kilobytes, that you want to use for the NETBIOS communication buffer.

Syntax

>>-NETBIOSBuffersize- size-------------------------------------><
 

Parameters

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

Examples

Options file:
netbiosb 1

Command line:
-netbiosbuffersize=1

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

Netbiosname

The netbiosname option specifies a NETBIOS name for your workstation.

Syntax

>>-NETBIOSName- name-------------------------------------------><
 

Parameters

name
Specifies a NETBIOS name for your workstation. The name is case-sensitive, and it can be as many as 16 characters. The first character cannot be an asterisk (*), and the first three characters cannot be the letters IBM.

The default is TSM concatenated to a time-of-day value.

Examples

Options file :
netbiosname tsmjohn

Command line:
-netbiosname=tsmwkst1

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

Netbiosservername

The netbiosservername option specifies a NETBIOS name for a server.

Syntax

>>-NETBIOSServername- name-------------------------------------><
 

Parameters

name
Specifies a NETBIOS name for a server. The name is case-sensitive, and it can be as many as 16 characters. The first character cannot be an asterisk (*), and the first three characters cannot be the letters IBM.

The default is adsmserv1.

Examples

Options file:
netbioss adsmserv2

Command line:
-netbiosservername=adsmserv2

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

Netbiostimeout

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

seconds
Specifies the number of seconds that elapse before a timeout occurs for a NETBIOS send or receive. The range of values is zero through 120; the default is 60. A value of zero results in no timeout.

Examples

Options file:
netbiostimeout 30

Command line:
-netbiostimeout=30

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

Nodename

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

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 unless clusternode=y. Then, the default is the cluster name.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.

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:
   dsmc query session -optfile=
   myopts.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 1 to 64 character password. A password is not case-sensitive. Valid characters include:
Characters
Description
A-Z
Any letter, A through Z, uppercase or lowercase
0-9
Any number, 0 through 9
+
Plus
.
Period
_
Underscore
-
Hyphen
&
Ampersand

Examples

Options file:
password secretword

Command line:
-password=secretword

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:

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.

The generated password is stored in the registry.

Examples

Options file:
passwordaccess generate

Command line:
Does not apply.

Postschedulecmd/Postnschedulecmd

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

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

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

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

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

Examples

Options file:
postschedulecmd "restart database"

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

Command line:
Does not apply.

Preschedulecmd/Prenschedulecmd

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

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

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

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

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

Examples

Options file:
preschedulecmd "quiesce database"

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

Command line:
Does not apply.

Queryschedperiod

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

This option also affects the amount of information reported in the NT eventlog and schedule log.

Note:Quiet 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. On Windows NT and 2000 machines, you are given a choice to replace locked files when the system is rebooted.

All
All existing files are overwritten, including read-only files. On Windows NT and 2000 machines, all locked files are replaced when the system is rebooted. 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 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

number
Specifies the level of resources the TSM server and client can use during processing. The range of values that you can specify is 1 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

Runasservice

The runasservice option forces the client command process to continue running, even if the account that started the client logs off. Use this option with the at command and the NT scheduler when you schedule client command batch jobs.

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

Syntax

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

Parameters

No
Does not force the client command process to continue running, even if the account that started the client logs off. This is the default.

Yes
Forces the client command process to continue running, even if the account that started the client logs off.

Examples

Options file:
runasservice yes

Command line:
-runasservice=yes

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

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. For UNIX: The dsmsched.log file cannot be a symbolic link.

Examples

Options file:
schedlogname c:\mydir\schedlog.jan 

Command line:
-schedlogn=c:\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.

Skipntpermissions

The skipntpermissions option bypasses processing of NTFS security information. Select this option for incremental backups, selective backups, or restores. Use this option with the following commands:

Syntax

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

Parameters

No
If you specify No, the NTFS security information is backed up or restored. This is the default.

Yes
If you specify Yes, the NTFS security information is not backed up or restored.

Examples

Options file:
skipntp yes

Command line:
-skipntp=yes

Skipntsecuritycrc

The skipntsecuritycrc option computes the security cyclic redundancy check (CRC) for a comparison of NTFS security information during an incremental or selective backup archive, restore, or retrieve operation. Performance, however, might be slower because the program must retrieve all the security descriptors.

Use this option with the following commands:

Syntax

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

Parameters

No
If you specify No, the security CRC is generated during a backup. This is the default.

Yes
If you specify Yes, the security CRC is not generated during a backup. All the permissions are backed up, but the program will not be able to determine if the permissions are changed during the next incremental backup. When skipntpermissions=yes, the skipntsecuritycrc option does not apply.

Examples

Options file:
skipnts no

Command line:
-skipnts=no

Subdir

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

archive
delete archive
incremental
query archive
query backup
query backupset
restore
restore backupset
retrieve
selective
Note:This option can also be defined on the server.

Options File for 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:

rest \path\dir1\* \path2\ -su=yes
rest \path\dir1\file* \path2\ -su=yes
rest \path\dir1\file1* \path2\ -su=yes

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 adsm

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 domain name or a dot address.

Examples

Options file:
tcpclienta dsmclnt.sanjose.ibm.com

Command line:
-tcpclientaddress=128.33.10.249     

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

Tcpclientport

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.

Tcpnodelay

The tcpnodelay specifies whether to send small transactions to the server, without buffering them first. A small transaction is smaller than the byte limit set with the txnbytelimit option. Specifyingtcpnodelay=yes might improve performance in higher-speed networks.

Syntax

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

Parameters

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

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

Examples

Options file:
tcpnodelay yes

Command line:
Does not apply.

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.

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

Syntax

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

Parameters

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

The range of values is one through 2048 for Windows 2000 only. For Windows 95, Windows 98, and Windows NT 4.0, a maximum value of 63 or less is recommended. 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 adsm

Command line:
-tp=adsm     

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.

Useunicodefilenames

The useunicodefilenames option obtains file names in Unicode from the Windows NT file system. This option is used to provide support for Macintosh files stored on Windows NT servers. Except when you are backing up Macintosh files, you should use the default no for this option.

If you are backing up files in a non-English code page as well as backing up Macintosh files, you should separate the data in order to avoid switching the value from no to yes within a single file system.

The useunicodefilenames option can be used with the following commands:

Syntax

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

Parameters

No
Does not obtain file names in unicode from the Windows NT or Windows 2000 file system. This is the default.

Yes
Obtains file names in unicode from the Windows NT or windows 2000 file system.

Examples

Options file:
useunicodef yes

Command line:
-useunicodef=yes

Verbose

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.

This option also affects the amount of information displayed in NT event log and schedule log files.

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 ]