Tivoli Storage Manager Installing the Clients


Chapter 8. Setting Processing Options

You can use defaults for processing options or you can tailor the processing options to meet specific needs. This chapter:

As a quick reference, this chapter includes instructions for the following tasks:

Task Page
Setting Options in a File "Setting Options in a File"
Using Options with Commands "Using Options with Commands"

Understanding Processing Options

Tivoli Storage Manager uses processing options to control communications, backup-archive processing, and other types of processing.

This section provides an overview of the following options that you can enter in your client options file:

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) and an include-exclude options file.

You can enter common options with specific commands to override many of the options set in your client options file. Tivoli Storage Manager processes these options in the following order (precedence):

  1. Options defined on the server with server-enforced client options. The server overrides client values.
  2. Options entered locally on the command line.
  3. Options defined on the server for a schedule using the options parameters.
  4. Options entered locally in the options file.
  5. Options received from the server with client options not enforced by the server. The server does not override client values.
  6. Default option values.

There are also options that are used only with commands. For more information about those options, see the following publications:


Communication Options

You use communication options to specify how your client node communicates with a Tivoli Storage Manager server. Table 12 shows communication protocols supported for various Tivoli Storage Manager client platforms. See "Options and Commands Available by Platform" for a list of options supported on each platform.

Table 12. Communication Protocols by Client

Protocol Macintosh NetWare UNIX Windows NT, 2000 Windows 98, Me
IPX/SPX
x


Named Pipes


x
Shared Memory

x1

SNA LU6.2
x


TCP/IP x x x x x
Note:
  1. AIX, AIX 5L, HP-UX, and Solaris only

Use the commmethod option to specify the communication protocol. For more information, see Commmethod.

You can also use the lanfreecommmethod option to specify the communication protocol in a SAN environment. See Lanfreecommmethod for more information.

Ask your Tivoli Storage Manager administrator for assistance in setting your communication options.

TCP/IP Options

To use the TCP/IP communication protocol, you must include the tcpserveraddress option in your client options file. The other TCP/IP options have default values which you can modify only if you want to change the default value.

For UNIX: If you plan to back up an NFS system, see Nfstimeout.

Table 13. TCP/IP Options

Option Description Page
httpport Specifies a TCP/IP port address for the Tivoli Storage Manager Web client. Httpport
httpsport Specifies a TCP/IP port address for the HTTPS secure socket layer (SSL) interface to the Tivoli Storage Manager Web client. This option is for AIX, AIX 5L, and Windows clients only. Httpsport
lanfreetcpport Specifies the TCP/IP port number where the Tivoli Storage Manager storage agent is listening. Lanfreetcpport
tcpbuffsize Specifies the size, in kilobytes, of the Tivoli Storage Manager internal TCP/IP communication buffer. Tcpbuffsize
tcpnodelay Specifies that Tivoli Storage Manager immediately sends small transactions to the server.This option is for a AIX and AIX 5L clients only. Tcpnodelay
tcpport Specifies the TCP/IP port address for a Tivoli Storage Manager server. Tcpport
tcpserveraddress Specifies the TCP/IP address for a Tivoli Storage Manager server. Tcpserveraddress
tcpwindowsize Specifies the size, in kilobytes, of the TCP/IP sliding window for your client node. Tcpwindowsize
webports Enables the use of the Web client outside a firewall by specifying the TCP/IP port number used by the Client Acceptor and the Web Client Agent service for communications with the Web GUI. Webports

IPX/SPX Options

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

Table 14. IPX/SPX Options

Option Description Page
ipxbuffersize Specifies the size, in kilobytes, of the IPX/SPX communication buffer. Ipxbuffersize
ipxserveraddress Specifies the IPX/SPX address for a Tivoli Storage Manager server. Ipxserveraddress
ipxsocket Specifies the IPX/SPX socket number for a Tivoli Storage Manager server. Ipxsocket

Named Pipes Option

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 Tivoli Storage Manager client and server on the same Windows server domain. Namedpipename

SNA LU6.2 (APPC) Options

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

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

Table 16. SNA LU6.2 (APPC) Options

Option Description Page
cpicbuffersize The buffer size for SNA LU6.2 communication. Cpicbuffersize
cpicmodename The mode name for SNA LU6.2 communication. Cpicmodename
partnerluname A logical unit name used by the transaction program to identify the Tivoli Storage Manager server in the SNA network. Partnerluname
symbolicdestination A symbolic Tivoli Storage Manager 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 Tivoli Storage Manager server. Tpname

Shared Memory Options

You must install TCP/IP on your workstation to use the shared memory communication method.

Table 17. 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
lanfreeshmport Specifies the Shared Memory port number where the Tivoli Storage Manager storage agent is listening. Use this option when lanfreecommmethod=SHAREdmem is specified for communication between the Tivoli Storage Manager client and storage agent for processing between the client and the SAN-attached storage device. Lanfreeshmport

Server and Node Options

Use the following options to specify the server to contact for backup-archive services, and the client node for which to request backup-archive services.

Table 18. Server and Node Options

Option Description Page
defaultserver The name of the Tivoli Storage Manager server to contact for backup-archive services by default if more than one server is defined in the client system options file (dsm.sys).

Also specifies the server to contact for space management services if you have the HSM client installed and do not specify a server with the migrateserver option. See Tivoli Space Manager for Unix Using the Hierarchical Storage Management Clients, SH26-4115 for more information.

Defaultserver
clusternode Specifies whether Tivoli Storage Manager is running as a cluster node. Clusternode
nasnodename Specifies the node name for the NAS file server. Nasnodename
nodename Specifies one of the following:
  • The name of your workstation so that you can establish communications with the Tivoli Storage Manager server.
  • The name of another workstation. Use this if you want to restore or retrieve your files from a Tivoli Storage Manager server to a different workstation than the one from which you stored the files.
Nodename
servername In the client system options file, this option specifies the name of a server. In the client user options file, this option specifies the Tivoli Storage Manager 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 Tivoli Storage Manager server to a client node other than the one on which you stored files. Virtualnodename

Backup and Archive Processing Options

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

Table 19. Backup and Archive Processing Options

Option Description Page
archsymlinkasfile Specifies whether you want Tivoli Storage Manager 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 file systems in the domain that will be mounted when the Tivoli Storage Manager client starts, and included for backup services. This option is for UNIX clients only. Automount
autofsrename

Specifies whether to rename an existing file space on a Unicode-enabled server so a Unicode-enabled file space can be created for the current operation. This option is for Windows NT and Windows 2000 clients only.

Autofsrename
backupregistry Specifies whether to back up the Windows registry during domain incremental backup or backup which includes the Windows system drive. 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 Specifies whether to continue compressing an object if it grows during compression, or resend the object uncompressed. This option is used with the compression option. Compressalways
compression Specifies whether to compress files before sending them to the server.

Note: The compression option also applies to migrated files if you install the Tivoli Storage Manager HSM client on your workstation.

Compression
dfsbackupmntpnt Specifies whether Tivoli Storage Manager sees a DFS (NTFS or FAT) as a junction or a directory. This option is valid for Windows 2000 only. Dfsbackupmntpnt (Windows)
dfsbackupmntpnt Specifies whether you want Tivoli Storage Manager to see a DFS mount point as a mount point or as a directory. Dfsbackupmntpnt (UNIX)
dirmc Specifies the management class to use for directories. If not specified, Tivoli Storage Manager 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 backup. This option is for AIX, AIX 5L, HP-UX, and Solaris only. Domain.image
domain.nas Specifies the volumes to include in your default domain for nas backups. This option is for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only. Domain.nas
enablelanfree Specifies whether to enable an available LAN-Free path to a storage area network (SAN) attached storage device. Enablelanfree
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. Equivalent to the exclude.backup, exclude.file, and exclude.file.backup options. 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.compression Excludes files from compression processing. Exclude Options
exclude.dir Excludes the specified directory, its files, and all its subdirectories and their files from backup services. Exclude Options
exclude.encrypt Excludes specified files from encryption processing. Exclude Options
exclude.file Excludes files, but not directories, that match a pattern. Equivalent to the exclude, exclude.file.backup, and exclude.backup options. Exclude Options
exclude.file.backup Excludes a file from normal backup services. Equivalent to the exclude, exclude.file, and exclude.backup options. Exclude Options
exclude.fs Excludes file spaces matching a pattern. This option is valid for all UNIX clients. Exclude Options
exclude.fs.nas Excludes file systems on the NAS file server from an image backup when used with the backup nas command. If you do not specify a NAS node name, the file system identified applies to all NAS servers. The backup nas command ignores all other exclude statements including exclude.fs and exclude.dir statements. This option is for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only. 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, AIX 5L, HP-UX, and Solaris only. Exclude Options
exclude.subfile Excludes files from adaptive subfile backup processing. 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 an include-exclude options file. Inclexcl
include Includes files or assigns management classes for backup or archive processing. Include Options
include.archive Includes files or assigns management classes for archive processing. Include Options
include.backup Includes files or assigns management classes for backup processing. Include Options
include.compression Includes files for compression processing. Include Options
include.encrypt Includes specified files for encryption processing. Include Options
include.file Includes a file for backup services, or assigns a management class to a file. Include Options
include.fs.nas Assigns a management class when used with the backup nas command. If you do not specify a NAS node name, the file system identified applies to all NAS file servers. The backup nas command ignores all other include statements. This option is for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only. 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
include.subfile Includes files for adaptive subfile backup processing. Include Options
include.systemobject Assigns management classes for backup of Windows 2000 system objects. By default, Tivoli Storage Manager binds all system objects to the default management class. You cannot use this option to bind individual systemobject components to a different management class. You cannot use this option to include or exclude a system object from processing. This option is valid for Windows 2000 only. Include Options
incrthreshold The incrthreshold option specifies the threshold value for the number of directories in any journaled file space that might have active objects on the server, but no equivalent object on the workstation. Incrthreshold
memoryefficientbackup Specifies a memory-saving backup algorithm for incremental backups when used with the incremental command. Memoryefficientbackup
nwignorecompressbit Specifies whether you want to ignore the setting of the compressed file (Co) attribute during selection processing for incremental backups. Nwignorecompressbit
skipntpermissions Specifies whether to back up Windows NT, 2000 security information. Skipntpermissions
skipntsecuritycrc Specifies whether to compute the security CRC for permission comparison during subsequent backups. Use this option on Windows NT, 2000 only. Skipntsecuritycrc
subdir Specifies whether to include subdirectories of a named directory. Subdir
subfilebackup Specifies whether Tivoli Storage Manager uses adaptive subfile backup. This option is for the Windows client only. Subfilebackup
subfilecachepath Specifies the path where the client cache resides for adaptive subfile backup processing. This option is for the Windows client only. Subfilecachepath
subfilecachesize Specifies the client cache size for adaptive subfile backup. This option is for the Windows client only. Subfilecachesize
tapeprompt Specifies whether you want Tivoli Storage Manager to wait for a tape required for a backup or archive to be mounted, or whether 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 Tivoli Storage Manager to consider for backup, saving processing time. Virtualmountpoint

Restore and Retrieve Processing Options

The following options relate to restore and retrieve processing.

Table 20. Restore and Retrieve Processing Options

Option Description Page
activatekey Specifies whether to activate the registry key to update the registry after restoring files. Activatekey
followsymbolic Specifies that you want 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
localbackupset Specifies whether the Tivoli Storage Manager GUI bypasses initial logon with the server to restore a local backup set on a Windows or UNIX standalone workstation. Localbackupset
replace Specifies whether to overwrite an existing file, or to prompt you for your selection when you restore or retrieve files. Replace
subdir Specifies whether you want to include subdirectories of a named directory. Subdir
tapeprompt Specifies whether you want Tivoli Storage Manager to wait for a tape required for a restore or retrieve to be mounted, or to prompt you for your choice. Tapeprompt

Scheduling Options

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

Table 21. Scheduling Options

Option Description Page
managedservices Specifies the services to be managed by the Tivoli Storage Manager Client Acceptor. Managedservices
maxcmdretries Specifies the maximum number of times the client scheduler attempts to process a scheduled command that fails. Maxcmdretries
postschedulecmd, postnschedulecmd Specifies a command to process after running a schedule. Postschedulecmd/Postnschedulecmd
preschedulecmd, prenschedulecmd Specifies a command to process before running a schedule. Preschedulecmd/Prenschedulecmd
queryschedperiod Specifies the number of hours the client scheduler waits between unsuccessful attempts to contact the 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
schedcmddisabled Specifies whether to disable the scheduling of generic commands specified by your Tivoli Storage Manager administrator. Schedcmddisabled
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 option only with the schedule command when you specify prompted as the schedule mode. Tcpclientaddress
tcpclientport Specifies the TCP/IP port number of your client node. Use this option only with the schedule command when you specify prompted as the schedule mode. Tcpclientport

Format and Language Options

You can use the following options to select different formats for date, time, and numbers, and for different languages if you have the appropriate client installed for that language.

Table 22. Format and Language Options

Option Description Page
dateformat Specifies the format for displaying dates. Dateformat
language Specifies the language used for messages. Language
numberformat Specifies the format for displaying numbers. Numberformat
timeformat Specifies the format for displaying time. Timeformat

Command Processing Options

The following options apply when you use Tivoli Storage Manager commands.

Table 23. 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
quiet Specifies that processing information does not display on your screen. This option can be overidden by the 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 Tivoli Storage Manager 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 server. Verbose

Authorization Options

These options control access to a Tivoli Storage Manager server.

Table 24. Authorization Options

Option Description Reference
encryptkey Specifies whether to save the encryption key locally or whether to prompt the user for the encryption key. Encryptkey
groups Specifies the groups on your workstation that you want to authorize to request services from the server. Groups
mailprog Specifies the program and user ID where you want to send a newly generated password when the old one expires. Mailprog
nwpwfile Specifies whether to encrypt and save a NetWare user's ID and password to the TSM.PWD file. Nwpwfile
nwuser Specifies a user ID and password to connect to a NetWare server when you start a session. Nwuser
optfile Specifies the options file you want to use when you start a session. Optfile
password Specifies a Tivoli Storage Manager password. Password
passwordaccess Specifies how Tivoli Storage Manager handles a password if one is required for your workstation. Passwordaccess
passworddir Specifies the directory in which you want to store the automatically generated password for your client node. The password is stored in the TSM.PWD file. This option is for Macintosh, NetWare and UNIX clients only. Passworddir
revokeremoteaccess Restricts an administrator with client access privileges from accessing your workstation through the Web client. Revokeremoteaccess
users Specifies users on your workstation who can request services from a server. Users

Error Processing Options

These options specify the name of the error log file and how Tivoli Storage Manager treats the entries in the log file.

Table 25. 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 session. If this option is set to no, the window closes automatically, and the client program returns to the NetWare console. Nwwaitonerror

Transaction Processing Options

These options control how Tivoli Storage Manager processes transactions between the client and server.

Table 26. Transaction Processing Options

Option Description Page
commrestartduration Specifies the maximum number of minutes you want the client to try to reconnect to a Tivoli Storage Manager server after a communication error occurs. Commrestartduration
commrestartinterval Specifies the number of seconds you want the client to wait between attempts to reconnect to a Tivoli Storage Manager 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, Tivoli Storage Manager waits for an NFS system call response before timing out. Nfstimeout
resourceutilization Specifies the number of sessions opened between the Tivoli Storage Manager server and client during processing. Resourceutilization
txnbytelimit Specifies the number of kilobytes Tivoli Storage Manager can buffer together in a transaction before sending data to the server. Txnbytelimit
usedirectory Specifies whether the client should ignore commmethod parameters set in the client options file and query the Active Directory for the communication method and server with which to connect. Use with Windows 2000 only. Usedirectory

Web Client Options

The following are options for the Tivoli Storage Manager Web Client.

Table 27. Web Client Options

Option Description Page
httpport Specifies a TCP/IP port address for the Web client. Httpport
httpsport Specifies a TCP/IP Secure Socket Layer (SSL) port address for the Web client. This option is for AIX, AIX 5L, and Windows clients only. Httpsport
managedservices Specifies whether the Tivoli Storage Manager Client Acceptor daemon manages the Web client. Managedservices
revokeremoteaccess Restricts administrator access on a client workstation through the Web client. Revokeremoteaccess
webports Enables the use of the Web client outside a firewall by specifying the TCP/IP port number used by the Tivoli Storage Manager Client Acceptor and the Web Client Agent service for communications with the Web GUI. Webports

Setting Options in a File

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

You can edit the client options file or Preferences file (Macintosh) with your favorite text editor.

To set an option in your client options file, enter the option name and one or more blank spaces, followed by the option value. For example:

   compression  yes
   nodename     client_a

Some options consist of only the option name, such as verbose and quiet. You can enter the entire option name or its abbreviation. For example, you can specify the verbose option as either of the following:

   verbose
   ve

Follow these additional rules when entering options in your client options file:

If you update the client options file while a GUI or Web client session is active, you must restart the session to pick up the changes. If you use the Setup Wizard to make changes, the changes are effective immediately.


Using Options with Commands

You can override some of the options in your options file by entering them with appropriate backup-archive commands. You cannot override options by entering them with HSM commands. See the following client publications for more information:

Note:
Use a leading dash (-) or forward slash (/) to indicate that the following text is the name of an option. If an object name begins with one of these characters you must surround it in either single quotes (') or double quotes ("). Most operating system command line processors strip the quotes before submitting the command line arguments to the Tivoli Storage Manager client application. In such cases, using escape characters or doubling the quotes allows the client to receive the quoted object name. In loop mode, surround such objects in either single quotes (') or double quotes (").

Client Options Reference

The following sections contain detailed information about each of the Tivoli Storage Manager processing options. 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.

UNIX Options

Tivoli Storage Manager processing options reside in these files:


Options and Commands Available by Platform

Table 28 lists the common options available for all supported platforms.

Table 28. Common Options Available by Platform

Common Options Macintosh NetWare UNIX Windows NT, 2000 Windows 98, Me
activatekey


x x
afsbackupmntpnt

x

archsymlinkasfile

x

autofsrename


x
automount

x6

backupregistry


x x
changingretries x x x x x
clusternode


x
commmethod x x x x x
commrestartduration x x x x x
commrestartinterval x x x x x
compressalways x x x x x
compression x x x x x
cpicbuffersize
x


cpicmodename
x


dateformat x x x x x
defaultserver

x

dfsbackupmntpnt (Windows)


x4
dfsbackupmntpnt (UNIX)

x

dfsinclexcl

x

dirmc x x x x x
domain x x x x x
domain.image

x1

domain.nas

x5 x
editor
x x3 x x
enablelanfree

x5 x
encryptkey
x x x x
errorlogname x x x x x
errorlogretention x x x x x
exclude x x x x x
exclude.archive x x x x x
exclude.backup x x x x x
exclude.compression
x x x x
exclude.dir x x x x x
exclude.encrypt
x x x x
exclude.file x x x x x
exclude.file.backup x x x x x
exclude.fs

x

exclude.fs.nas

x5 x
exclude.image

x1

exclude.subfile


x x
followsymbolic

x

groups

x

guitreeviewafterbackup x
x x x
httpport
x x x x
httpsport

x2 x x
inclexcl x x x x x
include x x x x x
include.archive x x x x x
include.backup x x x x x
include.compression
x x x x
include.encrypt
x x x x
include.file x x x x x
include.fs.nas

x5 x
include.image

x1

include.subfile


x x
include.systemobject


x4
incrthreshold


x
ipxbuffersize
x


ipxserveraddress
x


ipxsocket
x


lanfreecommmethod

x5 x
lanfreeshmport

x5

lanfreetcpport

x5 x
language x x
x x
largecommbuffers x x x x x
localbackupset

x x x
mailprog

x

managedservices
x x x x
matchallchar x



matchonechar x



maxcmdretries x x x x x
memoryefficientbackup x x x x x
namedpipename


x
nasnodename

x5 x
nfstimeout

x

nodename x x x x x
numberformat x x x x x
nwignorecompressbit
x


nwpwfile
x


nwuser
x


nwwaitonerror
x


optfile
x x x x
partnerluname
x


password x x x x x
passwordaccess x x x x x
passworddir x x x

postnschedulecmd x
x x x
postschedulecmd x x x x x
prenschedulecmd x
x x x
preschedulecmd x x x x x
processorutilization
x


queryschedperiod x x x x x
quiet x x x x x
replace
x x x x
resourceutilization x x x x x
retryperiod x x x x x
revokeremoteaccess
x x x x
runasservice


x
schedcmddisabled
x x x x
schedcompleteaction x



schedlogname x x x x x
schedlogretention x x x x x
schedmode
x x x x
scrolllines
x x x x
scrollprompt
x x x x
servername

x

shmport

x1

skipntpermissions


x
skipntsecuritycrc


x
subdir
x x x x
subfilebackup


x x
subfilecachepath


x x
subfilecachesize


x x
symbolicdestination
x


tapeprompt x x x x x
tcpbuffsize x x x x x
tcpclientaddress
x x x x
tcpclientport
x x x x
tcpnodelay

x2 x x
tcpport x x x x x
tcpserveraddress x x x x x
tcpwindowsize x x x x x
timeformat x x x x x
tpname
x


txnbytelimit
x x x x
usedirectory


x4
users

x

verbose x x x x x
virtualmountpoint

x

virtualnodename x x x x x
webports
x x x x
Note:
  1. AIX, AIX 5L, HP-UX, and Solaris only
  2. AIX, AIX 5L only
  3. All UNIX except OS/390 UNIX
  4. Windows 2000 only
  5. AIX, AIX 5L, and Solaris only
  6. All UNIX except Linux86 and Linux390

This publication does not document Tivoli Storage Manager client command line options or commands. For detailed information about client command line options and commands, see the following publications:

Table 29. Tivoli Storage Manager Client Publications

Publication Title Order Number
Tivoli Storage Manager for Windows Using the Backup-Archive Clients SH26-4117
Tivoli Storage Manager for NetWare Using the Backup-Archive Client SH26-4116
Tivoli Storage Manager for UNIX Using the Backup-Archive Clients SH26-4122
Table 30 lists the command line options available for all supported platforms.

Table 30. Command Line Options Available by Platform

Command Line Options NetWare UNIX Windows NT, 2000 Windows 98, Me
archmc x x x x
class
x1 x
deletefiles x x x x
description x x x x
detail x x x x
dirsonly x x x x
filelist x x x x
filesonly x x x x
fromdate x x x x
fromnode x x x x
fromowner
x

fromtime x x x x
ifnewer x x x x
inactive x x x x
incrbydate x x x x
incremental
x

latest x x x x
location x x x x
mode
x x x
monitor
x1 x
nojournal

x
noprompt x x x x
pick x x x x
pitdate x x x x
pittime x x x x
preservepath x x x x
todate x x x x
totime x x x x
type
x1 x
v2archive x x x x
volinformation x x

Note:
  1. AIX, AIX 5L, and Solaris only

Table 31 lists the commands available for all supported platforms.

Table 31. Commands Available by Platform

Commands NetWare UNIX Windows NT, 2000 Windows 98, Me
archive x x x x
backup activedirectory

x3
backup certserverdb

x3
backup clusterdb

x3
backup complusdb

x3
backup eventlog

x
backup frs

x3
backup image
x1

backup nas
x2 x
backup registry

x x
backup rsm

x
backup sysfiles

x3
backup systemobject

x3
backup sysvol

x3
cancel process
x2 x
cancel restore x x x x
delete access x x x x
delete archive x x x x
delete filespace x x x x
expire x x x x
help x x x x
incremental x x x x
loop x x x x
macro x x x x
monitor process
x2 x
query access x x x x
query activedirectory

x3
query archive x x x x
query backup x x x x
query backupset x x x x
query certserverdb

x3
query clusterdb

x3
query complusdb

x3
query eventlog

x3
query filespace x x x x
query frs

x3
query image
x1

query inclexcl x x x x
query mgmtclass x x x x
query node
x2 x
query registry

x3
query restore x x x x
query rsm

x3
query schedule x x x x
query session x x x x
query sysfiles

x3
query systemobject

x3
query sysvol

x3
query tsa x


restart restore x x x x
restore x x x x
restore activedirectory

x3
restore backupset x x x x
restore certserverdb

x3
restore clusterdb

x3
restore complusdb

x3
restore eventlog

x
restore frs

x3
restore image
x1

restore nas
x2 x
restore registry

x x
restore rsm

x
restore sysfiles

x3
restore systemobject

x3
restore sysvol

x3
retrieve x x x x
schedule x x x x
selective x x x x
set access x x x x
set password x x x x
Note:
  1. AIX, AIX 5L, HP-UX, and Solaris only.
  2. AIX, AIX 5L, and Solaris only.
  3. Windows 2000 only.

Activatekey

The activatekey option specifies whether to 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 clients only.

Syntax

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

Parameters

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

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

Examples

Options file:
activate yes

Command line:
-activate=yes

Afsbackupmntpnt

Root User

The afsbackupmntpnt option specifies whether you want Tivoli Storage Manager to see an AFS mount point as a mount point or as a directory. If Tivoli Storage Manager sees it as a mount point, it backs up only the name of the mounted volume during a backup operation. It does not back up the subtree by starting from the mount point directory.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys) or the client options file (dsm.opt). Use this option with dsmafs and dsmcafs.

Syntax

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

Parameters

Yes
Specifies that Tivoli Storage Manager views all AFS mount points as mount points and backs up only the mount point information for any mount point it encounters during a backup operation. This is the default.

No
Specifies that Tivoli Storage Manager views all AFS mount points as directories and backs up the contents of files and subdirectories of any mount point it encounters during a backup operation.

Examples

Options file:
afsbackupmntpnt no

Archsymlinkasfile

The archsymlinkasfile option specifies whether Tivoli Storage Manager follows a symbolic link and archives the file or directory it points to, or archives the symbolic link only. Use this option with the archive command.

Use the followsymbolic option to restore to a symbolic link (that is a virtual mount point). The followsymbolic option is not related to the archsymlinkasfile option.

Note:
The server can also define this option.

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

Yes
Specifies that Tivoli Storage Manager follows a symbolic link and archives the associated file or directory. This is the default.

No
Specifies that Tivoli Storage Manager archives the symbolic link and not the associated file or directory.

Examples

Options file:
archsymlinkasfile no

Command line:
archsyml no

Autofsrename

The autofsrename option renames an existing file space on a server so that a Unicode-enabled file space with the original name can be created for the current operation. The server can define the autofsrename option and override the autofsrename setting on the client. This option is for Windows NT and Windows 2000 clients only.

When you specify autofsrename yes in your client options file, and the server value of autofsrename is set to client, Tivoli Storage Manager generates a unique name by appending _OLD to the file space name you specify in the current operation. For example, Tivoli Storage Manager renames the file space \\your-node-name\h$ to \\your-node-name\h$_OLD. If the new file space name is too long, the suffix replaces the last characters of the file space name, as follows:

   \\your-node-name_OLD

If the new file space name already exists on the server, Tivoli Storage Manager renames the new file space \\your-node-name_OLDx, where x is a unique number.

Tivoli Storage Manager proceeds to create new Unicode-enabled file spaces that contain only the data specified in the current operation. For example, to archive files from your H-disk named \\your-node\h$, issue the following archive command:

   arc h:\logs\*.log

Before the archive takes place, the server renames the file space to \\your-node\h$_OLD. The archive places the data specified in the current operation into the Unicode-enabled file space named \\your-node\h$. The new Unicode-enabled file space now contains only the \logs directory and the *.log files specified in the operation. Tivoli Storage Manager stores all subsequent full and partial incremental, selective backup, and archive data in the new Unicode-enabled file spaces.

Renamed file spaces remain on the server as stabilized file spaces. These file spaces contain all the original data, which you can restore as long as they remain on the server.

After installing the Windows NT, 2000 client, perform a full incremental backup and rename all existing file spaces that are not Unicode enabled and back up the files and directories within them under the new Unicode-enabled file spaces. This operation requires increased processing time and storage on the server.

File spaces that are not Unicode enabled can be viewed in the character set of the locale from which Tivoli Storage Manager backed up the files. A workstation running in a different locale may be unable to view or restore from these file spaces. Unicode-enabled file spaces that are backed up in one locale are visible in all other locales, provided that the workstation has the proper fonts installed. For more information on migrating to Unicode-enabled file spaces, see Migrating to the Unicode-Enabled TSM Client.

Place this option in the client options file (dsm.opt).

Supported Clients

This option is for Windows NT and Windows 2000 Unicode-enabled clients only.

Syntax

                .-Prompt-.
>>-AUTOFsrename-+--------+-------------------------------------><
                +-Yes----+
                '-No-----'
 
 

Parameters

Yes
Specifies that Tivoli Storage Manager automatically renames all file spaces that are not Unicode enabled in the current backup or archive operation.

No
Specifies that Tivoli Storage Manager does not rename file spaces that are not Unicode enabled in the current backup or archive operation.

Prompt
Specifies that Tivoli Storage Manager prompts you whether to rename the file spaces that are not Unicode enabled in the current operation. This is the default.

Considerations:

  1. This option applies when the server sets the autofsrename option to client.
  2. When the client scheduler is running, the default behavior is to not prompt. The next interactive session prompts you to rename the file space.
  3. The client prompts one time per file space only. If you specify no at the prompt, the client cannot rename the file spaces later. However, the Tivoli Storage Manager administrator can rename the file spaces on the server.
  4. When backing up files to a file space that is not Unicode enabled, the Unicode-enabled client skips the files and directories with names containing characters from a code page that is different from the current locale.
  5. If files and directories with names containing characters from a code page other than the current locale were previously backed up with a client that was not Unicode enabled, they may be expired. The Unicode-enabled client expires these files if you do not migrate the file space to a Unicode-enabled file space. You can back up and archived these files to a Unicode-enabled file space.

Examples

Options file:
autofsrename yes

Automount

Authorized User (UNIX requires access authority)

The automount option specifies all automounted file systems in the domain that you want to mount when Tivoli Storage Manager starts so they can be included in backup processing. Use this option with the domain option.

It is unnecessary to explicitly specify the file system 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 Linux86 and Linux390.

Options File for UNIX Platforms

Place this option in the client options file (dsm.opt).

Syntax

             .- --------------.
             V                |
>>-AUTOMount--- filespacename-+--------------------------------><
 
 

Parameters

filespacename
Specifies one or more automounted file systems in your domain that are mounted and processed when the client starts.

Examples

Options file:
automount fs1 fs2

Command line:
Does not apply.

Backupregistry

The backupregistry option specifies whether to back up the Windows registry during domain incremental backup or backups which include the Windows system drive.

On the native and Web GUIs, this option is only valid when executing the Backup Domain action.

Note:
For Windows 2000, this option is ignored if you specify systemobject in a domain statement during an incremental backup.

Supported Clients

This option is for Windows clients only.

Syntax

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

Parameters

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

No
The Tivoli Storage Manager program does not back up the registry.

Examples

Options file:
backupreg no

Command line:
-backupreg=yes

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

Changingretries

Authorized User (UNIX requires access authority.)

The changingretries option specifies how many additional times you want the client to attempt to back up or archive a file that is in use. Use this option with the archive, incremental, and selective commands.

Use this option 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 open during an operation, the operation repeats the number of times that you specified. If the file is open during each attempt, the operation does not complete.

With shared dynamic serialization, if a file is open during an operation, the operation repeats the number of times that you specified. The backup or archive occurs during the last attempt whether the file is open or not.

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

Note:
The server can also define this option.

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

numberretries
Specifies the number of times a backup or archive operation is attempted if the file is in use. The range of values is zero through 4; the default is 4.

Examples

Options file:
changingretries 3

Preferences file:
changingretries 3

Command line:
-cha=0 (Windows or NetWare)
Does not apply.   (UNIX)

Clusternode

The clusternode option specifies whether Tivoli Storage Manager manages 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", SH26-4119.

Supported Clients

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

Syntax

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

Parameters

Yes
Specifies that you want to back up cluster resources.

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

Examples

Options file:
cluster no

Command line:
-cluster=yes

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

Commmethod

Authorized User (UNIX requires access authority.)

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-+
              +- SHAREdmem--+
              '- SNALu6.2---'
 
 

Parameters

TCPip
The Transmission Control Protocol/Internet Protocol (TCP/IP) communication method. This communication method is valid for all platforms.

IPXspx
The Internetwork Packet Exchange/Sequenced Packet Exchange (IPX/SPX) communication method. This communication method is valid for the NetWare client only.

NAMedpipes
The interprocess communication method that permits message data streams to pass between a client and a server. Use this communication method with a Windows NT server running on the same workstation as the client. This communication method is valid for Windows NT and Windows 2000 clients only.

SHAREdmem
Use the Shared Memory communication method when the client and server are running on the same system. This provides better performance over the TCP/IP protocol. This communication method is valid for AIX, AIX 5L, HP-UX, and Solaris clients only.

When specifying this communications method on AIX, you must be log in as root or have the same user ID as the process running the server.

When specifying this communications method on AIX, the API client user must log in as root or have the same user ID as the process running the server. This restriction does not apply if you alter your API program file permissions by using the following commands:

   chown root.system your_api_program
   chmod u+s your_api_program

When specifying the Shared Memory communication method on AIX, the administrative client user must log in as root or have the same user ID as the process running the server. This restriction does not apply if you alter the administrative client programs file permissions by 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 

SNALu6.2
The Systems Network Architecture Logical Unit 6.2 (SNALu6.2) communication method. This communication method is valid for the NetWare client only.

Examples

Options file:
commm tcp

Preferences file:
commm tcp

Command line:
-commmethod=tcp (Windows or NetWare)

Does not apply. (UNIX)

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

Commrestartduration

Authorized User (UNIX requires access authority.)

The commrestartduration option specifies the maximum number of minutes you want the client to attempt to reconnect with a server after a communication error occurs.

Note:
If a communication failure occurs when a schedule is running, the scheduled operation fails if 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

minutes
The maximum number of minutes you want the client to attempt to reconnect with a server after a communication failure occurs. The range of values is zero through 9999; the default is 60.

Examples

Options file:
commrestartduration 90

Preferences file:
commrestartduration 90

Command line:
Does not apply.

Commrestartinterval

Authorized User (UNIX requires access authority.)

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:
Use this option only when commrestartduration is 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

seconds
The number of seconds you want the client to wait between attempts to reconnect with a server after a communication failure occurs. The range of values is zero through 65535; the default is 15.

Examples

Options file:
commrestartinterval 30

Preferences file:
commrestartinterval 30

Command line:
Does not apply.

Compressalways

The compressalways option specifies whether to continue compressing an object if it grows during compression, or resend the object uncompressed. Use this option with the compression option.

Use the compressalways option with the archive, incremental, and selective commands.

Note:
The server can also define this option.

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

Yes
File compression continues even if the file grows as a result of compression. This is the default.

No
Backup-archive client objects are resent uncompressed if they grow during compression.

Examples

Options file:
compressalways yes

Preferences file:
compressalways yes

Command line:
-compressa=no

This option is valid only on the initial command line.

Compression

Authorized User (UNIX requires access authority.)

The compression option compresses files before you send them to the server. Compressing your files reduces data storage for backup versions and archive copies of your files. It can, however, affect Tivoli Storage Manager throughput. A fast processor on a slow network connection benefits from compression, but a slow processor on a fast network connection does not.

Note:
For NetWare: The client will not compress files that the NetWare operating system already compresses. If you specify compression=yes and Tivoli Storage Manager finds a file that the NetWare operating system already compresses, the file is sent to the server without further compression. The file is sent as a NetWare compressed file.

For Windows NT, 2000: Tivoli Storage Manager backs up named streams on a file basis only. Tivoli Storage Manager does not support the backup of a named stream containing sparse file data. Tivoli Storage Manager backs up a sparse file as a regular file if client compression is off. Specify compression=yes to enable file compression when backing up sparse files to minimize network transaction time and maximize server storage space.

If you specify compressalways=yes, compression continues even if the file size increases. To stop compression if the file size grows, and resend the file uncompressed, specify compressalways=No.

If you specify compression=yes, you can control compression processing in the following ways:

This option controls compression only if your administrator specifies that your client node can compress files before sending them to the server.

Use the compression option with the archive, incremental, and selective commands.

Note:
The server can also define this option.

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

No
Files are not compressed before they are sent to the server. This is the default.

Yes
Files are compressed before they are sent to the server.

Examples

Options file:
compression yes

Preferences file:
compression yes

Command line:
-compressi=no (Windows or NetWare)

Does not apply. (UNIX)

Cpicbuffersize

The cpicbuffersize option specifies the size of the CPIC buffer for SNA LU6.2 communication. A larger buffer can improve communication performance, but uses more memory.

Supported Clients

This option is valid for the NetWare client only.

Syntax

>>-CPICBuffersize- size----------------------------------------><
 
 

Parameters

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

Examples

Options file:
cpicbuffersize 31

Command line:
-cpicbuffersize=31

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

Cpicmodename

The cpicmodename option defines the mode name for the SNA LU6.2 communication method. For CPIC, this option identifies the SNA connection to the gateway and target logical unit. The CPIC mode name is used if the symbolic destination is not provided and the partner LU is located on another system. The mode name must be known on both the local and remote systems.

If you use this option, you must also use the tpname and partnerluname options.

Supported Clients

This option is valid for the NetWare client only.

Syntax

>>-CPICModename- name------------------------------------------><
 
 

Parameters

name
Specifies the mode name for SNA LU6.2 communication. Contact your system administrator for this name. There is no default.

Examples

Options file:
cpicmodename vmmode

Command line:
-cpicmodename=vmmode

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

Dateformat

The dateformat option specifies the format you want to use to display dates.

For all clients except UNIX: Use this option if you want to change the default date format for the language of the message repository you are using.

The AIX, AIX 5L, 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 you start the client. Consult the documentation on your local system for details about setting up your locale definition.

Note:
When you change the date format and use the schedlogretention option to prune the schedule log, Tivoli Storage Manager removes all entries in the schedule log with a different date format when pruning the log. When you change the date format and use the errorlogretention option to prune the error log, Tivoli Storage Manager removes all entries in the error log with a different date when pruning the log. When changing the date format, copy the schedule log and error log if you want to preserve log entries that contain a different date format.

Notes:

  1. This dateformat option does not affect the Web client. The Web client uses the date format for the locale that the browser is running in. If the browser is not running in a locale that Tivoli Storage Manager supports, the Web client uses the date format for American English.

  2. When you change the date format and use the schedlogretention option to prune the schedule log, Tivoli Storage Manager removes all entries in the schedule log with a different date format when pruning the log. When you change the date format and use the errorlogretention option to prune the error log, Tivoli Storage Manager removes all entries in the error log with a different date when pruning the log. When changing the date format, copy the schedule log and error log if you want to preserve log entries that contain a different date format.

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

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

0
Use the locale-specified date format. For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: This is the default if the locale-specified date format consists of digits and separator characters.

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

For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: This is the default if the locale-specified date format consists of anything but digits and separator characters.

2
DD-MM-YYYY

3
YYYY-MM-DD

4
DD.MM.YYYY

5
YYYY.MM.DD

For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: 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.

"%m/%d/%y"
Displays the date in the form MM/DD/YY
"%d.%m.%Y"
Displays the date in the form DD.MM.YYYY

Examples

Options file:
dateformat 3

Preferences file:
dateformat 3

Command line:
-date=4

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it remains in effect for the entire interactive session or until you enter another dateformat option.

Defaultserver

Authorized User (UNIX requires access authority.)

The defaultserver option specifies the default server to which you want to back up or archive files 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, use this option to specify the server to which you want to migrate files. See Tivoli Space Manager for Unix Using the Hierarchical Storage Management Clients for more information.

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

servername
Specifies the name of the default server to which you back up or archive files. The server to which files are migrated from your local file systems can also be specified with this option. You can use this option if you do not specify a migration server with the migrateserver option.

Examples

Options file:
defaults server_a

Command line:
Does not apply.

Dfsbackupmntpnt (Windows)

The dfsbackupmntpnt option specifies whether Tivoli Storage Manager views a Microsoft DFS junction residing on an NTFS or FAT drive as a junction or a directory. If Tivoli Storage Manager views Microsoft DFS junction as a junction, only the name of the mounted junction is backed up or archived. The subtree under the junction point is not backed up or archived.

Place this option in the client options file (dsm.opt). You can specify this option by using the preferences editor.

This option is effective only when you back up or archive a Microsoft DFS root and is ignored when you back up or archive a Microsoft DFS junction. To restore a DFS tree, the root of the tree must already exist.

Supported Clients

This option is valid for Windows 2000 only.

Syntax

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

Parameters

Yes
Specifies that Tivoli Storage Manager views all Microsoft DFS junctions as junctions and backs up only the name of any mounted junction it encounters during a backup operation. This is the default.

No
Specifies that Tivoli Storage Manager views all Microsoft DFS junctions as directories and backs up the contents of files and subdirectories of any junction it encounters during a backup operation.

Examples

Options file:
dfsbackupmntpnt no

Command line:
Does not apply.

Dfsbackupmntpnt (UNIX)

Root User

The dfsbackupmntpnt option specifies whether you want Tivoli Storage Manager to see a DFS mount point as a mount point or as a directory. If Tivoli Storage Manager sees it as a mount point, it backs up only the name of the mounted fileset during a backup operation. It does not back up the subtree by starting from the mount point directory.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys) within a server stanza, or in the client options file (dsm.opt). Use this option with dsmdfs and dsmcdfs.

Syntax

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

Parameters

Yes
Specifies that Tivoli Storage Manager views all DFS mount points as mount points and backs up only the the name of the mounted fileset for any mount point it encounters during a backup operation. This is the default.

No
Specifies that Tivoli Storage Manager views all DFS mount points as directories and backs up the contents of files and subdirectories of any mount point it encounters during a backup operation.

Examples

Options file:
dfsbackupmntpnt no

Dfsinclexcl

Root User

If you use a DFS include-exclude options file, the dfsinclexcl option specifies the path and file name. You can use a DFS include-exclude options file to exclude DFS files or directories from backup. You can use a DFS include-exclude options file to assign different management classes to specific files or groups of files.

A DFS include-exclude options file pointed to by the dfsinclexcl option is used only when DFS files are examined for backup.

Attention: A separate DFS include-exclude options file is required because the prefix /... means the global root in DFS. In a DFS include-exclude options file, the /... prefix is interpreted as the global root of DFS, and the /... prefix is used to match zero or more directories.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-DFSInclexcl filespec----------------------------------------><
 
 

Parameters

filespec
The filespec parameter specifies the path and file name of your DFS include-exclude options file.

Examples

Options file:
dfsinclexcl /usr/lpp/adsm/bin/backup.excl.dfs

Dirmc

Authorized User (UNIX requires access authority.)

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.

If you specify a management class with this option, all directories specified in a backup operation are bound to that management class.

The dirmc option specifies the management class of directories you back up and does not effect archived directories. Archived directories are always bound to the default management class.

The server can also define this option.

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

mgmtclassname
Specifies the name of the management class you want to associate with directories. The management class name that you specify is used for all directories that you back up. If you do not use this option, the management class with the longest retention period is associated with directories.

Examples

Options file:
dirm managdir

Preferences file:
dirm managdir

Command line
Does not apply.

Domain

The domain option specifies the drives, volumes, or file systems that you want to include for incremental backup in your client domain. The server can also define this option.

Use the domain option in your client system options file or Preferences file to define your default client domain. Tivoli Storage Manager uses your default client domain in the following situations to determine which local drives, volumes, or file systems to process during an incremental backup:

If you do not use the domain option to specify local drives, volumes, or file systems in your client options or Preferences file, Tivoli Storage Manager uses the all-local parameter as the default.

Note:
You can include a virtual mount point in your client domain. For information about defining a virtual mount point, see Virtualmountpoint.

When you use the domain option with the incremental command, Tivoli Storage Manager adds local drives, volumes, or file systems that you specify to the local drives, volumes, or file system defined in your client options or Preferences file. For example, if you enter the following in your client options file:

   domain c: d: e:     (Windows)
   domain /home /usr /datasave     (UNIX)
   domain sys: data: bindery:     (NetWare)

and the following on the command line:

   dsmc incremental -domain="g: h:"   (Windows)
   dsmc incremental -domain="/fs1 /fs2"   (UNIX)
   load dsmc incremental -domain=usr:   (NetWare)   

Tivoli Storage Manager performs an incremental backup for your c: d: e: g: and h: local drives. (Windows)Tivoli Storage Manager performs an incremental backup for your /home, /usr, /datasave, /fs1, and /fs2 file systems (UNIX).Tivoli Storage Manager performs an incremental backup for your sys:, data:, and usr: volumes and the bindery: (NetWare).

If you use both a file specification and the domain option with the incremental command, Tivoli Storage Manager ignores the domain option and processes only those drives, volumes, or file systems specified in the file specification. For example, if you enter:

   dsmc incremental e: f: -domain="g: h:" (Windows)
   dsmc incremental /fs1 /fs2 -domain="/fs3 /fs4" (UNIX)
Tivoli Storage Manager performs an incremental backup for the e: and f: drives only. (Windows)

Tivoli Storage Manager performs an incremental backup for the /fs1 and /fs2 file systems only. (UNIX)

Attention: If you are running GPFS for AIX in a multi-node cluster, and all nodes share a mounted GPFS file system, Tivoli Storage Manager processes this file system as a local file system. Tivoli Storage Manager backs up the file system on each node during an incremental backup. To avoid this, you can do one of the following:

Automounted File Systems (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 mount points for an automounted file system (autofs) are excluded from backup when the automounter has mounted these mount points. 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 client starts, can be backed up using the domain option or the GUI. You cannot back up unmounted file systems monitored by an automounter.

You can use the automount option with the domain option to specify one or more file systems to be mounted when the client starts. See Automount for more information.

An automounted file system that is mounted when starting the client can be explicitly backed up by specifying the automounted file system with the incremental command. For example:

   dsmc incremental autofs_name

Virtual mount points cannot be used with automounted file systems.

For HP-UX: The domain option is enhanced with the new keywords all-auto-lofs and all-auto-nfs to support automounted file systems. To use this enhancement, set the autofs parameter to 1 in the /etc/rc.config.d/nfsconf file. Changing this parameter requires a reboot. For further information please refer to the HP documentation on this issue.

The following UNIX platforms support automounter, LOFS, or LOFS through automounter, as indicated:

Platform automounter LOFS LOFS through automounter
AIX and AIX 5L yes yes yes
Solaris yes yes yes
HP-UX yes yes no
SGI yes no yes
Tru64 UNIX yes no no
NUMA-Q yes no no
OS/390 UNIX yes no no

Notes:

  1. The Linux clients are not enabled for automounter support.

  2. Linux does not support loopback file systems. Instead, a loop device is available to allow devices or files mounted as whole file systems. The Linux clients do not support Loop devices. File systems mounted via the loop device are handled as local file systems with the corresponding file system type.

Supported Clients

All clients can use this option.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys) or the client user options file (dsm.opt).

Syntax

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

Parameters

all-local
Backs up all local hard drives, volumes, or file systems except LOFS file systems and LOFS through automounter. For Windows 2000: The systemobject domain is included in all-local processing. This is the default.

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.

domain
Defines the drives, volumes, or file systems to include in your default client domain.

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

systemobject
Backs up all relevant system objects. Systemobject is included if all-local is specified. This is valid for Windows 2000 only.

BINdery
Backs up the three system files comprising the bindery database. This parameter is valid for NetWare only.

DIRectory or NDS
Specifies the NDS. This parameter is valid for NetWare only.

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

all-lofs
Backs up all loopback file systems, except those handled by automounter. This parameter is valid for UNIX only.

all-nfs
Backs up all network file systems, except those handled by automounter. This parameter is valid for UNIX only.

all-auto-nfs
Backs up all network file systems which are handled by automounter. This parameter is valid for UNIX only.

all-auto-lofs
Backs up all loopback file systems which are handled through automounter. This parameter is valid for UNIX only.

Examples

Options file:
domain c: d: e: (Windows)
domain c: systemobject (Windows 2000 only)
domain sys:tsm\nds (NetWare)

domain /tst /datasave /joe  (UNIX)
"domain all-local" (UNIX)
 

Preferences file:
domain "la pomme"

Command line:
-domain="c: d:" (Windows)
-domain="servera\sys: serverb/sys:" (NetWare)
-domain=""/fs1
/fs2"" (UNIX)
-domain=/tmp  (UNIX)
 

Domain.image

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. Use this option in your client options file to define your default client image domain.

If you do not specify a file system with the backup image command, the file systems you specified with the domain.image option are backed up.

When you specify a file system with the backup image command, the domain.image option is ignored.

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.

Note:
The server can also define this option.

Supported Clients

This option is for AIX, AIX 5L, HP-UX, and Solaris only.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

                 .- ----------.
                 V            |
>>-DOMAIN.Image----+--------+-+--------------------------------><
                   '-domain-'
 
 

Parameters

domain
Defines the file systems or raw logical volumes to include in your default client image domain.

Examples

Options file:
domain.image /fs1 /fs2

Command line:
Does not apply.

Domain.nas

The domain.nas option specifies the volumes to include in your NAS image backups. You can specify all-nas to include all the mounted file systems on the NAS file server, except those you exclude with the exclude.fs.nas option. When you use this option in your client system option file dsm.sys (UNIX) or client options file dsm.opt (Windows), the domain.nas option defines your default domain for NAS image backups.

Tivoli Storage Manager uses your domain for NAS image backups when you run a backup nas command and you do not specify which volumes to process.

When you perform a NAS file system image backup using the backup nas command, Tivoli Storage Manager adds volumes that you specify on the command line to the volumes defined in your dsm.sys (UNIX) or dsm.opt (Windows) file. For example, if you enter the following in your dsm.sys (UNIX) or dsm.opt (Windows) file:

domain.nas nas1/vol/vol0 nas1/vol/vol1

and you enter the following on the command line

dsmc backup nas -nasnodename=nas1 /vol/vol2

Tivoli Storage Manager performs a backup for the following volumes on node nas1: vol/vol0, vol/vol1, and vol/vol2.

When performing a backup, if you use a file specification and specify domain.nas=all-nas in the dsm.sys (UNIX) or dsm.opt (Windows) file, all-nas takes precedence. Tivoli Storage Manager processes all mounted volumes on the NAS file server.

The domain.nas option is valid for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only

Place this option in the client options file (dsm.opt).

Note:
The server can also define this option.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

               .- -----------.
               V .-all-nas-. |
>>-DOMAIN.Nas----+---------+-+---------------------------------><
                 '-domain--'
 
 

Parameters

domain
Defines the volumes you want to process.

all-nas
Processes all mounted volumes on the NAS file server, except those you exclude with the exclude.fs.nas option. This is the default.

Examples

Options file:

domain.nas nas1/vol/vol0 nas1/vol/vol1
domain.nas all-nas

Command line:
Does not apply.

Editor

The editor option turns the command line interface (CLI) editor and retrieve capability on or off.

For Windows NT and Windows 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 Windows 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

This option is valid for the NetWare, UNIX (except OS/390 UNIX System Services), and Windows clients.

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

Yes
Turns on the CLI editor and command retrieve capability. This is the default. However, for Windows NT or Windows 2000 the value for this option is always editor=No.

No
Turns off the CLI editor and command retrieve capability.
Note:
The editor is not supported on OS/390 UNIX System Services, so the editor option should be set to No.

Examples

Options file:
editor yes

Command line:
Does not apply.

Enablelanfree

Authorized User (UNIX requires access authority.)

The enablelanfree option specifies whether to enable an available LAN-Free path to a storage area network (SAN) attached storage device. A LAN-Free path allows backup, restore, archive, and retrieve processing between the Tivoli Storage Manager client and the SAN-attached storage device.

To support LAN-Free data movement you must install and configure the Tivoli Storage Manager Managed System for SAN feature on the client workstation. For more information, refer to the following publications:

For Windows NT, 2000: Place this option in the client options file (dsm.opt).

To specify a communication protocol between the Tivoli Storage Manager client and Storage Agent, see Lanfreecommmethod for more information.

Supported Clients

This option is valid for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris clients only.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

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

Parameters

Yes
Specifies that you want to enable an available LAN-Free path to a SAN-attached storage device.

No
Specifies that you do not want to enable a LAN-Free path to a SAN-attached storage device. This is the default.

Examples

Options file:
enablelanfree yes

Command line:
-enablelanfree=yes.

Encryptkey

The encryptkey option specifies whether to save the encryption key locally when performing a backup-archive operation or whether to prompt for the encryption key. The encryption key password is saved to the TSM.PWD file (UNIX, NetWare) or the Registry (Windows) in encrypted format. If you save the encrypted key password, you are not prompted for it each time you perform a backup, archive, or restore. Place this option in your client options file or client system options file (UNIX).

Note: The Web client saves the encryption key password in the TSM.PWD file (UNIX, NetWare) or the Registry (Windows). If there no key is saved, you are prompted for the initial encryption key password when you begin encryption processing.

For UNIX: Both Authorized Users and non-root users can encrypt or decrypt data during a backup or restore operation depending on the value you specify for the passwordaccess option.

Operation Passwordaccess Option Encryptkey Option Result
TSM Authorized Backup generate
generate
prompt
prompt
save
prompt
prompt
save
data encrypted
data encrypted
data encrypted
data not encrypted
TSM Authorized Restore prompt save prompted for encryptkey password and data decrypted
Non-Root User Backup generate
generate
prompt
prompt
prompt
save
prompt
save
data not encrypted
data encrypted
data not encrypted
data not encrypted
Non-Root User Restore generate
generate
prompt
prompt
prompt
save
prompt
save
menu to skip or proceed
data decrypted
menu to skip or proceed
menu to skip or proceed

Supported Clients

This option is for Windows, UNIX, and NetWare clients.

Syntax

              .-save---.
>>-ENCryptkey-+--------+---------------------------------------><
              '-prompt-'
 
 

Parameters

save
Specifies that you want to save the encryption key password to a local file TSM.PWD file (UNIX, NetWare) or the Registry (Windows) in encrypted format. When you specify save, Tivoli Storage Manager does not prompt for the password for each backup and restore operation. This is the default.

prompt
Specifies that you want to save the encryption key password to a local file. Tivoli Storage Manager prompts for the password for each backup and restore operation.

Examples

Options file:
encryptkey prompt

Command line:
-encryptkey=prompt

Errorlogname

Authorized User (UNIX requires access authority.)

The errorlogname option specifies the fully qualified path and file name of the file where you want to store information about errors that occur during processing. The value for this option overrides the DSM_LOG or DSM_DIR environment variables. The dsmwebcl.log and dsmsched.log files will be created in the same directory as dsmerror.log.

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

filespec
The fully qualified path and file name where you want to store error log information. Ensure that all directories and subdirectories in the path exist and are accessible by client processing. Tivoli Storage Manager will not create directories for you.

For Windows or UNIX: The default is the path indicated by the DSM_LOG or DSM_DIR environment variable. If DSM_LOG or DSM_DIR are not specified, the dsmerror.log file will reside in the current working 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 your current working directory.

For Macintosh: The default file name is 'TSM Error Log'; it is placed in your current working directory.

Examples

Options file:

errorlogname c:\temp\dsmerr.log (Windows)
errorlogname dmmock\sys:tmp\tsmerr.log (NetWare)
errorlogname /tmp/tsmerr.log (UNIX)

Preferences file:
errorlogname "SupDrive:tsm Error Log"

Command line:

-errorlog=c:\temp\dsmerr.log (Windows)
-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.

Errorlogretention

Authorized User (UNIX requires access authority.)

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 Tivoli Storage Manager 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

N  or  days
Specifies how long to wait before pruning the error log.

N
Do not prune the error log. This permits the error log to grow indefinitely. This is the default.

days
The number of days to keep log file entries before pruning the log. The range of values is zero through 9999.

D  or  S
Specifies whether to save the pruned entries. Enter a space or comma to separate this parameter from the previous one.

D
Discard the error log entries when you prune the log. This is the default.

S
Save the error log entries when you prune the log.

For Windows, 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

Options file:
errorlogretention 400 S

Preferences file:
errorlogretention 400 S

Command line:
-errorlogr=400,S (Windows or NetWare)

Does not apply. (UNIX)

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

Exclude Options

Authorized User (UNIX requires access authority.)

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.

For Windows, UNIX, and NetWare: You can exclude specific files from encryption processing during a backup.

For Windows: You can exclude remotely accessed files by specifying Universal Naming Convention (UNC) names in your exclude statement. See Tivoli Storage Manager for Windows Using the Backup-Archive Clients, SH26-4117, for examples of statements using UNC file names.

Notes:

  1. With the exception of exclude.fs, when you exclude a file that was previously included, existing backup versions become inactive during the next incremental backupWhen you exclude a file that was previously included, existing backup versions become inactive during the next incremental backup.

  2. For Windows: The exclude statements are not case sensitive.

  3. The server can define exclude options with the inclexcl option.

Exclude any system files or images that could corrupt the operating system when recovered. You should also exclude the client directory containing the client files.

Use wildcard characters to exclude a broad range of files. See "Including and Excluding Groups of Files" for a list of wildcard characters that you can use. Then, if necessary, use the include option to make exceptions.

To exclude an entire directory called any/test (NetWare or UNIX) or any\test (Windows), enter the following:

  exclude.dir c:\any\test     (Windows)
 
  exclude.dir /any/test     (UNIX)
  exclude.dir nw2:\sys:any/test     (NetWare)

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

  exclude.dir c:\any\test*     (Windows)
 
  exclude.dir /any/test*     (for UNIX)
  exclude.dir nw2:\sys:any/test*     (for NetWare)

For NetWare: Wildcards are not supported for the server name or volume name. If you do not specify a server name, Tivoli Storage Manager uses the local server name.

Compression Processing

If you want to exclude specific files or groups of files from compression processing during a backup or archive operation, consider the following:

Adaptive Subfile Backup Processing (Windows)

If you want to exclude files from adaptive subfile backup processing using the exclude.subfile option, consider the following:

Processing NAS File Systems

Use the exclude.fs.nas option to exclude file systems from Network Attached Storage (NAS) image backup processing.

A NAS file system specification uses the following conventions:

For example, to exclude the /vol/vol1 file system of a NAS node called netappsj, specify the following exclude statement:

exclude.fs.nas netappsj/vol/vol1

To exclude /vol/vol1 from backup services on all NAS nodes, specify the following exclude statement:

exclude.fs.nas /vol/vol1

Supported Clients

All clients can use this option.

Options File for UNIX Platforms

Place this option in an include-exclude options file or the client system options file (dsm.sys).

Syntax

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

exclude
Excludes files that match the pattern from backup services. When you back up files, any files you exclude with this option are not considered for backup.

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.

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

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

exclude.compression
Excludes files from compression processing if compression=yes is specified.

exclude.dir
Excludes a directory, its files, and all its subdirectories and their files from backup services. The exclude.dir option works only if the excluded directory is a subdirectory. Use this option to exclude a portion of your data in which no underlying files need to be backed up.

When you exclude a directory, you can still back up specific files within that directory using a selective backup. However, the next time you perform an incremental backup, these backup versions are expired. If you exclude a directory that was previously included, Tivoli Storage Manager marks existing backup versions inactive during next incremental.

exclude.encrypt
Excludes the specified files from encryption processing. This option is valid for Windows, UNIX, and NetWare clients.

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

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

exclude.fs
Excludes file spaces matching the pattern. The client does not consider the specified file space for processing and the usual deleted-file expiration process cannot occur. If you exclude a file space that was previously included, existing backup versions remain on the server subject to retention rules specified in the associated management class definition. This option is valid for UNIX clients only.

exclude.fs.nas
Excludes file systems on the NAS file server from an image backup when used with the backup nas command. If you do not specify a NAS node name, the file system identified applies to all NAS file servers. The backup nas command ignores all other exclude statements including exclude.fs and exclude.dir statements. This option is for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only.

exclude.image
Excludes mounted file systems and raw logical volumes that match the pattern from image processing. This option is valid for AIX, AIX 5L, HP-UX, and Solaris clients only.

exclude.subfile
Excludes files from adaptive subfile backup processing. This option is valid for all Windows clients.

Parameters

pattern
Specifies the file or group of files that you want to exclude from backup services. End the pattern with a file specification.
Note:
For NAS file systems: You must prefix the NAS node name to the file specification to specify the file server to which the exclude statement applies. If you do not specify a NAS node name, the file system identified refers to the NAS nodename specified in the client system option file dsm.sys (UNIX), client options file dsm.opt (Windows), or on the command line.
Note:
For NetWare: If you do not specify a server name, Tivoli Storage Manager uses the local server name.

If the pattern begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks.

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 this example does not conform with normal include-exclude wildcard processing for UNIX.

Examples

Options file:
(Windows)
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
exclude.encrypt c:\system32\mydocs\*
exclude.compression c:\test\file.txt
exclude.subfile c:\test\file.txt
exclude.fs.nas  netappsj/vol/vol0
(NetWare)
exclude servera\*:.../swapper.dat
exclude n1\*:io.sys
exclude tfr\*:.../spart.par
exclude nw2\sys:*/budget.fin
exclude nw6\sys:devel/*
exclude.archive servera*:/.../events.log
exclude.compression nw6\sys:devel/*
exclude.encrypt servera\*:.../gordon.dat
 
(UNIX)
exclude /unix/
exclude /.../core
exclude /home/jones/proj1/*
exclude.archive /.../core
exclude.backup /home/jones/proj1/devplan/
exclude.dir /home/jones/tmp
exclude.backup /users/home1/file1
exclude.image /usr/*/*
exclude.encrypt /users/home2/file1
exclude.compression /home/gordon/proj1/*
exclude.fs.nas	 netappsj/vol/vol0

Preferences file:
exclude "...:Desktop DB"
exclude ":Norton FileSaver Data"
exclude.archive "...:Desktop DF"

Command line:
Does not apply.

Followsymbolic

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

No
Specifies that you do not want to restore to symbolic links, or to use symbolic links as virtual mount points. This is the default.

Yes
Specifies that you want to restore to symbolic links, or to use a symbolic link as a virtual mount point.

Examples

Options file:
followsymbolic Yes

Command line:
-fol=Yes

Groups

Authorized User (UNIX requires access authority.)

The groups option specifies groups on your workstation that you want to authorize to request Tivoli Storage Manager 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 Tivoli Storage Manager services. If you use both the groups option and the users option, only users specified with these options can request Tivoli Storage Manager 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

groupname
Specifies the name of a group you want to authorize to request Tivoli Storage Manager services.

Examples

Options file:
groups  dsmcdev  group1  test1  test2  design1
groups  endicott almaden qadev qadev1 tools23

Command line:
Does not apply.

Guitreeviewafterbackup

The guitreeviewafterbackup option specifies whether the client returns to the Backup, Restore, Archive, or Retrieve window after a successful operation completes.

Supported Clients

This option is valid for Macintosh, UNIX, and Windows 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

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

Parameters

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

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

Examples

Options file:
guitreeviewafterbackup yes

Preferences file:
guitreeviewafterbackup yes

Command line:
Does not apply.

Httpport

Authorized User (UNIX requires access authority.)

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

Tivoli Storage Manager Firewall Support

The webports option enables the use of the Web client outside a firewall by specifying the TCP/IP port number used by the Tivoli Storage Manager Client Acceptor daemon and Web Client Agent service for communications with the Web GUI.

The ports you specify with the webports option and the client option httpport must be opened in the firewall.

To enable the backup-archive client, Command Line Admin client, and the Scheduler (running in polling mode) to run outside a firewall, the port specified by the server option tcpport (default 1500) must be opened in the firewall.

Note:
Tivoli Storage Manager does not support the scheduler running in prompted mode outside a firewall.

See Tcpport and Webports for more information.

Supported Clients

This option is valid on NetWare, all Windows clients, 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

port_address
Specifies the TCP/IP port address that is used to communicate with the Web client. The range of values is 1000 through 32767; the default is 1581.

Examples

Options file:

httpport 1502

Command line:
-httpport=1502  (Windows Windows 98, Windows Me, NetWare)
Does not apply  (UNIX)

Httpsport

Authorized User (UNIX requires access authority.)

The httpsport option specifies a TCP/IP port address for the HTTPS secure socket layer (SSL) interface to the Web client.

Supported Clients

This option is valid for AIX, AIX 5L, and all Windows clients.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-HTTPSport- port_address-------------------------------------><
 
 

Parameters

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

Examples

Options file:
httpsport 1548

Command line:
Does not apply (UNIX)
-httpsport (Windows 98, Me)

Inclexcl

Authorized User (UNIX requires access authority.)

The inclexcl option specifies the path and file name of an include-exclude options file.

Place the inclexcl option in the include-exclude list in your client options file, Preferences file (Macintosh), or client system options file (UNIX).

Multiple inclexcl statements are permitted. However, you must specify this option for each include-exclude file.

Ensure that you soter your include-exclude options file in a directory to which all users have read access. For UNIX: Ensure that your include-exclude options file is stored in a directory such as /etc.

When processing occurs, the include-exclude statements within the include-exclude file are placed in the list position occupied by the inclexcl option and processed accordingly.

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 or from space management only.

Considerations for Windows NT, 2000 Clients

For Windows NT and Windows 2000 clients, the include-exclude file can be in Unicode or non-Unicode format. If you specify a non-Unicode include-exclude file, the file name must be in the same code page as the one that the client is running.

A Unicode include-exclude file provides the following benefits:

To create an include-exclude file in Unicode format, perform the following steps:

  1. Open Notepad.
  2. List your include and exclude statements. See Table 7 for include-exclude options you can use. You may need to copy file names with characters from other code pages using Microsoft Windows Explorer.
  3. Click File and then click Save As. The Save As window is displayed.
  4. Select the Save as Unicode checkbox, specify the file and target directory, and save the file.
  5. Place an inclexcl option specifying the include-exclude file you just created in your client options file or client system options file (UNIX).

For more information about creating an include-exclude options file, see Chapter 7, "Creating an Include-Exclude List".

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

>>-INCLExcl- filespec------------------------------------------><
 
 

Parameters

filespec
Specifies the path and file name of one include-exclude options file.

Examples

Options file:
(UNIX)
inclexcl /usr/dsm/backup.excl
inclexcl /etc/inclexcl.def
(Windows)
inclexcl c:\dsm\backup.excl
 
(NetWare)
inclexcl servera\sys:dsm/backup.excl
 

Preferences file:
inclexcl La Pomme:Documents:backup.excl

Command line:
Does not apply.

Include Options

Authorized User (UNIX requires access authority)

The include options specify one of the following:

If you do not assign a specific management class to objects, Tivoli Storage Manager uses the default management class in the active policy set of your policy domain.

For Windows: You can include remotely accessed files by specifying Universal Naming Convention (UNC) names in your include statement. See Tivoli Storage Manager for Windows Using the Backup-Archive Clients, SH26-4117 for example statements using UNC file names.

Notes:

  1. An include option cannot override an exclude.dir option.
  2. For Windows: The include statements are not case sensitive.
  3. The server can also define these options with the inclexcl option.

Compression Processing

If you want to include specific files or groups of files for compression processing during a backup or archive operation, consider the following:

Adaptive Subfile Backup Processing (Windows)

If you want to include files for adaptive subfile backup processing using the include.subfile option, consider the following:

Processing NAS File Systems

Use the include.fs.nas option to bind a management class to Network Attached Storage (NAS) file systems for backup processing.

A NAS file system specification uses the following conventions:

For example, to assign a management class to the /vol/vol1 file system of a NAS node called netappsj, specify the following include statement:

include.fs.nas netappsj/vol/vol1 nasMgmtClass

See Chapter 7, "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-'
 
 

include
Includes files or assigns management classes for backup or archive processing.

include.archive
Includes files or assigns management classes for archive processing.

include.backup
Includes files or assigns management classes for backup processing.

include.compression
Includes files for compression processing if you specify compression=yes.

include.encrypt
Includes the specified files for encryption processing. By default, Tivoli Storage Manager does not perform encryption processing. This option is valid for Windows, UNIX, and NetWare clients.

include.file
Includes a file for backup services, or assigns a management class to a file.

include.fs.nas
Assigns a management class when used with the backup nas command. If you do not specify a NAS node name, the file system identified applies to all NAS file servers. The backup nas command ignores all other include statements. This option is for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only.

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. This option is valid for AIX, AIX 5L, HP-UX, and Solaris only.

include.subfile
Includes files for adaptive subfile backup processing. This option is valid for all Windows clients.

include.systemobject
Assigns management classes for backup of Windows 2000 system objects. By default, Tivoli Storage Manager binds all system objects to the default management class. You cannot use this option to bind individual systemobject components to a different management class. You cannot use this option to include or exclude a system object from processing. This option is valid for Windows 2000 only.
Note:
Other include-exclude statements do not affect system object processing. It is unnecessary to explicitly include the registry staging directory include c:\adsm.sys\...\* for back up, to ensure that the registry is backed up properly. If you accidently exclude a directory that is critical to a system object backup, the system object backup is not affected.

Parameters

pattern
Specifies the objects to include for backup services or to assign a specific management class. End this variable with a file specification.
Note:
For NAS file systems: You must prefix the NAS node name to the file specification to specify the file server to which the include statement applies. If you do not specify a NAS node name, the file system identified refers to the NAS node name specified in the client system option file dsm.sys (UNIX), client options file dsm.opt (Windows), or on the command line.

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.

For UNIX: For the include.image option, the pattern is the name of a mounted file system or raw logical volume. Because this option includes the entire named object and the files it contains from processing, you must use wildcards. For example, to include the /etc file system for image backup, enter the following:

   include.image /etc/*/*

Please note, that this example does not conform with normal include-exclude wildcard processing for UNIX.

Note: When using include.systemobject, the only valid pattern is ALL (all types of system objects). By default, Tivoli Storage Manager binds all system objects to the default management class.

mgmtclassname
Specifies the name of the management class to assign to the objects. If a management class is not specified, the default management class is used.

Examples

Options file:
(Windows)
include c:\proj\text\devel.*
include c:\proj\text\* textfiles
include ?:* managall
include.backup c:\win98\system\* mybackupclass
include.archive c:\win98\system\* myarchiveclass
include.encrypt c:\win98\proj\gordon\*
include.compress c:\test\file.txt
include.subfile c:\test\file.txt
include.fs.nas netappsj1/vol/vol0 homemgmtclass
 
 
(NetWare)
include servera\sys:proj/text/devel.*
include servera\sys:proj/text/* textfiles
include *:* managall
include.archive servera\sys:proj/text/* myarchiveclass
include.backup servera\sys:proj/text/* mybackupclass
include.compression servera\sys:proj/text/devel.*
include.encrypt serverb\sys:proj/gordon/*
 
(UNIX)
include /home/proj/text/devel.*
include /home/proj/text/* textfiles
include * managall
include.image /home/*/*
include.archive /home/proj/text/* myarchiveclass
include.backup /home/proj/text/* mybackupclass
include.compression /home/proj/text/devel.*
include.encrypt /home/proj/gordon/*
include.fs.nas netappsj/vol/vol0 homemgmtclass
 

Preferences file:
include "...:Data:Test:Test*"
include "...:System:...:*" mgmtcls1
include "...:*" managall
 

Command line:
Does not apply.

Incrthreshold

The incrthreshold option specifies the threshold value for the number of directories in any journaled file space that might have active objects on the server, but no equivalent object on the workstation.

When a Windows client deletes a file or directory with a long name, it sometimes reports this using a compressed name. After the object is deleted, the compressed name may be reused and the deletion notice may no longer identify a unique object. During a journaled incremental backup of a file space, this may result in the no active version response from the server resulting in an unsuccessful expire for an object.

The incrthreshold option allows you to specify what to do when this condition arises:

Place this option in your client options file (dsm.opt).

See Tivoli Storage Manager for Windows Using the Backup-Archive Clients, SH26-4117 for more information about journaled backups.

Supported Clients

This option is for Windows NT, 2000 clients only.

Syntax

>>-INCRTHreshold--numberdirectories----------------------------><
 
 

Parameters

numberdirectories
Specifies the threshold value for the number of directories in any journaled file space that may contain active files that should be expired. When this threshold is reached during a full file space journaled incremental, the client initiates an incremental backup on each such directory at the completion of the journaled backup. The range of values is 0 through 2,000,000,000; the default is 0.

Examples

Options file:
incrthreshold 1

Command line:
Does not apply

Ipxbuffersize

The ipxbuffersize option specifies the IPX buffer size needed to transfer data between the client node and the server. A larger buffer can improve communication performance, but uses more memory.

Supported Clients

This option is valid for the NetWare client only.

Syntax

>>-IPXBuffersize- size-----------------------------------------><
 
 

Parameters

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

Examples

Options file:
ipxb 8

Command line:
-ipxbuffersize=12

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

Ipxserveraddress

The ipxserveraddress option specifies the IPX/SPX address of a server on an AIX host that is not in the same network as the client node. If the IPX/SPX address is not specified, the server must be in the same network as the client node.

Supported Clients

This option is valid for the NetWare client only.

Syntax

>>-IPXSErveraddress- server_address----------------------------><
 
 

Parameters

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

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

Examples

Options file:
ipxse 0000000210005af6e7cc

Command line:
-ipxserveraddress=0000000210005af6e7cc

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

Ipxsocket

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

Supported Clients

This option is valid for the NetWare client only.

Syntax

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

Parameters

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

Examples

Options file:
ipxso 8524

Command line:
-ipxsocket=8524

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

Lanfreecommmethod

Authorized User (UNIX requires access authority.)

The lanfreecommmethod option specifies the communications protocol between the Tivoli Storage Manager client and Storage Agent. This enables processing between the client and the SAN-attached storage device.

For AIX, AIX 5L, and Solaris: Use the lanfreeshmport to specify the Shared Memory port number where the Storage Agent is listening. See Lanfreeshmport for more information

For Windows NT, 2000: Place this option in the client options file (dsm.opt).

Supported Clients

This option is valid for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris clients only.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-LANFREECommmethod- commmethod-------------------------------><
 
 

Parameters

commmethod
Specifies the supported protocol for your Tivoli Storage Manager client:

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

Use the lanfreetcpport to specify the TCP/IP port number where the Storage Agent is listening. See Lanfreetcpport for more information. For AIX, AIX 5L, and Solaris root users, the Shared Memory communication method is the default and TCP/IP is optional. AIX, AIX 5L, and Solaris non-root users can only use the TCP/IP communication method.

NAMedpipes
The interprocess communication method that permits message data streams to pass between a client and a server. This is the default for Windows NT, 2000.

SHAREdmem
For AIX, AIX 5L, and Solaris clients only: Use the Shared Memory communication method when the client and server are running on the same system. Shared Memory provides better performance than the TCP/IP protocol. This is the default communication method for AIX, AIX 5L, and Solaris root users. When specifying this communications method on AIX, the backup-archive client user must be logged in as root or have the same user ID as the process running the Storage Agent. AIX, AIX 5L, and Solaris non-root users must use the default TCP/IP communication method and cannot use the Shared Memory communication method. See Commmethod for logon restrictions when using this communication method.

Examples

Options file:
lanfreec tcp

Command line:
-lanfreec=tcp

Lanfreeshmport

Authorized User (UNIX requires access authority.)

The lanfreeshmport option specifies the Shared Memory port number where the Tivoli Storage Manager Storage Agent is listening.

Use this option when lanfreecommmethod=SHAREdmem is specified for communication between the Tivoli Storage Manager client and Storage Agent. This enables processing between the client and the SAN-attached storage device.

See Lanfreecommmethod for more information about the lanfreecommmethod option.

Supported Clients

This option is valid for AIX, AIX 5L, and Solaris clients only.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-LANFREEShmport- port_address--------------------------------><
 
 

Parameters

port_address
Specifies the Shared Memory port number where the Storage Agent is listening. The range of values is 1000 through 32767; the default is 1510.

Examples

Options file:
lanfrees 1520

Command line:
-lanfrees=1520

Lanfreetcpport

Authorized User (UNIX requires access authority.)

The lanfreetcpport option specifies the TCP/IP port number where the Tivoli Storage Manager Storage Agent is listening.

Use this option when you specify lanfreecommmethod=TCPip for communication between the Tivoli Storage Manager client and Storage Agent.

For Windows NT, 2000: Place this option in the client options file (dsm.opt).

See Lanfreecommmethod for more information about the lanfreecommmethod option.

Supported Clients

This option is valid for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris clients only.

Options File for UNIX Platforms

For AIX, AIX 5L, and Solaris clients: Place this option in the client system options file (dsm.sys).

Syntax

>>-LANFREETCPport- port_address--------------------------------><
 
 

Parameters

port_address
Specifies the TCP/IP port number where the Storage Agent is listening. The range of values is 1000 through 32767; the default is 1500.

Examples

Options file:
lanfreetcp 1520

Command line:
-lanfreetcp=1520

Language

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.

The Tivoli Storage Manager client automatically detects the language of the system locale and displays Tivoli Storage Manager for that language. For example, a supported operating system will display Tivoli Storage Manager in French by default, without specifying the language option. If Tivoli Storage Manager cannot load the French message catalog, it will default to the American English language pack. For example, if the client is running on an unsupported locale/language combination, such as French/Canada or Spanish/Mexico, Tivoli Storage Manager defaults to American English. You can override the default language by specifying the language option.

Note:
The language option does not affect the Web client. The Web client displays in the language associated with the locale of the browser. If the browser is running in a locale that Tivoli Storage Manager does not support, the Web client displays in American English.

Supported Clients

This option is valid for Macintosh, NetWare, and Windows clients.

Syntax

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

Parameters

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

Examples

Options file:
language ameng

Preferences file:
language ameng

Command line:
Does not apply.

Largecommbuffers

Authorized User (UNIX requires access authority.)

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

No
Specifies that increased buffers are not used to transfer large amounts of data to the server. This is the default. For AIX and AIX 5L, the default is Yes.

Yes
Specifies that increased buffers are used to transfer large amounts of data to the server. This is the default for AIX and AIX 5L only.

Examples

Options file:
largecommbuffers yes

Preferences file:
largecommbuffers yes

Command line:
Does not apply.

Localbackupset

The localbackupset option specifies whether the Tivoli Storage Manager GUI bypasses initial logon with the Tivoli Storage Manager server to restore a local backup set on a standalone workstation. You can use this option on the command line or place it your client options file (dsm.opt).

If you specify localbackupset=yes, the GUI does not attempt initial logon with the server. In this case, the GUI only enables the restore functionality.

If you specify localbackupset=no (the default), the GUI attempts initial logon with the server and enables all GUI functions.

To start the GUI and bypass the initial logon with the server to restore a local backup set on a standalone workstation, enter:

   dsm -localbackupset=yes

Supported Clients

This option is valid for Windows and UNIX clients only.

Options File for UNIX Platforms

Place this option in the client user options file (dsm.opt) or the client system options file (dsm.sys) .

Syntax

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

Parameters

No
Specifies that the GUI attempts initial logon with the server and enables all functions. This is the default.

Yes
Specifies that the GUI does not attempt initial logon with the server and enables only the restore functionality.

Examples

Options file:
localbackupset yes

Command line:
dsm -localbackupset=yes

Mailprog

Authorized User (UNIX requires access authority.)

The mailprog option specifies the program and user ID to which you want to send a newly-generated password when the old password expires. Use this option only when you select generate with the passwordaccess option.

Supported Clients

This option is for the UNIX clients only.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-MAILprog filespec userid------------------------------------><
 
 

Parameters

filespec
Specifies the path and file name of the program to which you want to send a newly-generated password. The program you specify must accept standard output.

userid
Specifies the user ID of the user to whom you want to send a newly-generated password. For OS/390 UNIX System Services, enter the user ID in uppercase letters.

Examples

Options file:
mailprog /usr/bin/xsend root (for AIX, AIX 5L)
mailprog /bin/mailx USER1 (for OS/390 UNIX System Services)
Note:
Run the enroll command before you use xsend.

Command line:
Does not apply.

Managedservices

Authorized User (UNIX requires access authority.)

The managedservices option specifies whether the Tivoli Storage Manager Client Acceptor daemon (CAD) manages the scheduler, the Web client, or both.

For instructions to set up the CAD to manage the scheduler, see the following sections:

The CAD serves as an external timer for the scheduler. When the scheduler is started, it queries the server for the next scheduled event. The event is either executed immediately or the scheduler exits. The CAD restarts the scheduler when it is time to execute the scheduled event.

Notes:

  1. If you specify the schedmode=prompt option, the server prompts the CAD when it is time to run the schedule. The scheduler will connect and disconnect to the server when the CAD is first started.
  2. Specify passwordaccess=generate in your client options file or client system options file, so that Tivoli Storage Manager generates your password automatically. See Passwordaccess for more information.
  3. The CAD console displays information about the next scheduled event.

Using the managedservices option can provide the following benefits:

Place this option in the client options file (dsm.opt).

Supported Clients

This option is valid for Windows, UNIX, and NetWare clients.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-MANAGEDServices--+----------+-------------------------------><
                    | .- ----. |
                    | V      | |
                    '---mode-+-'
 
 

Parameters

mode
Specifies whether the CAD manages the scheduler, the Web client, or both.

webclient
Specifies that the CAD manages the Web client. This is the default.

schedule
Specifies that the CAD manages the scheduler.

Examples

Options file:
The following are examples of how you might specify the managedservices option in your options file.

Task
Specify that the CAD manages the Web client only.
   managedservices webclient

Task
Specify that the CAD manages the scheduler only.
   managedservices schedule

Task
Specify that the CAD manages both the Web client and the scheduler.
   managedservices schedule webclient
Note:
The order in which these values are specified is not important.

Command line:
Does not apply.

Matchallchar

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

character
Specifies a character to use as a match-all wildcard character. The default is an asterisk (*). You can use any valid ASCII character for the matchallchar option except Control+X or Control+Y. Do not use the same character for both the matchallchar and the matchonechar option.

Examples

Preferences file:
matchallchar @

Matchonechar

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

character
Specifies a character to use as a match-one wildcard character. The default is a question mark (?). You can use any valid ASCII character for the matchonechar option, except Control+X or Control+Y. Do not use the same character for both the matchallchar and the matchonechar option.

Examples

Preferences file:
matchonechar #

Maxcmdretries

Authorized User (UNIX requires access authority.)

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. Use this option 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.

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

maxcmdretries
Specifies the number of times the client scheduler can attempt to process a scheduled command that fails. The range of values is zero through 9999; the default is 2.

Examples

Options file:
maxcmdr 4

Preferences file:
maxcmdr 4

Command line:
-maxcmdretries=3 (Windows or NetWare)

Does not apply. (UNIX)

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

Memoryefficientbackup

The memoryefficientbackup option specifies a memory conserving algorithm for processing incremental backups, that backs up one directory at a time, using less memory. Use this option with the incremental command when your workstation is memory constrained.

Note:
The server can also define this option.

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

No
Your client node uses the faster, more memory-intensive method when processing incremental backups. For UNIX, NetWare, and all Windows clients: This is the default.

Yes
Your client node uses the method that requires less memory when processing incremental backups. For Macintosh: This is the default.

Examples

Options file:
memoryefficientbackup yes

Preferences file:
memoryefficientbackup yes

Command line:
-memoryef=no

Namedpipename

The namedpipename option specifies the name of a named pipe to use for communications between a client and a server on the same Windows server domain.

Supported Clients

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

Syntax

>>-NAMedpipename- name-----------------------------------------><
 
 

Parameters

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

Examples

Options file:
namedpipename \pipe\dsmser1

Command line:
-namedpipename=\pipe\dsmser1

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

Nasnodename

The nasnodename option specifies the node name for the NAS file server when processing NAS file systems. The node name identifies the NAS file server to the Tivoli Storage Manager server. The server must register the NAS file server.

You can specify this option on the command line or in the client system option file dsm.sys (UNIX) or client options file dsm.opt (Windows).

You can override the default value in the dsm.sys (UNIX) or dsm.opt (Windows) file by entering a different value on the command line. If you do not specify the nasnodename option in the dsm.sys (UNIX) or dsm.opt (Windows) file, you must specify this option on the command line when processing NAS file systems.

The nasnodename option is valid for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only

Options File for UNIX Platforms

This option can be specified on the command line or in the client system options file (dsm.sys).

Syntax

>>-NASNodename- nodename---------------------------------------><
 
 

Parameters

nodename
Specifies the node name for the NAS file server.

Examples

Options file:
nasnodename nas2

Command line:
-nasnodename=nas2

Nfstimeout

The nfstimeout option specifies the number of seconds the server waits for a status system call on an NFS file system before it times out.

You can use this option to mitigate the default behavior of status calls on NFS file systems. For example, if an NFS file system 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 operation can continue.

Note:
The server can also define this option.

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

number
Specifies the number of seconds the server waits for a status system call on an NFS file system before timing out. The default is 0 seconds.

Examples

Options file:
nfstimeout 10

Command line:
-nfstimeout=10

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

Nodename

Authorized User (UNIX requires access authority.)

The nodename option identifies your workstation to the server. You can use different node names to identify multiple operating systems on your workstation.

When you use the nodename option, Tivoli Storage Manager prompts for the password assigned to the node you specify, if a password is required.

If you want to restore or retrieve files from the server while you are working from a different workstation, use the virtualnodename option. See Virtualnodename for more information.

If you are working from a different workstation, you can use the nodename option only if you specify passwordaccess=prompt.

For Macintosh: If you do not specify this option in the Preferences file, Tivoli Storage Manager prompts you for the node name when it starts.

For Windows: The node 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

nodename
Specifies a 1 to 64 character node name for which you want to request Tivoli Storage Manager services. For UNIX, Macintosh, or NetWare: The default is the name of the workstation.

For Windows: The default is the name of the workstation unless clusternode=yes. Then, the default is the cluster name.

For all clients except UNIX: Permit the node name to default to the workstation name.

Examples

Options file:
nodename cougar

Preferences file:
nodename cougar

Command line:
-nod=banshee (Windows or NetWare)

Does not apply. (UNIX)

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

Numberformat

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

For all clients except UNIX: Use this option if you want to change the default number format for the language of the message repository you are using.

The AIX, AIX 5L, 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.

Note:
This numberformat option does not affect the Web client. The Web client uses the number format for the locale that the browser is running in. If the browser is not running in a supported locale, the Web client uses the number format for American English.

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

number
Displays numbers using any one of the following formats. Specify the number (1-6) that corresponds to the number format you want to use.

1
1,000.00 (This is the default)

2
1,000,00

3
1 000,00

4
1 000.00

5
1.000,00

6
1'000,00

For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: 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.

decimal_point
The character that separates the whole number from its fractional part.
thousands_sep
The character that separates the hundreds from the thousands from the millions.
grouping
The number of digits in each group that is separated by the thousands_sep character.

Examples

Options file:
num 4

Preferences file:
num 4

Command line:
-numberformat=4

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

Nwignorecompressbit

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

Supported Clients

This option is valid for the NetWare client only.

Syntax

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

Parameters

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

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

Examples

Options file:
nwignorecompressbit yes

Command line:
Does not apply.

Nwpwfile

The nwpwfile option encrypts the user ID and password for a local or remote NetWare server. Tivoli Storage Manager saves the encrypted user ID and password in the TSM.PWD file.

Supported Clients

This option is valid for the NetWare client only.

Syntax

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

Parameters

Yes
Encrypts the user ID and password the first time a command is sent for a local or remote NetWare server. The encrypted information is stored in the TSM.PWD file. When you enter subsequent commands for that server, the password information is obtained from this file instead of sending a prompt. This is the default.

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

Examples

Options file:
nwpwf yes

Command line:
-nwpwfile=no

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

Nwuser

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

When logging into a NetWare server from Tivoli Storage Manager, 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. Tivoli Storage Manager rejects the typeless name:

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

Supported Clients

This option is valid for the NetWare client only.

Syntax

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

Parameters

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

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

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

Examples

Options file:
nwus servera\supervisor:secret

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

Command line:
-nwuser=serverb\mary:secret1

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

Nwwaitonerror

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

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

Supported Clients

This option is valid for the NetWare client only.

Syntax

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

Parameters

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

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

Examples

Options file:
nww yes

Command line:
Does not apply.

Optfile

The optfile option specifies the client options file you want to use when you start a Tivoli Storage Manager session.

Supported Clients

This option is valid for NetWare, UNIX, and all Windows clients.

Syntax

>>-OPTFILE- file_name------------------------------------------><
 
 

Parameters

file_name
Specifies an alternate client options file, if you use the fully qualified path name. If you specify only the file name, Tivoli Storage Manager assumes you want the current directory. The default is dsm.opt.

Examples

Options file:
Does not apply.

Command line:
   dsmc query session -optfile= myopts.opt (Windows 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.

Partnerluname

The partnerluname option specifies a logical unit name that the transaction program uses to identify the server in the SNA network. The partner logical unit name is used if the symbolic destination name is not provided for SNA LU6.2 communications. If you use this option, also define the cpicmodename and tpname options.

Supported Clients

This option is valid for the NetWare client only.

Syntax

>>-PARtnerluname- logical_unit_name----------------------------><
 
 

Parameters

logical_unit_name
Specifies a one to eight character logical unit name followed by a period (.), and one to eight characters that identify the remote target in an SNA network. For example:
   partnerluname nameone.nametwo

Contact your system administrator for this name. There is no default.

Examples

Options file:
partnerlu sanjose.vm

Command line:
-par=sanjose.vm

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

Password

The password option specifies a Tivoli Storage Manager password. If you do not specify this option and your administrator has set authentication to On, you are prompted for a password when you start a Tivoli Storage Manager session.

Note:
If the server prompts for a password, the password does not display as you enter it. However, if you use the password option on the command line, your password will display as 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

password
Specifies a 1 to 64 character password. A password is not case-sensitive. Valid characters include:
Characters
Description
A-Z
Any letter, A through Z, uppercase or lowercase
0-9
Any number, 0 through 9
+
Plus
.
Period
_
Underscore
-
Hyphen
&
Ampersand

Examples

Options file:
password secretword

Preferences file:
password secretword

Command line:
-password=secretword

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

Passwordaccess

Authorized User (UNIX requires access authority.)

The passwordaccess option specifies whether you want to generate your password automatically or set as a user prompt. Your administrator can require a password for your client node by enabling the authentication feature. Ask your administrator if a password is required for your client node.

If a password is required, you can choose to:

For all clients except Windows: Use the passworddir option in your client system options file (UNIX), Preferences file (Macintosh), or client options file to specify the directory location in which to store the encrypted password file. The default directory location depends on how the client was installed.

When the passwordaccess option is set to generate and you specify the password option, the password option is ignored.

Set the passwordaccess option to generate in the following situations:

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

prompt
You are prompted for your workstation password each time a client connects to the server. This is the default.

For all clients except Macintosh: To keep your client node password secure, enter commands without the password and wait for Tivoli Storage Manager to prompt you for the password.

For UNIX: Each user must know the Tivoli Storage Manager 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.

generate
Encrypts and stores your password locally and generates a new password when the old password expires. An encrypted password is kept on your workstation when a session starts.

A password prompt displays when registering a workstation with a server using open registration or if your administrator changes your password manually.

For UNIX: You can use the mailprog option to specify the program and user ID where you want to send the new password each time the old password expires.

For UNIX: When logging in locally, users do not need to know the Tivoli Storage Manager password for the client node. However, by using the nodename option at a remote node, users can access files they own and files to which another user grants access. 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, Tivoli Storage Manager prompts the users for the client node password. 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

Options file:
passwordaccess generate

Preferences file:
passwordaccess generate

Command line:
Does not apply.

Passworddir

Authorized User (UNIX requires access authority.)

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, and UNIX.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-PASSWORDDIR- directoryname----------------------------------><
 
 

Parameters

directoryname
Specifies the path in which to store the encrypted password file. The name of the password file is TSM.PWD. If any part of the specified path does not exist, Tivoli Storage Manager attempts to create it.

For UNIX: The default directory for AIX and AIX 5L is /etc/security/adsm and for other UNIX platforms it is /etc/adsm.

Examples

Options file:
passworddir /etc/security/tsm    (UNIX)
passworddir dmmock\sys:security\tsm    (NetWare)

Preferences file:
passworddir "SecDrive:tsm Security"

Command line:
Does not apply.

Postschedulecmd/Postnschedulecmd

Authorized User (UNIX requires access authority.)

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

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

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

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

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

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 Tivoli Storage Manager folder. Otherwise, the command string should contain the full path of the file, such as:

   "La Pomme:Scripting:Database Script"

Examples

Options file:
postschedulecmd "restart database"

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

Preferences file:
postschedulecmd "restart database"

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

Command line:
Does not apply.

Preschedulecmd/Prenschedulecmd

Authorized User (UNIX requires access authority.)

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

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

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

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

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

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 Tivoli Storage Manager folder. Otherwise, the command string should contain the full path of the file, such as:

   "La Pomme:Scripting:Database Script"

Examples

Options file:
preschedulecmd "<insert your database product's quiesce command here> database"

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

Preferences file:
preschedulecmd "quiesce database"

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

Command line:
Does not apply.

Processorutilization

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

Supported Clients

This option is valid for the NetWare client only.

Syntax

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

Parameters

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

Examples

Options file:
processor 2

Command line:
-processorutilization=10

Queryschedperiod

Authorized User (UNIX requires access authority.)

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:
The server can also define this option.

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

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

Examples

Options file:
querysch 6

Preferences file:
querysch 6

Command line:
-queryschedperiod=8

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

Quiet

The quiet option limits the number of messages that display on your screen during processing. For all clients except Macintosh: For example, when you run the incremental, selective, or archive commands, information may appear about each file that is backed up. Use the quiet option if you do not want to display this information.

When you use the quiet option, error and processing information appears on your screen, and messages are written to log files. If you do not specify quiet, the default option, verbose is used.

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

Note:
The server can also define the quiet option and override 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-------------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Options file:
quiet

Preferences file:
quiet

Command line:
-quiet

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

Replace

The replace option specifies what you want the system to do when it restores files that already exist on your workstation. This option applies to the restore, retrieve, and restore backupset commands only.

Supported Clients

This option is valid for NetWare, UNIX, and 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

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

All
All existing files are overwritten, including read-only files. On Windows NT and 2000 workstations, all locked files are replaced when the system is rebooted. If access to a file is denied, you are prompted to skip or overwrite the file. No action is taken on the file until there is a response to the prompt.

Yes
Any existing files are overwritten, except read-only files. If a file is read-only, you are prompted to overwrite the file or skip it. No action is taken on the file until there is a response to the prompt. If access to a file is denied, the file is skipped.

No
Existing files are not overwritten. No prompts will display.
Note:
On Windows NT and 2000 workstations, you can choose to replace locked files when the system is rebooted. Tivoli Storage Manager cannot perform an in-place restore of active files. However, it will stage restored versions of active files for replacement during the next reboot, except files containing named streams, sparse files, and directories. You can only restore these files if they are unlocked.

Examples

Options file:
replace all

Command line:
-replace=no

Resourceutilization

Authorized User (UNIX requires access authority.)

The resourceutilization option regulates the level of resources the Tivoli Storage Manager server and client can use during processing.

When you request a backup or archive, the client can use more than one session to the server. The default is to use a maximum of two sessions; one to query the server and one to send file data. The client can use only one server session if you specify a resourceutilization setting of 1. For UNIX: The client is also restricted to a single session if a user who is not authorized invokes a UNIX client with passwordaccess=generate specified.

A client can use more than the default number of sessions when connecting to a server that is Version 3.7 or higher. For example, resourceutilization=10 permits up to eight sessions with the server. Multiple sessions may be used for querying the server and sending file data.

Multiple query sessions are used when multiple file specifications are used with a backup or archive command. For example, if you enter:

inc filespaceA filespaceB

and you specified resourceutilization=5, the client may start a second session to query files on file space B. Whether or not the second session starts depends on how long it takes to query the server about files backed up on file space A. The client may also try to read data from the file system and send it to the server on multiple sessions.

The following factors can affect the throughput of multiple sessions:

Potentially undesirable aspects of running multiple sessions include:

Note:
The server can also define this option.

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

number
Specifies the level of resources the Tivoli Storage Manager server and client can use during processing. The range of values that you can specify is 1 through 10.

Examples

Options file:
resourceutilization 7

Preferences file:
resourceutilization 7

Command line:
Does not apply

Retryperiod

Authorized User (UNIX requires access authority.)

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. Use this option 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 in your client options or Preferences file after your client node successfully contacts 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

minutes
Specifies the number of minutes the client scheduler waits between attempts to contact the server, or to process a scheduled command that fails. The range of values is 1 through 9999; the default is 20.

Examples

Options file:
retryp 10

Preferences file:
retryp 10

Command line:
-retryperiod=15 (Windows or NetWare)
Does not apply. (UNIX)

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

Revokeremoteaccess

The revokeremoteaccess option restricts an administrator with client access privilege from accessing a client workstation that is running the Web client. This option does not restrict administrators with client owner, system, or policy privilege from accessing your workstation through the Web client.

Supported Clients

This option is valid for the NetWare, Windows, and 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

None
Does not revoke access to administrators who have client access authority for the client. This is the default.

Access
Revokes access to administrators who have client access authority for the client.

Examples

Options file:
revokeremoteaccess none

Command line:
Does not apply

Runasservice

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

Note:
The server can also define this option.

Supported Clients

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

Syntax

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

Parameters

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

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

Examples

Options file:
runasservice yes

Command line:
-runasservice=yes

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

Schedcmddisabled

Authorized User (UNIX requires access authority.)

The schedcmddisabled option specifies whether to disable the scheduling of commands by the server action=command option on the define schedule server command.

This option does not disable the preschedulecmd and postschedulecmd commands. However, you can specify preschedulecmd or postschedulecmd with a blank or a null string to disable the scheduling of these commands and the commands scheduled by the server using the action=command option on the define schedule server command.

Use the query schedule command to query the schedules defined by your administrator.

For Windows, NetWare, and Macintosh: Place this option in your client options file or Preferences file (Macintosh).

Note:
The server can also define this option.

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--.
>>-SCHEDCMDDisabled-+-----+------------------------------------><
                    '-Yes-'
 
 

Parameters

Yes
Specifies that Tivoli Storage Manager disables the scheduling of commands by the server using the action=command option on the define schedule server command.

No
Specifies that Tivoli Storage Manager does not disable the scheduling of commands by the server using the action=command option on the define schedule server command. This is the default.

Examples

Options file:
schedcmddisabled no

Preferences file:
schedcmddisabled no

Command line:
Does not apply.

Schedcompleteaction

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 valid for the Macintosh client only.

Syntax

>>-SCHEDCOMpleteaction--+- Quit-----+--------------------------><
                        '- SHUTdown-'
 
 

Parameters

Quit
The scheduler application quits when a schedule completes.

SHUTdown
Shuts down your workstation when a schedule completes. If there are other applications opened with unsaved data, these applications might prompt the user to save the data. This can prevent the workstation from shutting down until the prompt is dismissed.

Examples

 

Preferences file:
schedcompleteaction shutdown

Schedlogname

Authorized User (UNIX requires access authority.)

The schedlogname option specifies the path and file name where you want to store schedule log information. Use this option only when the scheduler is running.

For Windows, NetWare, and UNIX: When you run the schedule command, output from scheduled commands display on your screen. Output is also sent to the file you specify with this option.

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

>>-SCHEDLOGName- filespec--------------------------------------><
 
 

Parameters

filespec
Specifies the path and file name where you want to store schedule log information when processing scheduled work.

For Windows, NetWare, and 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 Tivoli Storage Manager application folder and a file name of TSM Schedule Log.

Examples

Options file:
schedlogname c:\mydir\schedlog.jan (Windows)
schedlogname dmmock\sys:mydir/schedlog.jan (NetWare)
schedlogname /home/mydir/schedlog.jan (UNIX)

Preferences file:
schedlogn "SupDrive:David Sched Log"

Command line:
-schedlogn=c:\mydir\schedlog.jan (Windows)
-schedlogn=dmmock\sys:mydir/schedlog.jan (NetWare)
Does not apply. (UNIX)

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

Schedlogretention

Authorized User (UNIX requires access authority.)

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

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

                      .-N----.  .-D-.
>>-SCHEDLOGRetention--+------+--+---+--------------------------><
                      '-days-'  '-S-'
 
 

Parameters

N  or  days
Specifies how long to wait before pruning the schedule log.

N
Do not prune the log. This permits the log to grow indefinitely. This is the default.

days
Specifies the number of days to keep log file entries before pruning. The range of values is zero through 9999.

D  or  S
Specifies whether to save the pruned entries. Use a space or comma to separate this parameter from the previous one.

D
Discards the log entries when pruning the log. This is the default.

S
Saves the log entries when pruning the log.

For Windows, 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: Tivoli Storage Manager copies the entries pruned from the log to TSM Sched Pruned Log.

Examples

Options file:
schedlogretention 30 S

Preferences file:
schedlogretention 30 S

Command line:
-schedlogretention=30,S (Windows or NetWare)
Does not apply. (UNIX)

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

Schedmode

Authorized User (UNIX requires access authority.)

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.

Note:
This option applies only if you are using the TCP/IP communication method, and the scheduler command is running.

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 you specify the prompted mode, you must 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.

Notes:

  1. Tivoli Storage Manager does not support the scheduler running in prompted mode outside a firewall.

  2. The server can also be define this option.

Supported Clients

This option is valid for the NetWare, Windows, and UNIX clients.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

             .-POlling--.
>>-SCHEDMODe-+----------+--------------------------------------><
             '-PRompted-'
 
 

Parameters

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

PRompted
The client scheduler waits for the server to contact your client node when scheduled work needs to be done.

Examples

Options file:
schedmode prompted

Command line:
-schedmod=po

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

Scrolllines

The scrolllines option specifies the number of lines of information that display on your screen at one time. Use this option when you set the scrollprompt option to Yes and you use commands.

Note:
The server can also define this option.

Supported Clients

This option is valid for the NetWare, Windows, and UNIX clients.

Options File for UNIX Platforms

Place this option in the client options file (dsm.opt).

Syntax

>>-SCROLLLines- number-----------------------------------------><
 
 

Parameters

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

Examples

Options file:
scrolllines 25

Command line:
-scrolll=25

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

Scrollprompt

The scrollprompt option specifies whether you want Tivoli Storage Manager 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:
The server can also define this option.

Supported Clients

This option is valid for the NetWare, Windows, and UNIX clients.

Options File for UNIX Platforms

Place this option in the client options file (dsm.opt).

Syntax

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

Parameters

No
Scrolls to the end of the list and stops. This is the default.

Yes
Stops and waits after displaying the number of lines you specified with the scrolllines option. The following prompt displays at the bottom of the screen:
Press 'Q' to quit, 'C' to continuous scroll, or 'Enter' to 
continue.

Examples

Options file:
scrollprompt yes

Command line:
-scrollp=yes

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

Servername

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                SHAREdmem
     shmport                   1520
     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

servername
In your client system options file (dsm.sys), specify the name you want to assign to a particular server. In your client options file (dsm.opt) or on the command line, specify the name of the server you want to contact for backup-archive services. A server name is not case sensitive; it can have up to 64 characters.

Examples

Options file:
servername server_a

Command line:
-se=server_b

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

Shmport

Authorized User (UNIX requires access authority.)

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 options file must match the value specified for shmport in the server options file.

Supported Clients

This option is valid for AIX, AIX 5L, HP-UX, 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

port_address
Specifies the TCP/IP address that the server is listening on to establish a shared memory connection. The range of values is 1000 through 32767; the default is 1510.

Examples

Options file:
shmport 1520

Command line:
Does not apply.

Skipntpermissions

The skipntpermissions option bypasses processing of NTFS security information on Windows NT and Windows 2000 clients only. Select this option for incremental backups, selective backups, or restores. Use this option with the following commands:

Supported Clients

This option is valid for Windows NT, 2000 clients only.

Syntax

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

Parameters

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

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

Examples

Options file:
skipntp yes

Command line:
-skipntp=yes

Skipntsecuritycrc

The skipntsecuritycrc option controls the computation of the security cyclic redundancy check (CRC) for a comparison of NTFS security information during an incremental or selective backup archive, restore, or retrieve operation. If skipntsecuritycrc no (the default) is used, performance might be slower because the program must retrieve all the security descriptors.

Use this option with the following commands:

Supported Clients

This option is valid for Windows NT, 2000 clients only.

Syntax

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

Parameters

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

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

Examples

Options file:
skipnts no

Command line:
-skipnts=no

Subdir

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

archive
delete archive
incremental (if the file specification is not a domain)
query archive
query backup
query backupset
restore
restore backupset
retrieve
selective

Place this option in your client options file (dsm.opt).

Note:
The server can also define this option.

Supported Clients

This option is valid for the NetWare, Windows, and UNIX clients.

Options File for UNIX Platforms

Place this option in your client options file (dsm.opt).

Syntax

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

Parameters

No
Subdirectories are not processed. This is the default.

Yes
Subdirectories are processed. Because the client program searches all subdirectories of a directory that is being processed, processing can take longer to complete. Specify Yes only when necessary.
Note:
If you use the preservepath option in addition to subdir=yes, it can affect which subdirectories are processed. .

If a subdirectory is a mounted file system, it will not process even if you specfify subdir=yes.

Examples

Options file:
subdir no

Command line:

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

Subfilebackup

The subfilebackup option specifies whether to enable adaptive subfile backup.

Note:
The server can also define this option.

Supported Clients

This option is valid for all Windows clients.

Syntax

                 .-no--.
>>-SUBFILEBackup-+-----+---------------------------------------><
                 '-yes-'
 
 

Parameters

No
Specifies that Tivoli Storage Manager does not use adaptive subfile backup. This is the default.

Yes
Specifies that Tivoli Storage Manager uses adaptive subfile backup.

Examples

Options file:
subfileb yes

Command line:
-subfileb=yes

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

Subfilecachepath

The subfilecachepath option specifies the path where the client cache resides for adaptive subfile backup processing. If you do not specify a path, Tivoli Storage Manager creates a path called \cache under the directory where the Tivoli Storage Manager executables reside.

All directories and subdirectories in the pathname you specify with the subfilecachepath option must exist. For example, if you specify c:\temp\cache, c:\temp must already exist.

Notes:

  1. The server can also define this option.
  2. You should exclude the subfilecache directory from backup.

Supported Clients

This option is valid for all Windows clients.

Syntax

>>-SUBFILECACHEPath- path_name---------------------------------><
 
 

Parameters

path_name
Specifies the path name where the client cache resides for adaptive subfile backup processing.

Examples

Options file:
subfilecachep c:\temp\cc_tsm

Command line:
-subfilecachep=c:\temp\cc_tsm

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

Subfilecachesize

The subfilecachesize option specifies the client cache size for adaptive subfile backup. If the cache size is too small, base files for some files will not be cached and subfile processing will not apply for them. However, setting the value too large can take up more disk space than can be spared. The files maintained in the cache should closely reflect the files used on a regular basis.

Note:
The server can also define this option.

Supported Clients

This option is valid for all Windows clients.

Syntax

>>-SUBFILECACHESize- size--------------------------------------><
 
 

Parameters

size
Specifies the size, in megabytes, of the client cache for adaptive subfile backup processing. The range is 1 through 1024 (1 GB); the default is 10.

Examples

Options file:
subfilecaches 10

Command line:
-subfilecaches=10

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

Symbolicdestination

The symbolicdestination option specifies a symbolic server name that indexes SNA routing and security parameters stored in communication directory files. Contact your administrator for the correct name.

When a symbolic destination is used with the SNA LU6.2 communication protocol, you do not need to specify the tpname, partnerluname, or cpicmodename options.

This option is required if your communication protocol is SNA LU6.2 and a transaction program name or partner logical unit name is not provided.

Supported Clients

This option is valid for the NetWare client only.

Syntax

>>-SYMbolicdestination- sym_dest_name--------------------------><
 
 

Parameters

sym_dest_name
Specifies a one to eight character symbolic destination name for the server. Contact your administrator for this name. There is no default.

Examples

Options file:
symbolicdestination tsm

Command line:
-sym=anrserv

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

Tapeprompt

The tapeprompt option specifies whether you want to wait for a tape to mount if it is required for a backup, archive, restore, or retrieve process, or to be prompted for a choice.

Tape prompting does not occur during a scheduled operation regardless of the setting for the tapeprompt option.

The tapeprompt option can be used with the following commands:

archive
incremental
restore
retrieve
selective
Note:
The server can also define this option.

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

No
You are not prompted for your choice. The server waits for the appropriate tape to mount. This is the default.
Note:
For API applications, this is recommended to permit backup directly to tape.

Yes
You are prompted when a tape is required to back up, archive, restore, or retrieve data. At the prompt, you can wait for the appropriate tape to be mounted, always wait for a tape to be mounted, skip a particular object, skip all objects on a single tape, skip all objects on all tapes, or cancel the entire operation.

Examples

Options file:
tapeprompt yes

Preferences file:
tapeprompt yes

Command line:
-tapep=yes

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

Tcpbuffsize

Authorized User (UNIX requires access authority.)

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

size
Specifies the size, in kilobytes, that you want to use for the internal TCP/IP communication buffer. The range of values is 1 through 512; the default is 31.

Depending on the operating system communication settings, your system might not accept all values in the range of 1 through 512.

Examples

Options file:
tcpb 2

Preferences file:
tcpb 2

Command line:
-tcpbuffsize=31    

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

Tcpclientaddress

Authorized User (UNIX requires access authority.)

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

This option is valid for the NetWare, Windows, and UNIX clients.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-TCPCLIENTAddress- client_address----------------------------><
 
 

Parameters

client_address
Specifies the TCP/IP address you want the server to use to contact your client node. Specify a TCP/IP Internet domain name or a dot address.For NetWare: Specify a TCP/IP Internet dot address only.

Examples

Options file:

tcpclienta dsmclnt.sanjose.ibm.com (UNIX or Windows)

tcpclienta 128.33.10.249 (NetWare)

Command line:
-tcpclientaddress=128.33.10.249     

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

Tcpclientport

Authorized User (UNIX requires access authority.)

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

This option is valid for the NetWare, Windows, and UNIX clients.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-TCPCLIENTPort- client_port_address--------------------------><
 
 

Parameters

client_port_address
Specifies the TCP/IP port address you want the server to use to contact your client node. The range of values is 1000 through 32767; the default is 1501.

Examples

Options file:
tcpclientp 1502

Command line:
-tcpclientport=1492     

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

Tcpnodelay

Authorized User (UNIX requires access authority.)

Note:
For UNIX clients: This option is for AIX and AIX 5L clients 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. Specifying tcpnodelay yes might improve performance in higher-speed networks.

Supported Clients

This option is valid for AIX, AIX 5L, and all Windows clients.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

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

Parameters

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

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

Examples

Options file:
tcpnodelay yes

Command line:
Does not apply.

Tcpport

Authorized User (UNIX requires access authority.)

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.

Tivoli Storage Manager Firewall Support

To enable the backup-archive client, Command Line Admin client, and the Scheduler (running in polling mode) to run outside a firewall, the port specified by the option tcpport (default 1500) must be opened in the firewall.

Note:
Tivoli Storage Manager does not support the scheduler running in prompted mode outside a firewall.

The webports option enables the use of the Web client outside a firewall by specifying the TCP/IP port number used by the Tivoli Storage Manager Client Acceptor daemon and the Web Client Agent service for communications with the Web GUI.

The ports specified with the webports option and the client option httpport must be opened in the firewall. See Httpport and Webports for more information.

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

port_address
Specifies the TCP/IP port address that is used to communicate with a server. The range of values is 1000 through 32767; the default is 1500.

Examples

Options file:
tcpp 1501

Preferences file:
tcpp 1501

Command line:
-tcpport=1501    (Windows or NetWare)
Does not apply   (UNIX)

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

Tcpserveraddress

Authorized User (UNIX requires access authority.)

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

server_address
Specifies a 1 to 64 character TCP/IP address for a server. Specify a TCP/IP domain name or a dot address. For NetWare 5.0, specify only the dot address.

Examples

Options file:
tcps dsmchost.endicott.ibm.com

Preferences file:
tcps dsmchost.endicott.ibm.com

Command line:
-tcpserveraddress=129.33.24.99 (Windows or NetWare)
Does not apply (UNIX)

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

Tcpwindowsize

Authorized User (UNIX requires access authority.)

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 server. To improve restore or retrieve performance, increase the tcpwindowsize on the client.

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

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

For Windows: The range of values is 1 through 2048 for Windows 2000 only. For Windows 98, Me, and NT 4.0, we recommend a maximum value of 63 or less. The default is 32.

For UNIX: The range of values is 1 through 2048. For Solaris the maximum value is 1024. The default is 32.

For NetWare: The range of values is 1 through 64; the default is 32.

For Macintosh: The range of values is 1 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. By default, Windows 2000 does not support a value greater then 63KB. Refer to Description of Windows 2000 TCP Features, Microsoft knowledge base, article Q224829, for details regarding TCP features in Windows 2000.

Examples

Options file:
tcpwindowsize 1

Preferences file:
tcpwindowsize 1

Command line:
-tcpw=24

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

Timeformat

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

For all clients except UNIX: Use this option if you want to change the default time format for the language of the message repository you are using.

The AIX, AIX 5L, 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.

Note:
This timeformat option does not affect the Web client. The Web client uses the time format for the locale that the browser is running in. If the browser is not running in a locale that Tivoli Storage Manager supports, the Web client uses the time format for American English.

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

format_number
Displays time in one of the formats listed below. Select the format number that corresponds to the format you want to use.

0
Use the locale-defined time format.

For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: This is the default if the locale-specified format consists of digits, separator characters, and, if applicable, the AM or PM string.

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

For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: This is the default if the locale-specified format does not consist of digits, separator characters, and, if applicable, the AM or PM string.

2
23,00,00

3
23.00.00

4
12:00:00 A/P

For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: 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.

"%H:%M:%S"
Displays time in the form hh:mm:ss with hh ranging from 0 through 23.
"%H,%M,%S"
Displays time in the form hh,mm,ss with hh ranging from 0 through 23.
"%I,%M,0p"
Displays time in the form hh,mm,ssA/P with hh ranging from 1 through 12 and A/P is the local abbreviation for ante-meridian (AM in English) or post-meridian (PM in English).

Examples

Options file:
timeformat 4

Preferences file:
timeformat 4

Command line:
-time=3

Tpname

The tpname option specifies a symbolic name for the transaction program name. The transaction program name is required if the symbolic destination name is not provided for SNA LU6.2 communication.

If you use this option, define the cpicmodename and partnerluname options also.

Supported Clients

This option is valid for the NetWare client only.

Syntax

>>-TPname- tp_name---------------------------------------------><
 
 

Parameters

tp_name
Specifies a 1 to 64 character transaction program name of the target logical unit (the server). Contact your administrator for this name. There is no default.

Examples

Options file:
tpname tsm

Command line:
-tp=tsm

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

Txnbytelimit

Authorized User (UNIX requires access authority.)

The txnbytelimit option specifies the number of kilobytes the client program buffers before it sends a transaction to the server.

Note:
This option can also be defined and adjusted by the server as required during self-tuning operations.
A transaction is the unit of work exchanged between the client and server. Because the client program can transfer more than one file or directory between the client and server before it commits the data to server storage, a transaction can contain more than one file or directory. This is called a transaction group.

This option permits you to control the amount of data sent between the client and server before the server commits the data and changes to the server database, thus changing the speed with which the client performs work. The amount of data sent applies when files are batched together during backup or when receiving files from the server during a restore procedure.

The server administrator can limit the number of files or directories contained within a transaction group 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, UNIX, and all Windows clients.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-TXNBytelimit- number----------------------------------------><
 
 

Parameters

number
Specifies the number of kilobytes the client program can buffer together in a transaction before it sends data to the server. The range of values is 300 through 2097152 (2 GB); the default is 2048.

Examples

Options file:
txnb 2048

Command line:
-txnb=2048

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

Usedirectory

The usedirectory option queries the Active Directory for the communication method and server with which to connect. Use this option to ignore commmethod parameters in the client options file (dsm.opt). Optimally, the administrator enables only one server and one specific communication protocol for a given client node. If a node is registered to more than one server published in Active Directory, the first server returned in the Active Directory query will be used. If the client cannot contact the server, the client session will fail.

This option is valid in the client options file (dsm.opt) and on the command line.

Supported Clients

This option is valid for Windows 2000 clients only.

Syntax

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

Parameters

Yes
Specifies that the client will ignore commmethod parameters set in the client options file and query the Active Directory for the communication method and server with which to connect.

No
Specifies that the client will use the communication method specified in the option file. If there is no communication method specified in the option file the default communication method and server are used.

Examples

Options file:
usedirectory no

Command line:
-usedir=yes

Users

Authorized User (UNIX requires access authority.)

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 Tivoli Storage Manager 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 Tivoli Storage Manager 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 valid 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

username
Names a user that you want to authorize to request Tivoli Storage Manager services.

Examples

Options file:
users  carol  larry  davecd  kathyba  michelle
users  amyb  tkaspar  kbsmith  egray  srjames

Command line:
Does not apply.

Verbose

The verbose option specifies that you want processing information to display on your screen. This is the default. For all clients except Macintosh: When you run the incremental, selective, or archive commands, information displays about each file that is backed up. Use the quiet option if you do not want to display this information.

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

For Windows, NetWare, or UNIX: If the server specifies either the quiet or verbose option in the server client option set, the server settings override the client values, even if force is set to No on the server.

For Macintosh: The information displays on your screen in the Scheduler Status window. This option only applies when you are running the scheduler and Tivoli Storage Manager is performing scheduled work.

Note:
The server can also define this option.

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

Options file:
verbose

Preferences file:
verbose

Command line:
-verbose

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

Virtualmountpoint

Authorized User (UNIX requires access authority.)

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

directory
Specifies the path and directory name for the directory you want to use as the virtual mount point for a file system. You cannot use wildcard characters in either the path or directory names.

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

Options file:
virtualmountpoint /afs/xyzcorp.com/home/ellen/
virtualmountpoint /afs/xyzcorp.com/home/ellen/test/data/

Command line:
Does not apply.

Virtualnodename

The virtualnodename option specifies the node name of your workstation when you want to restore or retrieve files to a different workstation. Place this option in the client options file or Preferences file (Macintosh).

When you use the virtualnodename option in your client options file or Preferences file (Macintosh), or with a command:

When connecting to a server, the client must identity itself to the server. This login identification is determined in the following ways:

When the virtual node name is accepted by the server, a password is required (assuming authentication is on), even if the passwordaccess option is generate. Once a connection to the server is established, then access is permitted to any file backed up using this login ID.

Supported Clients

All clients can use this option.

Options File for UNIX Platforms

Place this option in the client options file (dsm.opt).

Syntax

>>-VIRTUALNodename- nodename-----------------------------------><
 
 

Parameters

nodename
Specifies a 1- to 64-character name that identifies the node for which you want to request Tivoli Storage Manager services. There is no default.

Examples

Options file:
virtualnodename cougar

Preferences file:
virtualnodename cougar

Command line:
-virtualn=banshee

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

Webports

The webports option enables the use of the Web client outside a firewall by specifying the TCP/IP port number used by the Tivoli Storage Manager Client Acceptor daemon and Web Client Agent service for communications with the Web GUI.

If you do not specify this option, values for both the Client Acceptor daemon and the Web Client Agent service are required.

If you do not specify this option, the default value, zero (0), is used for both ports. This causes TCP/IP to randomly assign a free port number for the Client Acceptor daemon and the Web Client Agent service. The port value TCP/IP assigns is in the range of 1024 through 5000.

The ports you specify with the webports and httpport options must be opened in the firewall.

To enable the backup-archive client, Command Line Admin client, and the Scheduler (running in polling mode) to run outside a firewall, the port specified by the server option tcpport (default 1500) must be opened in the firewall.

Note:
Tivoli Storage Manager does not support the scheduler running in prompted mode outside a firewall.

To enable the administrative Web interface to run outside a firewall the port specified by server option httpport (default is 1580) must be opened in the firewall.

See Httpport and Tcpport for more information.

Supported Clients

This option is valid for UNIX, Windows, and NetWare clients only.

Options File for UNIX Platforms

Place this option in the client system options file (dsm.sys).

Syntax

>>-WEBPorts- cadportagentport--------------------------------><
 
 

Parameters

cadport
Specifies the required Tivoli Storage Manager Client Acceptor daemon port number. If a value is not specified, the default, zero (0), causes TCP/IP to randomly assign a free port number.

agentport
Specifies the required Tivoli Storage Manager Web client agent service port number. If a value is not specified, the default, zero (0), causes TCP/IP to randomly assign a free port number.

Examples

Options file:
webports 2123 2124

Command line:
Does not apply (UNIX)
-webports=2123,2124 (Windows 98, Me or NetWare)


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