You can use defaults for processing options or you can tailor the processing options to meet specific needs. This chapter:
As a quick reference, this chapter includes instructions for the following
tasks:
During the installation of TSM, you are provided with a sample client options file called dsm.smp. This file contains processing options that are categorized as follows:
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.
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.
The default location for the client options file is the installation directory, sys:adsm. 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.
Some options are used only with commands. For more information about these options, see "Command Processing 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.
For NetWare: First, install TCP/IP on the NetWare server. For information about how to install TCP/IP, see Novell NetWare 3.11 TCP/IP Transport Supervisor's Guide (Document Number 100-000945-001).
To use the TCP/IP communication protocol, you must include the
tcpserveraddress option in your client options file. The
other TCP/IP options have default values which you can modify only if you want
to change the default value.
Option | Description | Page |
---|---|---|
httpport | Specifies a TCP/IP port address for the TSM Web client. | Httpport |
tcpbuffsize | Specifies the size, in kilobytes, of the TSM internal TCP/IP communication buffer. | Tcpbuffsize |
tcpport | Specifies the TCP/IP port address for a TSM server. | Tcpport |
tcpserveraddress | Specifies the TCP/IP address for a TSM server. | Tcpserveraddress |
tcpwindowsize | Specifies the size, in kilobytes, of the TCP/IP sliding window for your client node. | Tcpwindowsize |
The communication options for IPX/SPX have default values which can
be modified.
Option | Description | Page |
---|---|---|
ipxbuffersize | Specifies the size, in kilobytes, of the IPX/SPX communication buffer. | Ipxbuffersize |
ipxserveraddress | Specifies the IPX/SPX address for a TSM server. | Ipxserveraddress |
ipxsocket | Specifies the IPX/SPX socket number for a TSM server. | Ipxsocket |
To use SNA LU6.2 you must include either the
symbolicdestination option or all three of the following
options: cpicmodename, partnerluname, and
tpname.
Table 11. 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 |
You can use the following option to specify the client node for which you
want to request backup-archive services.
Table 12. Server and Node Options
Option | Description | Page |
---|---|---|
nodename | Specifies one of the following:
| Nodename |
You can use the following options to control some aspects of backup and
archive processing.
Table 13. Backup and Archive Processing Options
Option | Description | Page |
---|---|---|
changingretries | Specifies the number of retries when attempting to back up or archive a file that is in use. | Changingretries |
compressalways | Whether to compress files or send them if compression causes them to grow. | Compressalways |
compression | Specifies whether to compress files before sending them to the TSM server. | Compression |
dirmc | Specifies the management class to use for directories. If not specified, TSM uses the management class with the longest retention period. | Dirmc |
domain | Specifies the 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.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 |
exclude.fs | Excludes file spaces matching a pattern. | 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 for use 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 |
The following options relate to restore and retrieve processing.
Table 14. 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 |
You can use the following options to regulate central scheduling.
TSM uses scheduling options only when the Scheduler is running.
Option | Description | Page |
---|---|---|
maxcmdretries | Specifies the maximum number of times the client scheduler attempts to process a scheduled command that fails. | Maxcmdretries |
postschedulecmd | 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 only with the schedule command when you specify prompted as the schedule mode. | Tcpclientaddress |
tcpclientport | Specifies the TCP/IP port number of your client node. Use this only with the schedule command when you specify prompted as the schedule mode. | Tcpclientport |
You can use the following options to select different formats for date,
time, numbers, and different languages if you have the appropriate client
installed for that language.
Table 16. Format and Language Options
Option | Description | Page |
---|---|---|
dateformat | Specifies the format for displaying dates. | Dateformat |
language | Specifies the language used for messages. | Language |
numberformat | Specifies the format for displaying numbers. | Numberformat |
timeformat | Specifies the format for displaying times. | Timeformat |
The following options apply only when you use certain TSM commands.
Table 17. 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 |
These options control access to a TSM server.
Table 18. Authorization Options
Option | Description | Reference |
---|---|---|
nwpwfile | Whether TSM encrypts a NetWare user's ID and password and saves them to a .pwd file. | Nwpwfile |
nwuser | A user ID and password to connect to a NetWare server when you start a TSM session. | Nwuser |
optfile | The options file you want TSM to use when you start a TSM session. | Optfile |
password | A TSM password. | Password |
passwordaccess | How TSM handles a password if one is required for your workstation. | Passwordaccess |
passworddir | The directory in which you want TSM to store an automatically generated password for your client node. | Passworddir |
revokeremoteaccess | Restricts an administrator with client access privilege from accessing your workstation through the Web client. | Revokeremoteaccess |
These options specify the name of the error log file and how TSM treats the
entries in the log file.
Table 19. 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 |
These options control how TSM processes transactions between the client and
server.
Table 20. Transaction Processing Option
Option | Description | Page |
---|---|---|
commrestartduration | Specifies the maximum number of minutes you want the TSM client to try to reconnect to a TSM server after a communication error occurs. | Commrestartduration |
commrestartinterval | Specifies the number of seconds you want the TSM client to wait between attempts to reconnect to a TSM server after a communication error occurs. | Commrestartinterval |
largecommbuffers | Specifies whether the client will use increased buffers to transfer large amounts of data between the client and the server. | Largecommbuffers |
resourceutilization | Specifies the number of sessions opened between the TSM server and client during processing. | Resourceutilization |
txnbytelimit | Specifies the number of kilobytes TSM can buffer together in a transaction before sending data to the server. | Txnbytelimit |
The following are options for the TSM Web Client.
Option | Description | Page |
---|---|---|
httpport | Specifies a TCP/IP port address for the Web Client. | Httpport |
revokeremoteaccess | Restricts administrator access on a client workstation through the Web Client. | Revokeremoteaccess |
This section describes how to set options in your client options file, and how to use options with commands.
To set an option in your client options file, enter the option name, followed by one or more blank spaces, followed by the option value. For example:
compression on nodename client_a
Some options consist of only the option name, such as verbose and quiet. You can enter the entire option name, or its abbreviation. For example, you can specify the verbose option as either of the following:
verbose ve
Follow these additional rules when entering options in your client 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.
You can override some of the options in your options file by entering them with appropriate backup-archive commands.
Options are processed in the following order (precedence):
TSM also includes a group of client command options that you can enter only on the command line with specific commands. For a complete list of command line options, a description, and where to go in this book for more information, see Chapter 9, "Using Options With Commands".
To use an option with a command, enter a dash (-), the option name, an equal sign (=), and the option parameters. For example,
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".
Follow these general rules to enter options with a command:
load dsmc selective -subdir=yes sys:usr/home/proj1/* load dsmc selective sys:usr/home/proj1/* -subdir=yes
load dsmc archive -description="Project A" sys:usr/home/proj1/*
The following sections contain detailed information about each of the TSM processing options. These options are arranged in alphabetical order. Information for each option includes:
The changingretries option specifies how many additional times you want the TSM client program to attempt to back up or archive a file that is in use. 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
>>-CHAngingretries- numberretries------------------------------><
Parameters
Examples
-cha=0
The commmethod option specifies the communication method you use to provide connectivity for client-server communication.
Syntax
>>-COMMMethod-+- TCPip----+------------------------------------>< +- IPXspx---+ '- SNALu6.2-'
Parameters
Examples
-commmethod=tcp
The commrestartduration option specifies the maximum number of minutes you want the client to attempt to reconnect with a server after a communication error occurs.
Note: | The connection and schedule will fail if a communication failure occurs while a schedule is running, and the client cannot reconnect with the server before the startup window for the schedule ends. |
Syntax
>>-COMMRESTARTDuration- minutes--------------------------------><
Parameters
Examples
The commrestartinterval option specifies the number of seconds you want the client to wait between attempts to reconnect with a server after a communication error occurs.
Note: | This option is used only when commrestartduration is set to a value greater than zero. |
Syntax
>>-COMMRESTARTInterval- seconds--------------------------------><
Parameters
Examples
The compressalways option specifies whether to continue compressing an object if it grows during compression, or resend the object, uncompressed. This option is used with the compression option.
Note: | This option can also be defined on the server. |
Syntax
.-Yes--. >>-COMPRESSAlways-+------+------------------------------------->< '-No---'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in loop or interactive mode.
The compression option compresses files before you send them to the server. Compressing your files reduces data storage that is required to store backup versions and archive copies of your files. It can, however, affect TSM throughput. A fast processor on a slow network connection benefits from compression, but a slow processor on a fast network connection does not.
If compressalways=yes (the default) is specified, files continue compression even if the file size increases. To stop compression if the file size grows, and resend the file, uncompressed, specify compressalways=No.
This option controls compression only if your administrator specifies that your client node determines the selection.
Note: | This option can also be defined on the server. |
Syntax
.-No--. >>-COMPRESSIon-+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
-compressi=no
The cpicbuffersize option specifies the size of the CPIC buffer for SNA LU6.2 communication. A larger buffer can improve communication performance, but uses more memory.
Syntax
>>-CPICBuffersize- size----------------------------------------><
Parameters
Examples
-cpicbuffersize=31
The cpicmodename option defines the mode name for the SNA LU6.2 communication method. For CPIC, this option identifies the SNA connection to the gateway and target logical unit. The CPIC mode name is used if the symbolic destination is not provided, and the partner LU is located on another system. The mode name must be known on both the local and the remote systems.
If you use this option, you must also use the tpname and partnerluname options.
Syntax
>>-CPICModename- name------------------------------------------><
Parameters
Examples
-cpicmodename=vmmode
The dateformat option selects the format you want to use to display dates.
Syntax
>>-DATEformat- format_number-----------------------------------><
Parameters
Examples
The dirmc option specifies the management class you want to use for directories. If you do not specify this option to associate a management class with directories, the client program uses the management class in the active policy set of your policy domain with the longest retention period. Select a management class for individual directories that retains directories at least as long as it retains the files associated with them.
The dirmc option specifies the management class of directories being backed up, and does not effect archived directories. Archived directories are always bound to the default management class.
Note: | This option can also be defined on the server. |
Syntax
>>-DIRMc- mgmtclassname----------------------------------------><
Parameters
Examples
The domain option specifies the volumes that you want to include for incremental backup in your client domain. When used in your client options file, the domain option defines your default client domain. Your default client domain is used in the following situations to determine which volumes to process during an incremental backup:
If you do not use the domain option to specify volumes 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 volumes 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 sys: data: bindery:
and the following on the command line:
load dsmc incremental -domain=usr:
An incremental backup is performed for your sys:, data:, and usr: volumes and the bindery: .
If you use both the filespec parameter (for example, volumes ) and the domain option on the incremental command, the domain option is ignored and only those volumes in the volumes parameter are processed.
For HP-UX: If you want to use the enhanced domain option for supporting automounted file systems, set the autofs parameter to 1 in the /etc/rc.config.d/nfsconf file. Changing this parameter requires a reboot.
Note: | This option can also be defined on the server. |
Syntax
.- ----------------------. V .-all-local--------. | >>-DOMain-----+------------------+--+-------------------------->< +-domain-----------+ +-BINdery----------+ '-DIRectory or NDS-'
Parameters
The NDS is not included in the all-local domain. To include the NDS, add the directory to the domain entry.
When you use domain with the incremental command, it processes these volumes in addition to those specified in your default client domain.
The NDS is not included in the all-local domain. To include the NDS, add the directory to the domain entry.
Examples
domain sys:adsm\nds
-domain="serrvera\sys: serverb/sys:"
The editor option turns the command line interface editor and retrieve capability on or off. If the editor and command retrieve functions are not working on a specific terminal setting, we recommend you turn off this function.
Syntax
.-Yes--. >>-EDitor-+------+--------------------------------------------->< '-No---'
Parameters
Examples
The errorlogname option specifies the fully-qualified path and file name of the file where you want to store information about errors that occur during processing.
Syntax
>>-ERRORLOGName- filespec--------------------------------------><
Parameters
The default file name is dsmerror.log; it is placed in installation directory.
Examples
errorlogname dmmock\sys:tmp\adsmerr.log
-errorlog=dmmock\sys:tmp\adsmerr.log
The errorlogretention option specifies how many days to maintain error log entries before pruning the , and whether to save the pruned entries. The error log is pruned when the first error is written to the log after a TSM session is started. If the only session you run is the client scheduler, and you run it twenty-four hours a day, the error log might not be pruned according to your expectations. Stop the session and start it again to prune the error log when the next error is written.
Syntax
.-N----. .-D--. >>-ERRORLOGRetention--+------+---+----+------------------------>< '-days-' '-S--'
Parameters
The pruned entries are copied from the error log to the dsmerlog.pru file located in the same directory as the error log.
Examples
-errorlogr=400,S
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 should also be excluded.
Note: | If you change your include-exclude list so that a previously included file is now excluded, any pre-existing backup versions of that file expire the next time an incremental backup is run. |
Use wildcard characters to exclude a broad range of files. See "Including and Excluding Groups of Files" for a list of wildcard characters that you can use. Then, if necessary, use the include option to make exceptions.
To exclude an entire directory called any/test, enter the following:
exclude.dir 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.
Syntax
.- -----------------. V | >>----options pattern--+---------------------------------------><
If a matching directory is found, that directory, its files, and all its subdirectories and their files are excluded from backup services. When you exclude a directory, you can still back up specific files within that directory, using selective backup.
The exclude.dir option works only if the excluded directory is a subdirectory; if you explicitly specify the directory or the files within it, the file is backed up.
Parameters
If the pattern begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks.
You cannot use the match-all character (or any wildcard character) when specifying the high-level qualifier of an object, only use it for the low-level qualifier.
Note: | If you do not specify a server name, TSM uses the local server name. |
Examples
exclude servera\*:.../swapper.dat exclude n1\*:io.sys exclude tfr\*:.../spart.par exclude nw2\sys:*/budget.fin exclude nw6\sys:devel/*
The httpport option specifies a TCP/IP port address for the Web client.
Syntax
>>-HTTPport- port_address--------------------------------------><
Parameters
Examples
The include options specify one of the following:
If you do not assign a specific management class to objects, the default management class in the active policy set of your policy domain is used.
Note: | You cannot use the include option to override an exclude.dir option. |
See Chapter 7, "Creating an Include-Exclude List" for more information.
Syntax
.- ------------------------------------. V | >>----options pattern-+----------------+--+-------------------->< '- mgmtclassname-'
Parameters
If the pattern begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks.
Examples
include servera\sys:proj/text/devel.* include servera\sys:proj/text/* textfiles include *:* managall
The ipxbuffersize option specifies the IPX buffer size needed to transfer data between the client node and the server. A larger buffer can improve communication performance, but uses more memory.
Syntax
>>-IPXBuffersize- size-----------------------------------------><
Parameters
Examples
The ipxserveraddress option specifies the IPX/SPX address of a server on an OS/2 or AIX host that is not in the same network as the client node. If the IPX/SPX address is not specified, the server must be in the same network as the client node.
Syntax
>>-IPXSErveraddress- server_address----------------------------><
Parameters
If an IPX/SPX address is not specified, the default address for the server is the same address as the client workstation.
Examples
The ipxsocket option specifies the socket number for a server on a NetWare, Windows NT, Windows 2000, Windows 95, or Windows 98 host.
Syntax
>>-IPXSOcket- socketnumber-------------------------------------><
Parameters
Examples
The language option specifies the national language in which to present client messages.
Syntax
>>-LANGuage- language------------------------------------------><
Parameters
Currently, you can use American English (AMENG) only.
You can use American English (AMENG) with all clients. To use a different language, order the client in that language. The available languages include:
Examples
The largecommbuffers option specifies whether the client uses increased buffers to transfer large amounts of data between the client and the server. You can disable this option when your machine is running low on memory.
Syntax
.-No--. >>-LARGECOMmbuffers-+-----+------------------------------------>< '-Yes-'
Parameters
Examples
The maxcmdretries option specifies the maximum number of times the client scheduler (on your workstation) attempts to process a scheduled command that fails. The command retry starts only if the client scheduler has not yet backed up a file, never connected to the server, or failed before backing up a file. This option is used only when the scheduler is running.
Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides what you specify in the client options file after your client node successfully contacts the server.
Note: | This option can also be defined on the server. |
Syntax
>>-MAXCMDRetries- maxcmdretries--------------------------------><
Parameters
Examples
-maxcmdretries=3
The memoryefficientbackup option specifies a memory conserving algorithm for processing incremental backups, that backs up one directory at a time, using less memory. Use this option when your machine is memory constrained.
Note: | This option can also be defined on the server. |
Syntax
.-Yes--. >>-MEMORYEFficientbackup-+------+------------------------------>< '-No---'
Parameters
Examples
The nodename option identifies your workstation to the server. You can use different node names to identify multiple systems on your workstation.
You can also use the nodename option if you want to restore or retrieve files from the server while you are working from a different workstation. When you use the nodename option, you are prompted for the TSM password assigned to the node you specify, if a password is required.
Syntax
>>-NODename- nodename------------------------------------------><
Parameters
Examples
-nod=banshee
The numberformat option specifies the format you want to use to display numbers.
Syntax
>>-NUMberformat- number----------------------------------------><
Parameters
Examples
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
Examples
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
Examples
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
Examples
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.
The nwwaitonerror option specifies that the client program responds in one of the following ways, if an error occurs while exiting:
Note: | You can exploit 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 post this prompt. |
Syntax
.-Yes--. >>-NWWaitonerror----+------+----------------------------------->< '-No---'
Parameters
Examples
The optfile option specifies the client options file you want to use when you start a TSM session.
Syntax
>>-OPTFILE- file_name------------------------------------------><
Parameters
Examples
load dsmc query session -optfile=sys:adsm/spike.opt
This option is valid only on the initial command line. It is not valid in interactive mode.
The partnerluname option specifies a logical unit name that the transaction program uses to identify the server in the SNA network. The partner logical unit name is used if the symbolic destination name is not provided for SNA LU6.2 communications. If you use this option, also define the cpicmodename and tpname options.
Syntax
>>-PARtnerluname- logical_unit_name----------------------------><
Parameters
partnerluname nameone.nametwo
Contact your system administrator for this name. There is no default.
Examples
-par=sanjose.vm
The password option specifies a TSM password. If this option is not used and your administrator has set authentication to On, you are prompted for a password when you start a TSM session.
Note: | If you are prompted for a password, it is not displayed as you enter it. However, if you use the password option, your password is displayed when you enter it. |
The password option is ignored when the passwordaccess option is set to generate.
Syntax
>>-PASsword- password------------------------------------------><
Parameters
Examples
The passwordaccess option specifies whether you want your TSM password generated automatically, or set as a user prompt. A password is required for your client node only when your administrator enables the authentication feature. Check with your administrator to verify that a password is required for your client node.
If a password is required, you can choose to:
Use the passworddir option in your client system options file to specify the directory location in which to store the encrypted password file. The default directory location depends on how the client was installed.
When the passwordaccess option is set to generate and you specify the password option, the password option is ignored.
When using the Web client, set the passwordaccess option to generate.
Syntax
.-prompt---. >>-PASSWORDAccess-+----------+--------------------------------->< '-generate-'
Parameters
To keep your client node password secure, enter commands without the password, and wait for TSM to prompt you for the password.
A password prompt displays when registering a workstation with a server using open registration, or if your password was changed manually by the administrator.
Examples
The passworddir option forces the directory location in which to store an encrypted password file. The default directory location depends upon how the client was installed.
Syntax
>>-PASSWORDDIR- directoryname----------------------------------><
Parameters
Examples
passworddir
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
Use a blank, or null string for cmdstring if you want to prevent any commands from running that the administrator uses for postschedulecmd or preschedulecmd. If you specify a blank, or null string on either option, it prevents the administrator from using a command on both options.
If your administrator uses a blank, or null string on the postschedulecmd option, you cannot run a post-schedule command.
If the command string contains blanks, enclose it in double quotes. If you have double quotes within the command string, use single quotes to enclose them.
Examples
The command string is a valid command for restarting your database.
The preschedulecmd option specifies a command that the client program processes before it runs a schedule. The client program waits for the command to complete before it starts the schedule.
Note: | The preschedulecmd option can also be defined on the server. |
Syntax
>>---PRESchedulecmd----- "cmdstring"---------------------------><
Parameters
Use a blank, or null string for cmdstring if you want to prevent any commands from running that the administrator uses for postschedulecmd and preschedulecmd. If you specify a blank, or null string on either option, it prevents the administrator from using a command on both options.
If your administrator uses a blank, or null string on the preschedulecmd option, you cannot run a pre-schedule command.
If the command string contains blanks, enclose it in double quotes. If you placed double quotes within the command string, use single quotes to enclose them.
Examples
The command string is a valid command for quiescing your database.
The 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
Examples
The queryschedperiod option specifies the number of hours you want the client scheduler to wait between attempts to contact the server for scheduled work. This option applies only when you set the schedmode option to polling. This option is used only when the scheduler is running.
Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides the value set in your client options file after your client node successfully contacts the server.
Note: | This option can also be defined on the server. |
Syntax
>>-QUERYSCHedperiod- hours-------------------------------------><
Parameters
Examples
The quiet option prevents messages from displaying on your screen during processing. For example, when you run the incremental, selective, or restore backupset commands, information displays about each file that is backed up. Use the quiet option if you do not want TSM to display this information.
When you use the quiet option, some error information still displays on your screen, and messages are written to log files. If you do not specify quiet, the default option, verbose is used.
Note: | Quiet can also be defined on the server and overrides the client setting. |
Syntax
>>-QUIET-------------------------------------------------------><
Examples
The replace option specifies what you want the system to do when it restores files that already exist on your workstation. This option applies to the restore, retrieve and restore backupset commands only.
Syntax
.-Prompt--. >>-REPlace-+---------+----------------------------------------->< +-All-----+ +-Yes-----+ '-No------'
Parameters
Examples
The resourceutilization option regulates the level of resources the TSM server and client can use during processing. For example, a setting of resourceutilization=1 uses less system resources than a setting of resourceutilization=10.
Syntax
>>-RESOURceutilization- number---------------------------------><
Parameters
Examples
The retryperiod option specifies the number of minutes the client scheduler waits between attempts to process a scheduled command that fails, or between unsuccessful attempts to report results to the server. This option is used only when the scheduler is running.
Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides the value specified in your client options file after your client node successfully contacts the server.
Note: | This option can also be defined on the server. |
Syntax
>>-RETRYPeriod- minutes----------------------------------------><
Parameters
Examples
-retryperiod=15
The revokeremoteaccess option restricts an administrator with client access privilege from accessing a client workstation that is running the Web client. This option does not restrict administrators with client-owner, system, or policy privilege from accessing your workstation through the Web client.
Syntax
.-None---. >>-REVOKEremoteaccess-+--------+------------------------------->< '-Access-'
Parameters
Examples
The schedlogname option specifies the path and file name where you want to store schedule log information. This option applies when the scheduler is running.
When you run the schedule command, output from scheduled commands displays on your screen. Output is also sent to the file you specified with this option.
Syntax
>>-SCHEDLOGName- filespec--------------------------------------><
Parameters
If you specify a file name only, the file is stored in your current directory. The default is the installation directory with a file name of dsmsched.log.
Examples
schedlogname dmmock\sys:mydir/schedlog.jan
-schedlogn=dmmock\sys:mydir/schedlog.jan
The schedlogretention option specifies the number of days to keep entries in the schedule log, and whether to save the pruned entries. The schedule log is pruned after a scheduled event completes.
Syntax
.-N----. .-D--. >>-SCHEDLOGRetention----+------+---+----+---------------------->< '-days-' '-S--'
Parameters
Pruned entries are copied from the log to the dsmsched.pru file that is stored in the same directory as the schedule log.
Examples
-schedlogretention=30,S
Note: | This option applies only if you are using the TCP/IP communication method, and the schedule command is running. |
The schedmode option specifies whether you want to use the client-polling mode (your client node periodically asks the server for scheduled work), or the server-prompted mode (the server contacts your client node when it is time to start a scheduled operation). All communication methods can use the client polling mode, but only TCP/IP can use the server prompted mode.
Your administrator can specify that the server support either mode or one mode. If your administrator specifies either mode, you can select the schedule mode. If your administrator specifies only one mode, specify that same mode in your client options file, or scheduled work will not process.
If the schedule mode is prompted, supply values for the tcpclientaddress and tcpclientport options on the schedule command. You can then be contacted at an address or port other than the one that made first contact with the server.
Note: | This option can also be defined on the server. |
Syntax
.-POlling--. >>-SCHEDMODe-+----------+-------------------------------------->< '-PRompted-'
Parameters
Examples
The scrolllines option specifies the number of lines you want to appear at one time when lists of information display on your screen. Use this option when you set the scrollprompt option to Yes, and you use commands.
Note: | This option can also be defined on the server. |
Syntax
>>-SCROLLLines- number-----------------------------------------><
Parameters
Examples
The scrollprompt option specifies whether you want the client program to stop and wait after displaying the number of lines you indicated with the scrolllines option, or if you want the client program to scroll through all lines and stop at the end of the list.
Note: | This option can also be defined on the server. |
Syntax
.-No--. >>-SCROLLPrompt-+-----+---------------------------------------->< '-Yes-'
Parameters
Press 'Q' to quit, 'C' to continuous scroll, or 'Enter' to continue.
Examples
The subdir option specifies whether you want to include
subdirectories of named directories on the following commands:
|
|
Note: | This option can also be defined on the server. |
Syntax
.-No--. >>-SUbdir-+-----+---------------------------------------------->< '-Yes-'
Parameters
Note: | If you use the preservepath option in addition to subdir=yes, it can affect which subdirectories are are processed. |
If a subdirectory is a mounted file system, it is not processed even if subdir is Yes.
Examples
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
The symbolicdestination option specifies a symbolic server name. Contact your administrator for the correct name. The symbolic destination name indexes SNA routing and security parameters that are stored in communication directory files.
When a symbolic destination is used with the commmethod option for SNA LU6.2 communication, you do not need to specify the tpname, partnerluname, or cpicmodename options.
This option is required if your communication protocol is SNA LU6.2 and a transaction program name or partner logical unit name is not provided.
Syntax
>>-SYMbolicdestination- sym_dest_name--------------------------><
Parameters
Examples
-sym=anrserv
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.
Note: | This option can also be defined on the server. |
Syntax
.-No--. >>-TAPEPrompt-+-----+------------------------------------------>< '-Yes-'
Parameters
Examples
The tcpbuffsize option specifies the size to use for the internal TCP/IP communication buffer. Although it uses more memory, a larger buffer can improve communication performance.
Syntax
>>-TCPBuffsize- size-------------------------------------------><
Parameters
As a result of the operating system communication settings, your system might not accept all values in the range of one through 512.
Examples
-tcpbuffsize=31
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpclientaddress option specifies a TCP/IP address if your client node has more than one address, and you want the server to contact an address other than the one that was used to make the first server contact.
Use this option only if you use the prompted parameter with the schedmode option, or when the schedule command is running.
Syntax
>>-TCPCLIENTAddress- client_address----------------------------><
Parameters
Examples
-tcpclientaddress=128.33.10.249
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpclientport option specifies a different TCP/IP port number for the server to contact other than the one that was used to make the first server contact. If the default port or the specified port is busy, the server attempts to use any other available port. Use this option only if you specify the prompted parameter with the schedmode option, or when the schedule command is running.
Syntax
>>-TCPCLIENTPort- client_port_address--------------------------><
Parameters
Examples
-tcpclientport=1492
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpport option specifies a TCP/IP port address for a server. Obtain this address from your administrator.
Syntax
>>-TCPPort- port_address---------------------------------------><
Parameters
Examples
-tcpport=1501
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpserveraddress option specifies the TCP/IP address for a server. Obtain this server address from your administrator.
Syntax
>>-TCPServeraddress- server_address----------------------------><
Parameters
Examples
-tcpserveraddress=129.33.24.99
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpwindowsize option specifies the amount of data in kilobytes that is buffered when receiving data on a TCP/IP connection. To improve backup or archive performance, increase the tcpwindowsize on the TSM server. To improve restore or retrieve performance, increase the tcpwindowsize on the TSM client. For more information about improving communication performance, see the ADSM Performance Tuning Guide at URL: http://www.tivoli.com/tsm.
Syntax
>>-TCPWindowsize- window_size----------------------------------><
Parameters
The range of values is one through 64; the default is 32.
Note: | As a result of the operating system communication settings, your system might not accept all values in the range of values. |
Examples
-tcpw=24
This option is valid only on the initial command line; not in interactive mode.
The timeformat option specifies the format in which you want system time displayed.
Syntax
>>-TIMEformat- format_number-----------------------------------><
Parameters
Examples
The tpname option specifies a symbolic name for the transaction program name. The transaction program name is required if the symbolic destination name is not provided for SNA LU6.2 communication.
If you use this option, define the cpicmodename and partnerluname options also.
Syntax
>>-TPname- tp_name---------------------------------------------><
Parameters
Examples
-tp=adsm
This option is valid only on the initial command line. It is not valid in interactive mode.
The txnbytelimit option specifies the number of kilobytes the client program should buffer before it sends a transaction to the server.
Note: | This option is adjusted by the server as required during self-tuning operations. |
This option permits you to control the amount of data sent between the client and server before the server commits the data and changes to the server database, thus changing the speed with which the client performs work. The amount of data sent applies when files are batched together during backup or when receiving files from the server during a restore procedure.
The server administrator can limit the number of files or directories contained within a group transaction using the txngroupmax option; the actual size of a transaction can be less than your limit. Once this number is reached, the client sends the files to the server even if the transaction byte limit is not reached.
Note: | This option can also be defined on the server and adjusted as required during self-tuning operations. |
Syntax
>>-TXNBytelimit- number----------------------------------------><
Parameters
Examples
This option is valid only on the initial command line; not in interactive mode.
The verbose option specifies that you want processing information to display on your screen. This is the default. Specify the quiet option if you do not want processing information to display on your screen.
If either the quiet or verbose option is specified in the server client option set, then the server setting overrides the quiet or verbose option specified on the client, even if force is set to No on the server.
Note: | This option can also be defined on the server and overrides the client setting. |
Syntax
>>-VErbose-----------------------------------------------------><
Parameters
There are no parameters for this option.
Examples