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 |
---|---|
"Setting Options in a File" | "Setting Options in a File" |
"Using Options With Commands" | "Using Options With Commands" |
"Setting Space Management Options" | "Setting Space Management Options" |
TSM uses processing options to control communications, backup-archive processing, and other types of processing.
This section provides an overview of the options you can enter in your client options file. These options are categorized as follows:
On UNIX systems, these options reside in three types of files:
On all other platforms, all options reside in the client options file (Preferences file for Macintosh).
You can enter common options with specific commands to override many of the options set in your client options file. Options are processed in the following order (precedence):
There are also options that are used only with TSM commands. For more information about those options, see the following publications:
You use communication options to specify how your client node communicates
with a TSM server. Table 12 shows communication protocols supported for various TSM
client platforms. See "Options Available by Platform" for a list of options supported on each platform.
Table 12. Communication Protocols by Client
Protocol | Macintosh | NetWare | OS/2 | UNIX | Windows NT, 2000 | Windows 95, 98 | ||
---|---|---|---|---|---|---|---|---|
IPX/SPX |
| x | x |
| x | x | ||
Named Pipes |
|
| x |
| x |
| ||
NETBIOS |
|
| x |
| x |
| ||
Shared Memory |
|
| x | x2 |
|
| ||
SNA LU6.2 |
| x | x | x1 | x | x | ||
TCP/IP | x | x | x | x | x | x | ||
|
|
|
Use the commmethod option to specify the communication protocol. For more information, see Commmethod. Ask your TSM administrator for assistance in setting your communication options.
To use the TCP/IP communication protocol, you must include the tcpserveraddress option in your client options file. The other TCP/IP options have default values which you can modify only if you want to change the default value.
For UNIX: If you plan to back up an NFS system, see Nfstimeout.
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. the AIX client only. | Tcpnodelay |
tcpport | Specifies the TCP/IP port address for a TSM server. | Tcpport |
tcpserveraddress | Specifies the TCP/IP address for a TSM server. | Tcpserveraddress |
tcpwindowsize | Specifies the size, in kilobytes, of the TCP/IP sliding window for your client node. | Tcpwindowsize |
The communication options for IPX/SPX have default values which can
be modified.
Option | Description | Page |
---|---|---|
ipxbuffersize | Specifies the size, in kilobytes, of the IPX/SPX communication buffer. | Ipxbuffersize |
ipxserveraddress | Specifies the IPX/SPX address for a TSM server. | Ipxserveraddress |
ipxsocket | Specifies the IPX/SPX socket number for a TSM server. | Ipxsocket |
The communication option for Named Pipes is:
Table 15. Named Pipes Communication Option
Option | Description | Page |
---|---|---|
namedpipename | Specifies the name of a named pipe to use for communications between a TSM client and a TSM server on the same Windows workstation. | Namedpipename |
The communication options for NETBIOS have default values which can be
modified.
Table 16. 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 |
For NetWare: First, install SNA LU6.2 on the NetWare server. For information about how to install SNA, see Novell NetWare for SAA Version 1.3 Administration Guide (Document Number 100-001166-002).
For Windows NT: 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 17. SNA LU6.2 (APPC) Options
Option | Description | Page |
---|---|---|
cpicbuffersize | The buffer size for SNA LU6.2 communication. | Cpicbuffersize |
cpicmodename | The mode name for SNA LU6.2 communication. | Cpicmodename |
partnerluname | A logical unit name used by the transaction program to identify the TSM server in the SNA network. | Partnerluname |
symbolicdestination | A symbolic TSM server name. | Symbolicdestination |
tpname | A symbolic name for a transaction program in an SNA network. The transaction program identifies the target logical unit (LU), which is the TSM server. | Tpname |
TCP/IP must be installed on your workstation to use the shared memory
communication method.
Table 18. Shared Memory Communication Options
Option | Description | Page |
---|---|---|
shmport | Specifies the TCP/IP port address on which the server listens to establish a shared memory connection. | Shmport |
shmqueuename | Specifies the name of the TSM server's shared memory queue. | Shmqueuename |
You can use the following options to specify the server you want to contact
for backup-archive services, and the client node for which you want to request
backup-archive services.
Table 19. Server and Node Options
Option | Description | Page |
---|---|---|
defaultserver | The name of the TSM server to contact for backup-archive services by
default if more than one server is defined in the client system options
file.
Also specifies the TSM server to contact for space management services if you have the HSM client installed and do not specify a server with the migrateserver option. | Defaultserver |
migrateserver | Specifies the TSM server to contact for space management services. | Migrateserver |
clusternode | Specifies whether Tivoli Storage Manager is running as a cluster node. | Clusternode |
nodename | Specifies one of the following:
| Nodename |
servername | In client system options file this option specifies the name of a server. In the client user options file this option specifies the TSM server to contact for services. | Servername |
virtualnodename | Specifies the name of another client node. Use this option if you want to restore or retrieve your files from a TSM server to a client node other than the one on which you stored files. | Virtualnodename |
You can use the following options to control some aspects of backup and
archive processing.
Table 20. Backup and Archive Processing Options
Option | Description | Page |
---|---|---|
archsymlinkasfile | Specifies whether you want TSM to follow a symbolic link and archive the file or directory it points to, or archive the symbolic link only. This option is for UNIX clients only. | Archsymlinkasfile |
automount | The automount option is used with the domain option to specify all automounted filesystems in the domain that will be mounted when the TSM client starts, and included for backup services. This option is for UNIX clients only. | Automount |
backupregistry | Specifies whether to back up the Windows registry. This option is for the Windows client only. | 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.
Note: The compression option also applies to migrated files if you have the TSM HSM client installed on your workstation. | 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 volumes, file systems, or drives to include in your default client domain for an incremental backup. | Domain |
domain.image | Specifies the file systems included in your default client domain for an image back up. | Domain.image |
exclude | Excludes a file or group of files from backup services and space management services (if the HSM client is installed). Any file in your client domain that is not specifically excluded with this option is considered for backup. | Exclude Options |
exclude.archive | Excludes a file or group of files from archive services. | Exclude Options |
exclude.backup | Excludes a file or a group of files from normal backup services, but not from HSM. | Exclude Options |
exclude.dir | Excludes the specified directory, its files, and all its subdirectories and their files are excluded from backup services. | Exclude Options |
exclude.file | Excludes files, but not directories, that match a pattern. | Exclude Options |
exclude.file.backup | Excludes a file from normal backup services. | Exclude Options |
exclude.file.spacemgmt | Excludes a file from hierarchical space management services (HSM) only. Use this option when you have both the backup-archive client and the HSM client installed. | Exclude Options |
exclude.fs | Excludes file spaces matching a pattern. | Exclude Options |
exclude.image | Excludes mounted file systems and raw logical volumes that match the pattern from image processing. This option is valid for AIX, HP-UX, and Solaris only. | Exclude Options |
exclude.spacemgmt | Excludes a group of files from HSM backup only. Use this option when you have both the backup-archive client and the HSM client installed. | Exclude Options |
guitreeviewafterbackup | Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. | Guitreeviewafterbackup |
inclexcl | Specifies the path and file name of your include-exclude options file. | Inclexcl |
include | Includes files or management classes for backup or archive processing. | Include Options |
include.file | Includes a file for backup services, or assigns a management class to a file. | Include Options |
include.image | Includes a file space or logical volume, or assigns a management class when used with the backup image command. The backup image command ignores all other include options. | 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 |
os2lanservacpsupport | Specifies the OS/2 Lan Server local and network attached drives from which ACL data associated with files and directories is backed up. | Os2lanservacpsupport |
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 |
virtualmountpoint | Specifies a directory to serve as a virtual mount point for a file system. This provides a direct path to the files you want TSM to consider for backup, saving processing time. | Virtualmountpoint |
The following options relate to restore and retrieve processing.
Table 21. Restore and Retrieve Processing Options
Option | Description | Page |
---|---|---|
activatekey | Specifies whether TSM activates the registry key to update the registry after restoring files. | Activatekey |
followsymbolic | Specifies that you want TSM to restore files to symbolic links, and permit a symbolic link to be used as a virtual mount point. | Followsymbolic |
guitreeviewafterbackup | Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. | Guitreeviewafterbackup |
replace | Specifies whether to overwrite an existing file, or to prompt you for your selection when you restore or retrieve files. | Replace |
restoremigstate | Specifies whether TSM restore stub files for migrated files, or restore backup versions of migrated files. This option is valid only when the HSM client is also installed on an AIX or Solaris workstation. | Restoremigstate |
subdir | Specifies whether you want to include subdirectories of a named directory. | Subdir |
tapeprompt | Specifies whether you want TSM to wait for a tape required for a restore or retrieve to be mounted, or to prompt you for your choice. | Tapeprompt |
You can use the following options to regulate central scheduling.
TSM uses scheduling options only when the Scheduler is running.
Option | Description | Page |
---|---|---|
maxcmdretries | Specifies the maximum number of times the client scheduler attempts to process a scheduled command that fails. | Maxcmdretries |
postschedulecmd postnschedulecmd | Specifies a command to process after running a schedule. | Postschedulecmd |
preschedulecmd prenschedulecmd | Specifies a command to process before running a schedule. | Preschedulecmd |
queryschedperiod | Specifies the number of hours the client scheduler waits between unsuccessful attempts to contact the TSM server for scheduled work. | Queryschedperiod |
retryperiod | Specifies the number of minutes the client scheduler waits between attempts to process a scheduled command that fails or between unsuccessful attempts to report results to the server. | Retryperiod |
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 |
schedcompleteaction | Specifies an action to take after a schedule has been completed. This option is for the Macintosh client only. | Schedcompleteaction |
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, and numbers.
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 24. 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 |
matchallchar | Specifies the character to use as a match-all wildcard character. This option is for the Macintosh client only. | Matchallchar |
matchonechar | Specifies the character to use as a match-one-character wildcard character. This option is for the Macintosh client only. | Matchonechar |
optionformat | Specifies the format to use when you enter TSM HSM client
commands.
Use this option only when you use TSM HSM client commands. | Optionformat |
quiet | Specifies that processing information does not display on your screen. This option can be overidden by the TSM server. | Quiet |
scrolllines | Specifies the number of lines to display at one time when displaying a list of items. Use this option only when scrollprompt is set to yes. | Scrolllines |
scrollprompt | Specifies whether TSM stops after displaying the number of lines specified by scrolllines, or it scrolls to the end of the list. | Scrollprompt |
verbose | Specifies that processing information should display on your screen. The alternative is quiet. This option can be overridden by the TSM server. | Verbose |
These options control access to a TSM server.
Table 25. Authorization Options
Option | Description | Reference |
---|---|---|
groups | Specifies the groups on your workstation that you want to authorize to request services from the TSM server. | Groups |
mailprog | The program and user ID to which you want TSM to send a newly generated password when the old one expires. | Mailprog |
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 |
users | Particular users on your workstation who can request services from a TSM server. | Users |
These options specify the name of the error log file and how TSM treats the
entries in the log file.
Table 26. 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 27. Transaction Processing Option
Option | Description | Page |
---|---|---|
commrestartduration | Specifies the maximum number of minutes you want the TSM client to try to reconnect to a TSM server after a communication error occurs. | Commrestartduration |
commrestartinterval | Specifies the number of seconds you want the TSM client to wait between attempts to reconnect to a TSM server after a communication error occurs. | Commrestartinterval |
largecommbuffers | Specifies whether the client will use increased buffers to transfer large amounts of data between the client and the server. | Largecommbuffers |
nfstimeout | Specifies the amount of time, in seconds, TSM waits for an NFS system call response before timing out. | Nfstimeout |
resourceutilization | Specifies the number of sessions opened between the TSM server and client during processing. | Resourceutilization |
txnbytelimit | Specifies the number of kilobytes TSM can buffer together in a transaction before sending data to the server. | Txnbytelimit |
If you have the TSM HSM client installed on your workstation, these options
affect automatic migration, recall, and reconciliation.
Table 28. Space Management Options
Option | Description | Page |
---|---|---|
checkthresholds | How often the space monitor daemon checks space usage on your file system. | Checkthresholds |
errorprog | The path and file name of the program TSM notifies if a severe error occurs during HSM processing. | Errorprog |
kernelmessages | Whether HSM related messages issued by the kernel are displayed. | Kernelmessages |
maxrecalldaemons | The maximum number of recall daemons you want to run at one time. | Maxrecalldaemons |
maxreconcileproc | The maximum number of automatic reconciliation processes HSM can perform at one time. | Maxreconcileproc |
maxthresholdproc | The maximum number of automatic threshold migration processes TSM can perform at one time. | Maxthresholdproc |
migfileexpiration | The number of days a migrated or premigrated file remains in TSM storage after the file is modified on the local file system or is erased from the local file system. | Migfileexpiration |
migrateserver | The name of the server to which you want to migrate files for your client node. | Migrateserver |
minrecalldaemons | The minimum number of recall daemons to retain. | Minrecalldaemons |
optionformat | The format users must use when entering TSM HSM commands. | Optionformat |
reconcileinterval | How often TSM automatically reconciles the file systems on your workstation. | Reconcileinterval |
The following are options for the TSM Web Client.
Option | Description | Page |
---|---|---|
httpport | Specifies a TCP/IP port address for the Web Client. | Httpport |
httpsport | Specifies a TCP/IP Secure Socket Layer (SSL) port address for the Web Client. | Httpsport |
revokeremoteaccess | Restricts administrator access on a client workstation through the Web Client. | Revokeremoteaccess |
This section describes how to set options in your client options file.
To view or modify the Preferences file, select the Edit menu> Preferences item on the backup-archive GUI. The graphical options editor updates the client configuration Preferences file, if any options have changed.
Use SimpleText or some other Macintosh text editor to tailor the Preferences file.
To set an option in 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:
For NetWare: the maximum number of characters in a file name is 256. The maximum combined length of the file name and path name is 512 characters.
For OS/2 and UNIX: the maximum number of characters in a file name is 256. The maximum combined length of the file name and path name is 1024 characters.
For Windows: the maximum number of characters in a file name is 256. The maximum combined length of the file name and path name is 256 characters.
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.
You can override some of the options in your options file by entering them with appropriate backup-archive commands. You cannot override options by entering them with HSM commands. See the following client publications for more information:
The HSM client provides space management options that you can set in your client system options file. The values you set for space management options determine which server your client node contacts for space management services and affect automatic migration, reconciliation, and recall.
HSM also provides the optionformat option that you can set in your client user options file to specify how users can enter HSM commands.
In your client system options file, you group options into stanzas for each server your client node contacts for backup, archive, and space management services.
All of the space management options except the errorprog option must be placed before the stanzas for each server defined in your client system options file. For example, if you want to specify a default server for backup and archive services, a migration server, and new values for other space management options, you can place the options in your client system options file as shown in Figure 7.
Figure 7. Example of Client System Options File with HSM Options
DEFAULTServer server1 MIGRATEServer server2 CHEckthresholds 2 RECOncileinterval 12 MAXRECOncileproc 5 MAXThresholdproc 5 MIGFILEEXPiration 10 MINRECAlldaemons 5 MAXRecalldaemons 15 KERNelmessages no Servername server1 COMMmethod TCPip TCPPort 1500 TCPServeraddress almvmd.almaden.ibm.com Passwordaccess generate Mailprog /usr/bin/xsend root Groups system adsm Users steiner chron wang nguyen Inclexcl /adm/adsm/backup.excl ERRORProg /bin/cat Servername server2 COMMmethod SNAlu6.2 PARtnerluname raptor TPname appcdel CPICMOdename appc Passwordaccess generate Mailprog /usr/bin/xsend root Groups system adsm Users sullivan tang schaefer Inclexcl /adm/adsm/migrate.excl ERRORProg /bin/cat |
You set space management options when you install and set up TSM on your workstation or file server. You can also modify space management options later. However, there are special considerations for modifying server options, modifying options that are used by space management daemons, and modifying the kernelmessages option.
You can migrate files from your workstation to only one server. After HSM begins migrating files to storage, modify the options you use to specify which server your client node contacts for space management services only if your administrator exports your migrated files from one server and imports them to another. Otherwise, TSM cannot locate your migrated files until you change the options to point to the appropriate server.
You can specify which server to contact for space management services using the following options:
Users cannot override the migration server by using the servername option in a client user options file or with a command.
Users can override the default server by using the servername option in a client user options file or with a command for backup and archive services, but the default server cannot be overriden for space management services.
If you do not specify a server with the migrateserver option or the defaultserver option, TSM contacts the server specified in the first stanza of your client system options file for space management services and for backup-archive services by default. Users can override the default server for backup-archive services, but not for space management services.
There are several options you can modify that are used by space management daemons. Those options are:
For example, if you want the space monitor daemon to check space usage on your file systems more frequently or less frequently, you can change the value specified for the checkthresholds option. Or, if you frequently use an application that opens multiple files at one time, and that application uses all available recall daemons because all of the files are migrated, you might want to increase the value specified for the maxrecalldaemons option. If HSM is unable to start a recall daemon for another process that attempts to access a migrated file, that process stops until a recall daemon is available.
If you change the values specified for options used by space management daemons, the new values do not take effect until you reboot your system or shut down and restart the space monitor daemon and any recall daemons that are running.
For detailed information about the space monitor daemon and recall daemons, see Using the UNIX HSM Clients, order number SH26-4083.
To shut down the space monitor daemon and recall daemons:
To restart the daemons, issue these commands:
If you change the value specified for the kernelmessages option, the new value does not take effect until the next time the HSM kernel extension is loaded for your workstation.
The kernel extension is loaded each time you reboot your system or, if none of the file systems to which you add space management are automatically mounted when you reboot, whenever you mount the first of one or more file systems to which you have added space management.
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:
Note: | For options with a yes parameter, acceptable alternatives are 1, true, and on. For options with a no parameter, acceptable alternatives are 0, false, and off. |
For UNIX: The only options that can be placed before any server stanzas are the following:
TSM processing options reside in these files:
This file contains required communication options, authorization options, a subset of options that relate to backup and archive processing, scheduling options, and options that relate to HSM.
If you are a root user, you are responsible for creating and modifying the client system options file.
The client user options file contains options that control processing for sessions with TSM, including some additional options that relate to backup, archive, restore, and retrieve processing.
If you are a root user, you create a default client user options file that can be used by all users on your workstation.
If you are a user and want to use different options than those specified in the default client user options file, you can create your own options file.
You can always override any of the options set in the client user options file you use by entering the options with appropriate commands. For more information, see Using Options With Commands.
The include-exclude options file contains a list of the include and exclude options. See Chapter 8, Creating an Include-Exclude List for detailed examples for each platform.
Table 30 lists the options available for all supported
platforms.
Table 30. Options Available by Platform
Option | Macintosh | NetWare | OS/2 | UNIX | Windows NT, 2000 | Windows 95, 98 | ||
---|---|---|---|---|---|---|---|---|
activatekey |
|
|
|
| x | x | ||
archsymlinkasfile |
|
|
| x |
|
| ||
automount |
|
|
| x6 |
|
| ||
backupregistry |
|
|
|
| x | x | ||
changingretries | x | x | x | x | x | x | ||
checkthresholds |
|
|
| x5 |
|
| ||
clusternode |
|
|
|
| x |
| ||
commmethod | x | x | x | x | x | x | ||
commrestartduration | x | x | x | x | x | x | ||
commrestartinterval | x | x | x | x | x | x | ||
compressalways | x | x | x | x | x | x | ||
compression | x | x | x | x | x | x | ||
cpicbuffersize |
| x | x | x2 | x | x | ||
cpicmodename |
| x | x | x2 | x | x | ||
dateformat | x | x | x | x | x | x | ||
defaultserver |
|
|
| x |
|
| ||
dfsbackupmntpnt |
|
|
| x3 | x |
| ||
dirmc | x | x | x | x | x | x | ||
domain | x | x | x | x | x | x | ||
domain.image |
|
|
| x1 |
|
| ||
editor |
| x | x | x | x | x | ||
errorlogname | x | x | x | x | x | x | ||
errorlogretention | x | x | x | x | x | x | ||
errorprog |
|
|
| x5 |
|
| ||
exclude | x | x | x | x | x | x | ||
exclude.archive | x | x | x | x | x | x | ||
exclude.backup | x | x | x | x | x | x | ||
exclude.dir | x | x | x | x | x | x | ||
exclude.file | x | x | x | x | x | x | ||
exclude.file.backup | x | x | x | x | x | x | ||
exclude.file.spacemgmt |
|
|
| x5 |
|
| ||
exclude.fs |
|
|
| x4 |
|
| ||
exclude.image |
|
|
| x1 |
|
| ||
exclude.spacemgmt |
|
|
| x5 |
|
| ||
followsymbolic |
|
|
| x |
|
| ||
groups |
|
|
| x |
|
| ||
guitreeviewafterbackup | x |
| x | x | x | x | ||
httpport |
| x | x | x | x | x | ||
httpsport |
|
| x | x1 | x | x | ||
inclexcl |
|
|
| x |
|
| ||
include | x | x | x | x | x | x | ||
include.file | x | x | x | x | x | x | ||
include.image |
|
|
| x1 |
|
| ||
ipxbuffersize |
| x | x |
| x | x | ||
ipxserveraddress |
| x | x |
| x | x | ||
ipxsocket |
| x | x |
| x | x | ||
kernelmessages |
|
|
| x2 |
|
| ||
lanadapter |
|
| x |
| x |
| ||
language | x | x | x |
| x | x | ||
largecommbuffers | x | x | x | x | x | x | ||
mailprog |
|
|
| x |
|
| ||
matchallchar | x |
|
|
|
|
| ||
matchonechar | x |
|
|
|
|
| ||
maxcmdretries | x | x | x | x | x | x | ||
maxrecalldaemons |
|
|
| x5 |
|
| ||
maxreconcileproc |
|
|
| x5 |
|
| ||
maxthresholdproc |
|
|
| x5 |
|
| ||
memoryefficientbackup | x | x | x | x | x | x | ||
migfileexpiration |
|
|
| x5 |
|
| ||
migrateserver |
|
|
| x5 |
|
| ||
minrecalldaemons |
|
|
| x5 |
|
| ||
namedpipename |
|
| x |
| x |
| ||
netbiosbuffersize |
|
| x |
| x |
| ||
netbiosname |
|
| x |
| x |
| ||
netbiosservername |
|
| x |
| x |
| ||
netbiostimeout |
|
| x |
| x |
| ||
nfstimeout |
|
|
| x |
|
| ||
nodename | x | x | x | x | x | x | ||
numberformat | x | x | x | x | x | x | ||
nwignorecompressbit |
| x |
|
|
|
| ||
nwpwfile |
| x |
|
|
|
| ||
nwuser |
| x |
|
|
|
| ||
nwwaitonerror |
| x |
|
|
|
| ||
optfile |
| x | x | x | x | x | ||
optionformat |
|
|
| x5 |
|
| ||
os2lanservacsupport |
|
| x |
|
|
| ||
partnerluname |
| x | x | x2 | x | x | ||
password | x | x | x | x | x | x | ||
passwordaccess | x | x | x | x | x | x | ||
passworddir | x | x | x | x |
|
| ||
postnschedulecmd | x |
| x | x | x | x | ||
postschedulecmd | x | x | x | x | x | x | ||
prenschedulecmd | x |
| x | x | x | x | ||
preschedulecmd | x | x | x | x | x | x | ||
processorutilization |
| x |
|
|
|
| ||
queryschedperiod | x | x | x | x | x | x | ||
quiet | x | x | x | x | x | x | ||
reconcileinterval |
|
|
| x5 |
|
| ||
replace |
| x | x | x | x | x | ||
resourceutilization | x | x | x | x | x | x | ||
restoremigstate |
|
|
| x5 |
|
| ||
retryperiod | x | x | x | x | x | x | ||
revokeremoteaccess |
| x | x | x | x | x | ||
runasservice |
|
|
|
| x |
| ||
schedlogname | x | x | x | x | x | x | ||
schedlogretention | x | x | x | x | x | x | ||
schedmode |
| x | x | x | x | x | ||
scrolllines |
| x | x | x | x | x | ||
scrollprompt |
| x | x | x | x | x | ||
servername |
|
|
| x |
|
| ||
shmport |
|
| x | x1 |
|
| ||
shmqueuename |
|
| x |
|
|
| ||
skipntpermissions |
|
|
|
| x |
| ||
skipntsecuritycrc |
|
|
|
| x |
| ||
subdir |
| x | x | x | x | x | ||
symbolicdestination |
| x | x | x | x | x | ||
tapeprompt | x | x | x | x | x | x | ||
tcpbuffsize | x | x | x | x | x | x | ||
tcpclientaddress |
| x | x | x | x | x | ||
tcpclientport |
| x | x | x | x | x | ||
tcpnodelay |
|
|
| x2 | x | x | ||
tcpport | x | x | x | x | x | x | ||
tcpserveraddress | x | x | x | x | x | x | ||
tcpwindowsize | x | x | x | x | x | x | ||
timeformat | x | x | x | x | x | x | ||
tpname |
| x | x | x2 | x | x | ||
txnbytelimit |
| x | x | x | x | x | ||
users |
|
|
| x |
|
| ||
useunicodefilenames |
|
|
|
| x |
| ||
verbose | x | x | x | x | x | x | ||
virtualmountpoint |
|
|
| x |
|
| ||
virtualnodename |
|
|
| x |
|
| ||
|
|
|
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
Examples
The following examples show what you would enter to instruct Tivoli Storage Manager to update the registry after restoring files.
The archsymlinkasfile option specifies whether you want TSM to follow a symbolic link and archive the file or directory it points to, or archive the symbolic link only. Use this option with the archive command.
The followsymbolic option is used only for restoring to a symbolic link that is a virtual mount point and is unrelated to, and has no dependencies with the archsymlinkasfile option.
Note: | This option can also be defined on the server. |
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-Yes--. >>-ARCHSYMLinkasfile-+------+---------------------------------->< '-No---'
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The automount option is used with the domain option to specify all automounted filesystems in the domain that will be mounted when the TSM client starts, and included for backup services. This option replaces the ls /mount_point/ workaround.
The file system does not need to be explicitly specified in the domain statement if the keywords all-auto-nfs or all-auto-lofs are used.
Supported Clients
This option is valid for all UNIX platforms except LINUX.
Options File for UNIX Platforms
Place this option in the client options file. (dsm.opt).
Syntax
.- ----------------. V | >>-AUTOMount---- filespacename--+------------------------------><
Parameters
Examples
automount fs1, fs2
The backupregistry option specifies whether the registry is backed up during incremental backups.
Supported Clients
This option is for Windows clients only.
Syntax
.-Yes--. >>-BACKUPRegistry-+------+------------------------------------->< '-No---'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
For NetWare: 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. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-----------------. V | >>-CHAngingretries----numberretries--+-------------------------><
Parameters
Examples
Does not apply. (for UNIX)
TSM authorized user (Access authority is required on UNIX.)
The checkthresholds option specifies how often the space monitor daemon checks space usage on your file systems. The space monitor daemon checks each file system to which you added space management.
Supported Clients
This option is for AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.
Syntax
>>-CHEckthresholds- interval-----------------------------------><
Parameters
Examples
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 Appendix F, "Configuring the Backup-Archive Client in a Microsoft Cluster Server Environment"the Appendix in Installing the Clients.
Supported Clients
This option is for Windows NT and Windows 2000 clients only.
Syntax
.-No--. >>-CLUSTERnode-+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
The commmethod option specifies the communication method you use to provide connectivity for client-server communication.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-COMMMethod-+- TCPip------+---------------------------------->< +- IPXspx-----+ +- NAMedpipes-+ +- NETBios----+ +- SHAREdmem--+ '- SNALu6.2---'
Parameters
When specifying the Shared Memory communications method on AIX, the backup-archive client user must be logged in as root or have the same uid as the process running the server. This restriction does not apply if the passwordaccess option is set to generate in the client systems option file (dsm.sys).
When specifying the Shared Memory communications method on AIX, the API client user must be logged in as root or have the same uid as the process running the server. This restriction does not apply if you alter your API program file permissions using the following commands:
chown root.system your_api_program chmod u+s your_api_program
When specifying the Shared Memory communications method on AIX, the administrative client user must be logged in as root or have the same uid as the process running the server. This restriction does not apply if you alter the administrative client programs file permissions using the following commands:
cd /usr/tivoli/tsm/bin chown root.system dsmadm chmod u+s dsmadm chown root.system dsmadmc chmod u+s dsmadmc
Examples
Does not apply. (for UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-COMMRESTARTDuration- minutes--------------------------------><
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
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. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
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.
TSM authorized user (Access authority is required on UNIX.)
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. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza.
Syntax
.-No--. >>-COMPRESSIon-+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
Does not apply. (for UNIX)
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
These clients can use this option: NetWare, OS/2, AIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-CPICBuffersize- size----------------------------------------><
Parameters
Examples
Does not apply.(for UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
These clients can use this option: NetWare, OS/2, AIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-CPICModename- name------------------------------------------><
Parameters
Examples
Does not apply. (for UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
The dateformat option selects the format you want to use to display dates.
The AIX, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. Solaris and HP-UX clients only support English, Korean, Simplified Chinese, Traditional Chinese, and Japanese locale information. The default directories for system-supplied locales are as follows:
The backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is started. Consult the documentation on your local system for details about setting up your locale definition.
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. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-DATEformat- format_number-----------------------------------><
Parameters
For AIX, Tru64 UNIX, HP-UX, SGI, Solaris, and UnixWare: This is the default if the locale-specified date format consists of anything but digits and separator characters.
For AIX, Tru64 UNIX, HP-UX, SGI, Solaris, and UnixWare: To set a particular date format, edit the source file for your locale and modify the d_fmt line to support your needs. Whatever date format you select applies both to output and to input; however, the input year can be either 2 or 4 digits.
Examples
This option is valid on the initial command line and in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
The defaultserver option specifies the default server to which files are backed up and archived from your local systems.
If you have the HSM client installed on your workstation, and you do not specify a migration server with the migrateserver option, this option can also specify the server to which files are migrated from your local file systems.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas.
Syntax
>>-DEFAULTServer- servername-----------------------------------><
Parameters
Examples
Note: | This option is also supported for AIX DFS and is documented in Tivoli Storage Manager AFS/DFS Backup Clients. |
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
Examples
TSM authorized user (Access authority is required on UNIX.)
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. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-DIRMc- mgmtclassname----------------------------------------><
Parameters
Examples
The domain option specifies the drives, volumes, or file systems 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 fileorPreferences file (for Macintosh), the domain option defines your default client domain. TSM uses your default client domain when your administrator defines a schedule to run an incremental backup for you, but does not specify which volumes to process.
If you do not use the domain option to specify local drives, volumes, or file systems in your client options file, the all-local parameter default is used.
When you use the domain option with the incremental command, it adds the local drives, volumes, or file systems you specify to that which is defined in your client options file. For example, if you enter the following in your client options file:
domain c: d: e: (for Windows or OS/2)
domain /home /usr /datasave (for UNIX)
domain sys: data: bindery: (for NetWare)
and the following on the command line:
dsmc incremental -domain="g: h:" (for Windows or OS/2)
dsmc incremental -domain="/fs1 /fs2" (for UNIX)
load dsmc incremental -domain=usr: (for NetWare)
An incremental backup is performed for your c: d: e: g: and h: local drives. (for Windows or OS/2)
An incremental backup is performed for your /home, /usr, /datasave, /fs1, and /fs2 file systems (for UNIX).
An incremental backup is performed for your sys:, data:, and usr: volumes and the bindery: (for NetWare).
If you use both a file specification and the domain option with the incremental command to specify drives, volumes, or file systems to process, the domain option is ignored and only those drives, volumes, or file systems specified in the file specification are processed. For example, if you enter:
dsmc incremental e: f: -domain="g: h:" (for Windows or OS/2)TSM performs an incremental backup for the e: and f: drives only.
For UNIX: When performing a backup with domain=all-local, files handled by automounter and loopback file systems are not backed up.
When performing a file system backup with domain=all-local, any subdirectories that are mountpoints for an automounted file system (autofs) are excluded from backup when the automounter has mounted these mountpoints. Any files that exist on the server for the automounted subdirectory are expired.
When performing a backup with domain=all-lofs, all explicit loopback file systems (lofs) are backed up and all automounted file systems are excluded. For loopback file systems handled by automounter, use domain=all-auto-lofs.
Only those automounted file systems that are mounted when the TSM client starts, can be backed up using the domain option or the GUI. Unmounted file systems monitored by an auto-mounter cannot be backed up.
You can use the automount option with the domain option to specify one or more filesystems to be mounted when the TSM client starts. See Automount for more information.
An automounted file system that is mounted when starting the TSM client, can be explicitly backed up by specifying the automounted file system with the incremental command. For example:
dsmc incremental Autofs_name
Virtual mountpoints cannot be used with automounted file systems
For HP-UX: If you want to use the enhanced domain option for supporting automounted file systems, set the autofs parameter to 1 in the /etc/rc.config.d/nfsconf file. Changing this parameter requires a reboot.
The following UNIX platforms support automounter, LOFS, or LOFS through
automounter, as indicated:
Platform | automounter | LOFS | LOFS through automounter |
AIX | yes | yes | yes |
SUN | yes | yes | yes |
HP | yes | yes | no |
SGI | yes | no | yes |
Tru64 UNIX | yes | no | no |
UnixWare | yes | yes | no |
NUMA-Q | yes | no | no |
Note: | The Linux and OS/390 UNIX clients are not enabled for automounter support. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.- ----------------------. V .-all-local--------. | >>-DOMain-----+------------------+--+-------------------------->< +-domain-----------+ +-BINdery----------+ +-DIRectory or NDS-+ +-all-lofs---------+ +-all-nfs----------+ +-all-auto-nfs-----+ '-all-auto-lofs----'
Parameters
For UNIX: The /tmp directory is not included.
For NetWare: The NDS is not included in the all-local domain. To include the NDS, add the directory to the domain entry.
For Windows, OS/2, NetWare, or UNIX: When you use domain with the incremental command, it processes these drives, volumes, or file systems in addition to those specified in your default client domain.
For Macintosh:A volume name must be enclosed in quotes if it includes any spaces.
For NetWare: The NDS is not included in the all-local domain. To include the NDS, add the directory to the domain entry.
Examples
domain sys:tsm\nds (for NetWare)
domain /tst /datasave /joe (for UNIX)
-domain="serrvera\sys: serverb/sys:" (for NetWare)
-domain="/fs1 /fs2" (for UNIX)
The domain.image option specifies the mounted file systems and raw logical volumes that you want to include for an image backup in your client domain. Raw logical volumes must be named explicitly. When you use this option in your client options file, it defines your default client image domain. This command is valid for AIX, HP-UX and Solaris, only.
If you do not use the domain.image option to specify file systems in your client options file, and you do not specify a file system with the backup image command, a message is issued and no backup occurs.
When you use the domain.image option in your client options file to specify file systems and do not specify a file system with the backup image command, the file systems listed in the domain.image option are backed up.
When you specify a file system with the backup image command, the domain.image option is ignored.
Note: | This option can also be defined on the server. |
Supported Clients
This option is for AIX, HP-UX, and Solaris only.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.- ------------. V | >>-DOMAIN.Image-----+--------+--+------------------------------>< '-domain-'
Parameters
Examples
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.
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX (excluding the OS/390 UNIX System Services), Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) or the client options file (dsm.opt).
Syntax
.-Yes--. >>-EDitor-+------+--------------------------------------------->< '-No---'
Parameters
Note: | The editor is not suppported on OS/390 UNIX System Services, so the editor option should be set to No. |
Examples
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-ERRORLOGName- filespec--------------------------------------><
Parameters
For Windows, OS/2, or UNIX: 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.
For NetWare: The default file name is dsmerror.log; it is placed in installation directory.
For Macintosh:The default file name is TSM Error Log; it is placed in your TSM application folder.
Examples
errorlogname dmmock\sys:tmp\tsmerr.log (NetWare)
errorlogname /tmp/tsmerr.log (UNIX)
-errorlog=dmmock\sys:tmp\tsmerr.log (NetWare)
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-N----. .-D--. >>-ERRORLOGRetention--+------+---+----+------------------------>< '-days-' '-S--'
Parameters
For Windows, OS/2, NetWare, or UNIX: The pruned entries are copied from the error log to the dsmerlog.pru file located in the same directory as the error log.
For Macintosh: The pruned entries are copied from the error log to TSM Error Pruned Log.
Examples
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
The errorprog option specifies a program to which you want to send a message if a severe error occurs during space management processing.
Supported Clients
This option is for AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) inside a server stanza. The HSM client must be installed on your workstation.
Syntax
>>-ERRORProg- program-name-------------------------------------><
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The exclude options exclude objects from backup, image, or archive services. For example, you might want to exclude all temporary files, any local caches of network files, all files that contain compiled object code that you can easily reproduce using other methods, or your operating system files.
Exclude any system files or images that could corrupt the operating system when recovered. The client directory 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.
For Windows: For remotely-accessed files, specify Universal Naming Convention (UNC) based names in your exclude statement. See Chapter 8, "Creating an Include-Exclude List" for more information.
For NetWare: 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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the include-exclude options file or the client system options file (dsm.sys).
Syntax
.- -----------------. V | >>----options pattern--+---------------------------------------><
For UNIX: If you have the Backup-Archive client and the HSM client installed on your workstation, use this option to exclude a file or group of files from both backup and space management services. Any files you exclude with this option are not considered for backup or migration.
If a matching directory is found, that directory, its files, and all its subdirectories and their files are excluded from backup services. When you exclude a directory, you can still back up specific files within that directory, using selective backup.
The exclude.dir option works only if the excluded directory is a subdirectory.
Parameters
If the pattern begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks.
You cannot use the match-all character (or any wildcard character) when specifying the high-level qualifier of an object, only use it for the low-level qualifier.
For UNIX: For the exclude.image option, the pattern is the name of a mounted file system or raw logical volume. Because this option excludes the entire named object and the files it contains from processing, you must use wildcards. For example, to exclude the /etc file system from image backup, enter the following:
exclude.image /etc/*/*
Please note, that the command example does not conform with normal include-exclude wildcard processing for UNIX.
Note: | If you do not specify a server name, TSM uses the local server name. |
Examples
exclude ?:\...\swapper.dat exclude "*:\ea data. sf" exclude ?:\io.sys exclude ?:\...\spart.par exclude c:\*\budget.fin exclude c:\devel\* exclude.dir c:\home\jodda exclude.archive c:\home\*.obj (for Windows only)
(for NetWare)
exclude servera\*:.../swapper.dat exclude n1\*:io.sys exclude tfr\*:.../spart.par exclude nw2\sys:*/budget.fin exclude nw6\sys:devel/* exclude.archive severa*:/.../events.log(for UNIX)
exclude /unix/ exclude /.../core exclude /home/jones/proj1/* include /home/jones/proj1/devplan/ exclude.archive /.../core exclude.backup /home/jones/proj1/devplan/ include /home/jones/proj1/status/ exclude.spacemgmt /home/jones/proj1/status/ exclude.dir /home/jones/tmp exclude.backup /users/home1/file1 exclude.spacemgmt /users/home1/file1 exclude.image /usr/*/*
exclude "...:Desktop DB" exclude ":Norton FileSaver Data" exclude.archive "...:Desktop DF"
The followsymbolic option specifies whether you want to restore files to symbolic links, or use a symbolic link as a virtual mount point. Use this option with the restore and retrieve commands.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-No--. >>-FOLlowsymbolic-+-----+-------------------------------------->< '-Yes-'
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The groups option specifies groups on your workstation that you want to authorize to request TSM services from the server. You can use the groups option more than once to specify several group names.
If you do not specify group names with the groups option, or user IDs with the users option, all users can request TSM services. If you use both the groups option and the users option, only users specified with these options can request TSM services. A root user is always authorized to request services.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.- -------------------------. | .- ------------. | V V | | >>----GRoups---- groupname--+--+-------------------------------><
Parameters
Examples
groups dsmcdev group1 test1 test2 design1 groups endicott almaden qadev qadev1 tools23
Does not apply.
The guitreeviewafterbackup option specifies whether the client returns to the Backup, Restore, Archive, or Retrieve window after a successful operation completes.
Supported Clients
These clients can use this option: Macintosh, OS/2, all UNIX clients, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt) or the client system options file (dsm.sys).
Syntax
.-No--. >>-GUITREEViewafterbackup-+-----+------------------------------>< '-Yes-'
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The httpport option specifies a TCP/IP port address for the Web client.
Supported Clients
These clients can use this option: NetWare, OS/2, Windows NT, Windows 2000, Windows 95, Windows 98, and all UNIX clients.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-HTTPport- port_address--------------------------------------><
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The httpsport option specifies a TCP/IP port address for the HTTPS secure socket layer (SSL) interface to the Web client.
Supported Clients
These clients can use this option: AIX, OS/2, Windows NT, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-HTTPSport- port_address-------------------------------------><
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The inclexcl option specifies the path and file name of your include-exclude options file, if you use one. Use an include-exclude options file to exclude files from backup and to assign different management classes to specific files or groups of files.
If you have the HSM client installed on your workstation, you can use an include-exclude options file to exclude files from backup and space management, from backup only, from space management only, and to assign management classes to specific files or groups of files.
For information about creating an include-exclude options file, see Chapter 8, Creating an Include-Exclude List.
Ensure that your include-exclude options file is stored in a directory, such as /etc, to which all users have read access.
Note: | This option can also be defined on the server. |
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-INCLExcl- filespec------------------------------------------><
Parameters
Examples
inclexcl /usr/dsm/backup.excl inclexcl /etc/inclexcl.def
Does not apply.
TSM authorized user (Access authority is required on UNIX.)
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 Windows: 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 8, "Creating an Include-Exclude List" for more information.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the include-exclude options file or the client system options file (dsm.sys).
Syntax
.- ------------------------------------. V | >>----options pattern-+----------------+--+-------------------->< '- mgmtclassname-'
Parameters
If the pattern begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks.
Examples
include c:\proj\text\devel.* include c:\proj\text\* textfiles include ?:* managall (for Windows only)(for NetWare)
include servera\sys:proj/text/devel.* include servera\sys:proj/text/* textfiles include *:* managall(for UNIX)
include /home/proj/text/devel.* include /home/proj/text/* textfiles include * managall include.image /home/*/*
include "...:Data:Test:Test*" include "...:System:...:*" mgmtcls1 include "...:*" managall
Does not apply.
The ipxbuffersize option specifies the IPX buffer size needed to transfer data between the client node and the server. A larger buffer can improve communication performance, but uses more memory.
Supported Clients
These clients can use this option: NetWare, OS/2, Windows NT, Windows 2000, Windows 95, and Windows 98.
Syntax
>>-IPXBuffersize- size-----------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The ipxserveraddress option specifies the IPX/SPX address of a server on an OS/2 or AIX host that is not in the same network as the client node. If the IPX/SPX address is not specified, the server must be in the same network as the client node.
Supported Clients
These clients can use this option: NetWare, OS/2, Windows NT, Windows 2000, Windows 95, and Windows 98.
Syntax
>>-IPXSErveraddress- server_address----------------------------><
Parameters
If an IPX/SPX address is not specified, the default address for the server is the same address as the client workstation.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The ipxsocket option specifies the socket number for a server on a NetWare, OS/2, Windows host. host.
Supported Clients
These clients can use this option: NetWare, OS/2, Windows NT, Windows.
Syntax
>>-IPXSOcket- socketnumber-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
The kernelmessages option specifies whether to display HSM-related messages during processing.
Note: | For transparent recall, if more than one process accesses the same migrated file at one time, the kernel displays a message for the first process that accesses the file only. |
Supported Clients
This option is for AIX clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.
Syntax
.-Yes--. >>-KERNelmessages-+------+------------------------------------->< '-No---'
Parameters
Examples
The lanadapter option specifies a communication adapter number when you use the NETBIOS communication method.
Supported Clients
This option is valid for OS/2, Windows NT, and Windows 2000 only.
Syntax
>>-LANAdapter- adapter_number----------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The language option specifies the national language in which to present client messages.
You can use American English (AMENG) with all clients. For Macintosh and NetWare: Currently, you can use American English (AMENG) only.
Supported Clients
These clients can use this option: Macintosh, OS/2, all Windows clients.
Syntax
>>-LANGuage- language------------------------------------------><
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-No--. >>-LARGECOMmbuffers-+-----+------------------------------------>< '-Yes-'
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The mailprog option specifies the program and user ID to which you want to send a newly-generated password when the old one expires. Use this option only when you select generate with the passwordaccess option.
Supported Clients
This option is for the UNIX client only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-MAILprog filespec userid------------------------------------><
Parameters
Examples
mailprog /usr/bin/xsend root (for AIX) mailprog /bin/mailx USER1 (for OS/390 UNIX System Services)
Note: | Run the enroll command before you use xsend. |
Does not apply.
The matchallchar option specifies the character to use as a match-all wildcard character. For example, File* matches File1, FileA1, and File. Place this option in the Preferences file before any include or exclude statements.
Supported Clients
This option is for the Macintosh client only.
Syntax
>>-MATCHAllchar character--------------------------------------><
Parameters
Examples
The matchonechar option specifies the character to use as a match-one wildcard character. For example, File? matches File1, but it does not match File or File10. Place this option in the Preferences file before any include or exclude statements.
Supported Clients
This option is for the Macintosh client only.
Syntax
>>-MATCHOnechar character--------------------------------------><
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
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 or Preferences file after your client node successfully contacts the server.
Note: | This option can also be defined on the server. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-MAXCMDRetries- maxcmdretries--------------------------------><
Parameters
Examples
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
The maxrecalldaemons option specifies the maximum number of HSM recall daemons you want to run at one time to perform recalls for your client node. During normal operations, if the number of recall daemons running at one time is similar to the maximum number permitted, increase the value for the maxrecalldaemons option. For example, if you use an application that opens multiple files at one time, and these files are migrated, the application can use all available recall daemons. If you cannot start a recall daemon for another process attempting to access a migrated file, that process stops until a recall daemon is available.
Supported Clients
This option is for the valid for the AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.
Syntax
>>-MAXRECAlldaemons number-------------------------------------><
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The maxreconcileproc option specifies the maximum number of reconciliation processes that the HSM program can start at one time.
Supported Clients
This option is valid for the AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.
Syntax
>>-MAXRECOncileproc maxreconcileproc---------------------------><
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The maxthresholdproc option specifies the maximum number of threshold migration processes that the HSM program can start at one time. When a file system runs out of space, the HSM program does not verify that the maximum number of threshold migration processes currently running. It starts threshold migration as part of the demand migration process regardless of the number of threshold migration processes in progress.
Supported Clients
This option is valid for the AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.
Syntax
>>-MAXThresholdproc maxthresholdproc---------------------------><
Parameters
Examples
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. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-No--. .-Yes--. >>-MEMORYEFficientbackup-+-----+--"OR"----+------+------------->< '-Yes-' '-No---'
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The migfileexpiration option specifies the number of days copies of migrated or premigrated files are kept on the server after they are modified on your local file system, or deleted from your local file system.
Supported Clients
This option is for valid for the AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.
Syntax
>>-MIGFileexpiration days--------------------------------------><
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The migrateserver option specifies the name of the server to which you want to migrate files from your client node. Specify only one migration server for each client node. Users cannot override the server you specify for migration in a client user options file or when entering a command.
If you do not specify a server with the migrateserver option, your files are migrated to the server specified with the defaultserver option. If you do not specify a server with either of these options, your files are migrated to the server identified in the first stanza of your client system options file.
After your files migrate to the server you specified, do not specify a different migration server, unless your administrator tranfers your migrated files from the specified server to another. Otherwise, the server cannot locate your migrated files until you specify the server to which your files were originally migrated.
Supported Clients
This option is valid for the AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.
Syntax
>>-MIGRateserver servername------------------------------------><
Parameters
Examples
MIGRATEServer server_b SErvername server_a COMMmethod TCPip TCPPort 1500 TCPServeraddress almvmd.almaden.ibm.com Inclexcl /adm/tsm/excl.list SErvername server_b COMMmethod SNAlu6.2 PARtnerluname raptor TPname appcdel CPICMOdename appc Passwordaccess generate Inclexcl /adm/tsm/migexl.list
Does not apply.
TSM authorized user (Access authority is required on UNIX.)
The minrecalldaemons option specifies the minimum number of recall daemons you want to run simultaneously to perform recalls for your client node.
Supported Clients
This option is valid for the AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.
Syntax
>>-MINRecalldaemons number-------------------------------------><
Parameters
Examples
The namedpipename option specifies the name of a named pipe to use for communications between a client and a server on the same workstation.
Supported Clients
This option is for the OS/2, Windows NT, and Windows 2000 clients only.
Syntax
>>-NAMedpipename- name-----------------------------------------><
Parameters
Examples
The netbiosbuffersize option specifies the size, in kilobytes, that you want to use for the NETBIOS communication buffer.
Supported Clients
This option is valid for OS/2, Windows NT, and Windows 2000 clients only.
Syntax
>>-NETBIOSBuffersize- size-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The netbiosname option specifies a NETBIOS name for your workstation.
Supported Clients
This option is vaild for OS/2, Windows NT, and Windows 2000 clients only.
Syntax
>>-NETBIOSName- name-------------------------------------------><
Parameters
The default is TSM concatenated to a time-of-day value.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The netbiosservername option specifies a NETBIOS name for a server.
Supported Clients
This option is vaild for OS/2, Windows NT, and Windows 2000 clients only.
Syntax
>>-NETBIOSServername- name-------------------------------------><
Parameters
The default is adsmserv1.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The netbiostimeout option specifies the number of seconds that elapse before a timeout occurs for a NETBIOS send or receive. If your LAN environment has slow response times or you are backing up directly to tape, we recommend that you use a value of zero.
Supported Clients
This option is vaild for OS/2, Windows NT, and Windows 2000 clients only.
Syntax
>>-NETBIOSTimeout- seconds-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The nfstimeout option specifies the number of seconds the server waits for a status system call on an NFS filesystem before it times out.
You can use this option to mitigate the default behavior of status calls on NFS filesystems. For example, if an NFS filesystem is stale, a status system call will be timed out by NFS (softmounted) or hang the process (hardmounted).
When the value of this option is changed to a value other than zero, a new (child) process is created to issue the status system call. The new process is timed out by the main (parent) process and the TSM operation can continue.
Note: | This option can also be defined on the server. |
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza or the client options file (dsm.opt).
Syntax
>>-NFSTIMEout number-------------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
For Macintosh: If you do not specify this option in the Preferences file, TSM prompts you for the node name when it starts.
Note: | The machine name is not necessarily the TCP/IP host name. |
For UNIX: When connecting to a server, the client must identity itself to the server. This login identification is determined in the following manner:
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza.
Syntax
>>-NODename- nodename------------------------------------------><
Parameters
Examples
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
The numberformat option specifies the format you want to use to display numbers.
The AIX, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. Solaris and HP-UX clients only support English, Simplified Chinese, and Japanese locale information. The default directories for system-supplied locales are as follows:
The backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. Consult the documentation on your local system for details about setting up your locale definition.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-NUMberformat- number----------------------------------------><
Parameters
For AIX, Tru64 UNIX, HP-UX, SGI, Solaris, and UnixWare: To define number formats, modify the following lines in the source file of your locale. Whatever format you select applies both to output and to input.
Examples
This option is valid on the initial command line and in interactive mode.
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.
Supported Clients
This option is for the NetWare client only.
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.
Supported Clients
This option is for the NetWare client only.
Syntax
.-Yes--. >>-NWPWFile----+------+---------------------------------------->< '-No---'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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. |
Supported Clients
This option is for the NetWare client only.
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.
This option is valid only on the initial command line. It is not valid in interactive mode.
The nwwaitonerror option specifies that the client program responds in one of the following ways, if an error occurs while exiting:
Note: | You can use the nwwaitonerror option when running DSMC in an automated mode, such as, from an .NCF file. By default, you are asked to press any key to continue before you exit the DSMC program. If you specify yes, DSMC will not prompt. |
Supported Clients
This option is for the NetWare client only.
Syntax
.-Yes--. >>-NWWaitonerror----+------+----------------------------------->< '-No---'
Parameters
Examples
The optfile option specifies the client options file you want to use when you start a TSM session.
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Syntax
>>-OPTFILE- file_name------------------------------------------><
Parameters
Examples
dsmc query session -optfile= myopts.opt (Windows, OS2, or UNIX)
load dsmc query session -optfile= sys:tsm/spike.opt (NetWare)
This option is valid only on the initial command line. It is not valid in interactive mode.
The optionformat option specifies the format to use when you specify HSM client commands.
Supported Clients
This option is for AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt). The HSM client must be installed on your workstation.
Syntax
.- STandard-. >>-OPTIONFormat-+- SHort----+----------------------------------><
Parameters
dsmmigrate -Recursive -Detail /home/user1/file1 dsmmigrate -r -d /home/user1/file1
dsmmigrate -Rv /home/user1/file1 dsmmigrate -v -R /home/user1/file1
Refer to Using the UNIX HSM Clients, SH26-4083, for details regarding these two command formats.
Examples
The os2lanservacpsupport option specifies the OS/2 Lan Server local and network attached drives from which ACL data associated with files and directories is backed up. To back up or restore ACL data on network attached drives you must be logged on as an administrator.
If ACL data is not backed up for a file or directory, TSM will not restore this ACL data. This can result in unwanted residual ACL data, if ACL data was added to a file after the last backup.
If the HPFS386_local or All_local parameters are specified for a restore operation, TSM processes data using the All parameter. If ACL data is backed up for a file or directory, during a restore operation any existing ACL data for that file or directory is overwritten.
Faster processing of ACL data can be expected using, for example, the HPFS386_local option as opposed to the All option.
System Environment
This option is for the OS/2 client only.
Format
.-HPFS386_local--. >>-OS2LANSERVACPsupport-+----------------+--------------------->< +-None-----------+ +-All_local------+ '-All------------'
Parameters
Note: | If a file or directory is deleted, its associated ACL data is also deleted. This is because the ACL data is stored with the file or directory. |
Note: | You may prefer this option if you have an OS/2 Lan Server-entry using only HPFS or FAT systems. OS/2 Lan Server file NET.ACC, which contains ACL data for all files and directories, can be backed up separately to preserve ACL data. |
Note: | For FAT, HPFS, HPFS386, and JFS drives, if you delete a file or directory you must also delete its associated ACL data using the OS/2 Lan Server Net Access command. This prevents residual ACL data after deletion. ACL data is not stored with the file or directory. |
Examples
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
These clients can use this option: NetWare, OS/2, AIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-PARtnerluname- logical_unit_name----------------------------><
Parameters
partnerluname nameone.nametwo
Contact your system administrator for this name. There is no default.
Examples
-par=sanjose.vm (for Windows, OS/2, or NetWare)
Does not apply. (for UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
The password option specifies a TSM password. If this option is not used and your administrator has set authentication to On, you are prompted for a password when you start a TSM session.
Note: | If you are prompted for a password, it is not displayed as you enter it. However, if you use the password option, your password is displayed when you enter it. |
The password option is ignored when the passwordaccess option is set to generate.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-PASsword- password------------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
For UNIX: When using the HSM client, set the passwordaccess option to generate.
For NetWare, OS/2, Windows NT, Windows 95, and Windows 98, and all UNIX clients: When using the Web client, set the passwordaccess option to generate.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza.
Syntax
.-prompt---. >>-PASSWORDAccess-+----------+--------------------------------->< '-generate-'
Parameters
For UNIX: Each user must know the TSM password for your client node. Any user who knows the password for your client node can gain access to all backups and archives that originate from your client node. For example:
API applications must supply the password when a session is initiated. The application is responsible for obtaining 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.
For Windows: The generated password is stored in the registry.
For UNIX: You can use the mailprog option to specify a program and user ID that you want TSM to send the new password to each time the old password expires.
For UNIX: Users do not need to know the TSM password for your client node. Any user who knows the password for your client node can access only the backups and archives the user owns and those to which the user is granted access by other users. If a user enters the TSM password for your client node, the user becomes a virtual root user and can access all backups and archives that originated from your client node. If you change the name of your client node (using the nodename option in the dsm.sys file), and the same node name is specified in the dsm.opt file, TSM prompts the users for the TSM password for your client node. If a user enters the correct password, the user becomes a virtual root user. The same is true if a user specifies the same node name using the nodename option with a command.
Examples
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
These clients can use this option: Macintosh, NetWare, OS/2, and UNIX.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-PASSWORDDIR- directoryname----------------------------------><
Parameters
For OS/2: The default directory is the directory specified with the DSM_DIR environment variable. If no directory is specified with the DSM_DIR environment variable, the default directory is the C:\ directory.
For UNIX: If root user, the default directory is /etc/security/adsm for AIX and /etc/adsm for other UNIX platforms. If non-root user, the default directory is the directory specified with the DSM_DIR variable. If no directory is specified with the DSM_DIR environment variable, the directory from which the executable was loaded is used.
Examples
passworddir c:\security\tsm (for OS/2)
passworddir /etc/security/tsm (for UNIX)
passworddir dmmock\sys:security\tsm (for NetWare)
TSM authorized user (Access authority is required on UNIX.)
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. |
Supported Clients
All clients can use postschedulecmd. Postnschedulecmd is not valid for NetWare.
Options File for UNIX Platforms
Place these options in the client system options file (dsm.sys).
Syntax
>>-+-POSTSchedulecmd--+--- "cmdstring"------------------------->< '-POSTNschedulecmd-'
Parameters
Use a blank, or null string for cmdstring if you want to prevent any commands from running that the administrator uses for postschedulecmd or preschedulecmd. If you specify a blank, or null string on either option, it prevents the administrator from using a command on both options.
If your administrator uses a blank, or null string on the postschedulecmd option, you cannot run a post-schedule command.
If the command string contains blanks, enclose it in double quotes. If you have double quotes within the command string, use single quotes to enclose them.
For Macintosh:The command string should specify an AppleScript to launch. If it is only a file name, such as "Database Script", the client program searches for this file in the Scripts folder inside the TSM folder. Otherwise, the command string should contain the full path of the file, such as:
"La Pomme:Scripting:Database Script"
Examples
The command string is a valid command for restarting your database.
The command string is a valid command for restarting your database.
TSM authorized user (Access authority is required on UNIX.)
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. |
Supported Clients
All clients can use preschedulecmd. Prenschedulecmd is not valid for NetWare.
Options File for UNIX Platforms
Place these options in the client system options file (dsm.sys).
Syntax
>>-+-PRESchedulecmd--+--- "cmdstring"-------------------------->< '-PRENSchedulecmd-'
Parameters
Use a blank, or null string for cmdstring if you want to prevent any commands from running that the administrator uses for postschedulecmd and preschedulecmd. If you specify a blank, or null string on either option, it prevents the administrator from using a command on both options.
If your administrator uses a blank, or null string on the preschedulecmd option, you cannot run a pre-schedule command.
If the command string contains blanks, enclose it in double quotes. If you placed double quotes within the command string, use single quotes to enclose them.
For Macintosh:The command string should specify an AppleScript to launch. If it is only a file name, such as "Database Script", the client program searches for this file in the Scripts folder inside the TSM folder. Otherwise, the command string should contain the full path of the file, such as:
"La Pomme:Scripting:Database Script"
Examples
The command string is a valid command for quiescing your database.
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.
Supported Clients
This option is for the NetWare client only.
Syntax
>>-PROCESSORutilization- number--------------------------------><
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
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 or Preferences file after your client node successfully contacts the server.
Note: | This option can also be defined on the server. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-QUERYSCHedperiod- hours-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The quiet option prevents messages from displaying on your screen during processing.
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. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-QUIET-------------------------------------------------------><
Examples
This option is valid on the initial command line and in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
The reconcileinterval option specifies how often HSM reconciles your file systems. TSM reconciles each file system for which space management is active and builds a new Migration Candidates list.
Supported Clients
This option is valid for the AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas. The HSM client must be installed on your workstation.
Syntax
>>-RECOncileinterval interval----------------------------------><
Parameters
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.
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX, all Windows clients.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-Prompt--. >>-REPlace-+---------+----------------------------------------->< +-All-----+ +-Yes-----+ '-No------'
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
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., or a user who is not TSM authorized, invokes a UNIX client with passwordaccess=generate 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.
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. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-RESOURceutilization- number---------------------------------><
Parameters
Examples
The restoremigstate option specifies whether you want to restore or retrieve stub files or backup-archive versions of migrated and premigrated files during a restore-retrieve operation. Use this option with the restore and retrieve commands.
You can restore or retrieve a stub file for a migrated or premigrated file only when:
When a stub file for a migrated file or the original copy of a premigrated file is erased from a local file system, the migrated file is marked for expiration the next time reconciliation is run. When the number of days specified with the migfileexpiration option elapse, the migrated file is removed from storage.
If you specify restoremigstate=Yes (the default), and if the migrated or premigrated file has not expired, the file is restored or retrieved to a stub file, regardless of whether it is marked for expiration.
The restoremigstate option restores a file if it is backed up after migration. If the file is backed up before migration, you cannot restore a stub because a server stub copy does not exist.
Files with ACLs are restored in premigrated state regardless of the setting for restoremigstate.
Attention: | The restoremigstate option does not support hardlinked files. If you want to restore or retrieve a stub file for a hardlinked file, all of the files that are hardlinked together must be deleted from the local file system. When one file in a set of hardlinked files is migrated, all of the hardlinked files in the set become stub files. When you enter the restore command with the restoremigstate option, and restores a stub file for a hardlinked file, the stub file has the same name as the file that was originally migrated. Stub files are not restored for any other files that were previously in the hardlinked set of files. |
Supported Clients
This option is valid for the AIX and Solaris clients only.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt). The HSM client must be installed on your workstation.
Syntax
.-Yes--. >>-RESToremigstate----+------+--------------------------------->< '-No---'
Parameters
Note: | A stub file created during a restore or retrieve operation contains the information necessary to recall the migrated file from storage. It does not contain any leading bytes of data from the file. Any recall mode previously set for the migrated file (for example, migrate-on-close or read-without-recall) is not stored in the stub file. The recall mode is set to normal for all files restored or retrieved to stub files. |
Examples
TSM authorized user (Access authority is required on UNIX.)
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 or Preferences file after your client node successfully contacts the server.
Note: | This option can also be defined on the server. |
Supported Clients
All clients can use option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-RETRYPeriod- minutes----------------------------------------><
Parameters
Examples
-retryperiod=15 (Windows, OS/2, or NetWare)
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
The revokeremoteaccess option restricts an administrator with client access privilege from accessing a client workstation that is running the Web client. This option does not restrict administrators with client-owner, system, or policy privilege from accessing your workstation through the Web client.
Supported Clients
These clients can use this option: NetWare, OS/2, Windows NT, Windows 2000, Windows 95, Windows 98, and all UNIX clients.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt) or the client system options file (dsm.sys).
Syntax
.-None---. >>-REVOKEremoteaccess-+--------+------------------------------->< '-Access-'
Parameters
Examples
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. |
Supported Clients
This option is for Windows NT and Windows 2000 clients only.
Syntax
.-No--. >>-RUNASSERVice----+-----+------------------------------------->< '-Yes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The schedcompleteaction option specifies an action to take when a schedule completes. This option is used only when the scheduler is running.
Supported Clients
This option is for the Macintosh client only.
Syntax
>>-SCHEDCOMpleteaction----+- Quit-----+------------------------>< '- SHUTdown-'
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
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.
For Windows, NetWare, OS/2, or UNIX: 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.
Supported Clients
All clients can use option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-SCHEDLOGName- filespec--------------------------------------><
Parameters
For Windows, NetWare, OS/2, or UNIX: 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.
For Macintosh:If you specify a file name only, the file is stored in your default folder. The default is the TSM application folder and a file name of TSM Schedule Log.
Examples
schedlogname c:\mydir\schedlog.jan (Windows or OS/2)
schedlogname dmmock\sys:mydir/schedlog.jan (NetWare)
schedlogname /home/mydir/schedlog.jan (UNIX)
schedlogn "SupDrive:David Sched Log"
-schedlogn=c:\mydir\schedlog.jan (Windows or OS/2)
-schedlogn=dmmock\sys:mydir/schedlog.jan (NetWare)
Does not apply. (for UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
All clients can use option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-N----. .-D--. >>-SCHEDLOGRetention----+------+---+----+---------------------->< '-days-' '-S--'
Parameters
For Windows, OS/2, NetWare, or UNIX: Pruned entries are copied to the dsmsched.pru file that is stored in the same directory as the schedule log.
For Macintosh:TSM copies the entries pruned from the log to TSM Sched Pruned Log.
Examples
-schedlogretention=30,S (for Windows, OS/2, or NetWare)
Does not apply. (for UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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. |
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-POlling--. >>-SCHEDMODe-+----------+-------------------------------------->< '-PRompted-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The scrolllines option specifies the number of lines of information that display on your screen at one time. Use this option when you set the scrollprompt option to Yes, and you use commands.
Note: | This option can also be defined on the server. |
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-SCROLLLines- number-----------------------------------------><
Parameters
Examples
This option is valid on the initial command line and in interactive mode.
The scrollprompt option specifies whether you want TSM to stop and wait after displaying the number of lines of information you specified with the scrolllines option, or scroll through and stop at the end of the information list.
Note: | This option can also be defined on the server. |
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX, Windows NT, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-No--. >>-SCROLLPrompt-+-----+---------------------------------------->< '-Yes-'
Parameters
Press 'Q' to quit, 'C' to continuous scroll, or 'Enter' to continue.
Examples
This option is valid on the initial command line and in interactive mode.
In your client system options file (dsm.sys), the servername option specifies the name you want to use to identify a server, and to begin a stanza containing options for that server. You can name and specify options for more than one server.
The following example demonstrates how to specify options for two different servers:
SErvername server_a COMMmethod TCPip TCPPort 1500 TCPServeraddress almvmd.almaden.ibm.com Passwordaccess prompt Groups tsm Users sullivan mushock tallan Inclexcl /adm/tsm/backup.excl SErvername server_b COMMmethod SNAlu6.2 PARtnerluname raptor TPname appcdel CPICMOdename appc Passwordaccess generate Mailprog /usr/bin/xsend root Groups system tsm Inclexcl /adm/tsm/archive.excl
In your client options file (dsm.opt), the servername option specifies which server, of those named in dsm.sys, to contact for backup-archive services. When specified in a client options file or on the command line, the servername option overrides the default server specified in your client system options file.
Note: | You cannot use the servername option to override the server that is specified for migration in your client system options file. |
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in both the client options file (dsm.opt) and the client system options file (dsm.sys).
Syntax
>>-SErvername servername---------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
The shmport option specifies the TCP/IP port address that the server is listening on to establish a shared memory connection. See "Communication Options" for a list of clients on which the shared memory communication is supported. To use shared memory, TCP/IP must be installed on your workstation.
Note: | The value specified for the shmport option in the client system optionsclient options file must match the value specified for shmport in the server options file. |
Supported Clients
This option is for AIX, HP-UX, OS/2, and Solaris clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-SHMPort port_address----------------------------------------><
Parameters
Examples
The shmqueuename option specifies the name of the server shared memory queue.
Supported Clients
This option is for the OS/2 client only.
Syntax
>>-SHMQueuename- name------------------------------------------><
Parameters
Examples
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:
Supported Clients
This option is for Windows NT and Windows 2000 clients only.
Syntax
.-No--. >>-SKIPNTPermissions-+-----+----------------------------------->< '-Yes-'
Parameters
Examples
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:
Supported Clients
This option is for Windows NT and Windows 2000 clients only.
Syntax
.-No--. >>-SKIPNTSecuritycrc-+-----+----------------------------------->< '-Yes-'
Parameters
Examples
The subdir option specifies whether you want to include subdirectories of named directories for processing on the following commands:
Note: | This option can also be defined on the server. |
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX, all Windows clients.
Options File for UNIX Platforms
Place this option in your client options file (dsm.opt).
Syntax
.-No--. >>-SUbdir-+-----+---------------------------------------------->< '-Yes-'
Parameters
Note: | If you use the preservepath option in addition to subdir=yes, it can affect which subdirectories are are processed. . |
If a subdirectory is a mounted file system, it is not processed even if subdir=yes is specified.
Examples
For Windows or OS/2: 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
For NetWare: 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
For UNIX: To restore the structure:
/path2/dir1 /path2/dir1/file1 /path2/dir1/dir2 /path2/dir1/dir2/file1
enter any of the following commands:
dsmc rest "/path/dir1/*" /path2/ -su=yes dsmc rest "/path/dir1/file*" /path2/ -su=yes dsmc rest "/path/dir1/file1*" /path2/ -su=yes
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-SYMbolicdestination- sym_dest_name--------------------------><
Parameters
Examples
-sym=anrserv (Windows, OS/2, or NetWare)
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
The tapeprompt option specifies whether you want to wait for a tape to mount if it is required for a backup, archive, restore, or retrieve process, or to be prompted for a choice.
Tape prompting does not occur during a scheduled operation regardless of the setting for the tapeprompt option.
Note: | This option can also be defined on the server. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-No--. >>-TAPEPrompt-+-----+------------------------------------------>< '-Yes-'
Parameters
Note: | For API applications, this is recommended to permit backup directly to tape. |
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TCPBuffsize- size-------------------------------------------><
Parameters
Depending on the operating system communication settings, your system might not accept all values in the range of one through 512.
Examples
-tcpbuffsize=31
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
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.
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
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.
TSM authorized user (Access authority is required on UNIX.)
Note: | For UNIX clients: This option is for an AIX client only. All other UNIX clients buffer small transactions before sending them to the server. |
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.
Supported Clients
These clients can use this option: AIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-No--. >>-TCPNodelay--+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
TSM authorized user (Access authority is required on UNIX.)
The tcpport option specifies a TCP/IP port address for a server. You can obtain this address from your administrator. For Macintosh:This option is required in your Preferences file.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TCPPort- port_address---------------------------------------><
Parameters
Examples
-tcpport=1501 (Windows, OS/2, or NetWare)
Does not apply (for UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
The tcpserveraddress option specifies the TCP/IP address for a server. You can obtain this server address from your administrator. For Macintosh:This option is required in your Preferences file.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TCPServeraddress- server_address----------------------------><
Parameters
Examples
-tcpserveraddress=129.33.24.99 (Windows, OS/2, or NetWare)
Does not apply (for UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TCPWindowsize- window_size----------------------------------><
Parameters
For Windows: 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.
For UNIX: The range of values is one through 2048. For Solaris the maximum value is 1024. The default is 32.
For OS/2: The range of values is one through 2048; the default is 31.
For NetWare: The range of values is one through 64; the default is 32.
For Macintosh: The range of values is one through 128; the default is 16.
Note: | Depending on the operating system communication settings, your system might not accept all values in the range of values. |
Examples
-tcpw=24
This option is valid only on the initial command line. It is not valid in interactive mode.
The timeformat option specifies the format in which you want system time displayed.
The AIX, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. Solaris and HP-UX clients only support English, Simplified Chinese, and Japanese locale information. The default directories for system-supplied locales are as follows:
The backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. Consult the documentation on your local system for details about setting up your locale definition.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-TIMEformat- format_number-----------------------------------><
Parameters
For AIX, Tru64 UNIX, HP-UX, SGI, Solaris, and UnixWare: This is the default if the locale-specified format consists of digits, separator characters, and, if applicable, the AM or PM string.
For AIX, Tru64 UNIX, HP-UX, SGI, Solaris, and UnixWare: This is the default if the locale-specified format does not consist of digits, separator characters, and, if applicable, the AM or PM string.
For AIX, Tru64 UNIX, HP-UX, SGI, Solaris, and UnixWare: To set a particular time format, edit the source file for your locale and modify the t_fmt line to support your needs. Whatever time format you select applies both to output and to input.
Examples
This option is valid on the initial command line and in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
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.
Supported Clients
These clients can use this option: NetWare, OS/2, AIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
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.
TSM authorized user (Access authority is required on UNIX.)
The txnbytelimit option specifies the number of kilobytes the client program buffers before it sends a transaction to the server.
Note: | This option can also be defined and adjusted by the server as required during self-tuning operations. |
This option permits you to control the amount of data sent between the client and server before the server commits the data and changes to the server database, thus changing the speed with which the client performs work. The amount of data sent applies when files are batched together during backup or when receiving files from the server during a restore procedure.
The server administrator can limit the number of files or directories contained within a group transaction using the txngroupmax option; the actual size of a transaction can be less than your limit. Once this number is reached, the client sends the files to the server even if the transaction byte limit is not reached.
Supported Clients
These clients can use this option: NetWare, OS/2, UNIX, Windows NT, Windows 2000, Windows 95, and Windows 98.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TXNBytelimit- number----------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
The users option authorizes specific users on your workstation to request services from a server. You can use this option more than once to specify a large number of user IDs. If you do not specify group names with the groups option, or user IDs with the users option, all users can request TSM services. If you use the groups option, the users option, or both, only users included in one of the specified groups, or included in the list of users, can request TSM services.
Define your root user name only with the users option to exclude all other users from accessing the server.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.- -----------------------. | .- -----------. | V V | | >>----USERs---- username--+--+---------------------------------><
Parameters
Examples
users carol larry davecd kathyba michelle users amyb tkaspar kbsmith egray srjames
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:
Supported Clients
This option is for Windows NT and Windows 2000 clients only.
Syntax
.-No--. >>-USEUNICODEFilenames----+-----+------------------------------>< '-Yes-'
Parameters
Examples
useunicodef yes
-useunicodef=yes
The verbose option specifies that you want processing information to display on your screen. This is the default.
This option also affects the amount of information displayed in NT event log and schedule log files.
For Windows, NetWare, OS/2, or UNIX: 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.
For Macintosh: The information appears on your screen in the Scheduler Status window. This option only applies when you are running the Scheduler and TSM is performing scheduled work.
Note: | This option can also be defined on the server and overrides the client setting. |
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-VErbose-----------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
This option is valid on the initial command line and in interactive mode.
TSM authorized user (Access authority is required on UNIX.)
The virtualmountpoint option defines a virtual mount point for a file system if you want to consider files for backup that begin with a specific directory within that file system. Using the virtualmountpoint option to identify a directory within a file system provides a direct path to the files you want to back up, saving processing time. It is more efficient to define a virtual mount point within a file system than it is to define that file system using the domain option, and then to use the exclude option in your include-exclude options file to exclude the files that you do not want to back up.
Use the virtualmountpoint option to define virtual mount points for multiple file systems, for local and remote file systems, and to define more than one virtual mount point within the same file system. Virtual mount points cannot be used in a file system handled by automounter. Use the AFS/DFS backup clients to process virtual mount points for AFS/DFS file systems.
Note: | If the directory that you want to specify as a virtual mount point is a symbolic link, set the followsymbolic option to Yes. If that option is set to No (the default), you are not permitted to use a symbolic link as a virtual mount point. |
After you define a virtual mount point, you can specify the path and directory name with the domain option in either the default client options file, or on the incremental command to include it for incremental backup services. Users can also specify the path and directory name of the virtual mount point with the domain option in their own client options files and on the incremental command.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.- -----------------------------. V | >>----VIRTUALMountpoint directory--+---------------------------><
Parameters
Define only one virtual mount point with each virtualmountpoint option that you include in your client system options file. Use the virtualmountpoint option as many times as necessary to define all of the virtual mount points that you want to use.
Examples
virtualmountpoint /afs/xyzcorp.com/home/ellen/ virtualmountpoint /afs/xyzcorp.com/home/ellen/test/data/
The virtualnodename option identifies your workstation to the server. You can use different node names to identify multiple systems on your workstation. You can also use the virtualnodename option if you want to restore or retrieve files from the server while you work at a different workstation. When you use the virtualnodename option, you are prompted for the TSM password assigned (if one is required) to the node you specify, because TSM must scan all the files in the file system to determine if they should be excluded.
In your client options file (dsm.opt) or in a command, use the virtualnodename option only when you want to request services for a different client node than the one on which you are working (the one specified in your client system options file). When you use the virtualnodename option in your client options file or with a command:
When connecting to a server, the TSM client must identity itself to the server. This login identification is determined in the following ways:
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-VIRTUALNodename- nodename-----------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.