You can use defaults for processing options or you can tailor the processing options to meet specific needs. This chapter:
As a quick reference, this chapter includes instructions for the following
tasks:
During the installation, Tivoli Storage Manager provides a sample client options file called dsm.smp. This file contains processing options that are categorized as follows:
Tivoli Storage Manager provides a sample options file named dsm.smp. The dsm.smp file is a generic configuration file that contains communication parameters normally used in a Windows environment.
When the installation process completes, the Setup Wizard launches automatically if no dsm.opt file exists to help you configure an initial options file.
You can use one of the following methods to edit your client options file:
The preferences editor updates the client configuration file, dsm.opt, if any options change.
The preferences editor uses environment variables DSM_DIR and DSM_CONFIG to locate the dsm.opt file. The preferences editor queries the server for options stored at the server, but only updates the client options file on the client. The preferences editor groups options into categories:
You may use some options only with commands. For more information about these options, see Chapter 9, "Using Options with Commands".
You use communication options to specify how your client node communicates with a Tivoli Storage Manager server.
For Windows NT or Windows 2000 you can use one of the following protocols:
For Windows 98 and Me you can use the TCP/IP protocol.
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.
To use the TCP/IP communication protocol, you must include the
tcpserveraddress option in your client options file. The
other TCP/IP options have default values which you can modify only if you want
to change the default value.
Option | Description | Page |
---|---|---|
httpport | Specifies a TCP/IP port address for the 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. | 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 service and the Web Client Agent service for communications with the Web GUI. | Webports |
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 |
Use the following option to specify the client node for which to request
backup-archive services.
Option | Description | Page |
---|---|---|
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:
| Nodename |
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 |
You can use the following options to control some aspects of backup and
archive processing.
Table 17. Backup and Archive Processing Options
Option | Description | Page |
---|---|---|
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. | 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. | 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 |
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 drives to include in your default client domain for an incremental backup. | Domain |
domain.nas | Specifies the volumes to include in your default domain for nas backups. This option is for Windows NT and Windows 2000 clients 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. 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 backup services only. Equivalent to the exclude, exclude.file, and exclude.file.backup options. | 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.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.dir statements. This option is for Windows NT and Windows 2000 clients 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 and Windows 2000 clients only. | 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 |
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. | Subfilebackup |
subfilecachepath | Specifies the path where the client cache resides for adaptive subfile backup processing. | Subfilecachepath |
subfilecachesize | Specifies the client cache size for adaptive subfile backup. | 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 |
The following options relate to restore and retrieve processing.
Table 18. Restore and Retrieve Processing Options
Option | Description | Page |
---|---|---|
activatekey | Specifies whether to activate the registry key to update the registry after restoring files. | Activatekey |
guitreeviewafterbackup | Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. | Guitreeviewafterbackup |
localbackupset | Specifies whether the Tivoli Storage Manager GUI bypasses initial logon with the server to restore a local backup set on a Windows 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 |
You can use the following options to regulate central scheduling.
Tivoli Storage Manager uses scheduling options only when the Scheduler is
running.
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 |
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 |
You can use the following options to select different formats for date,
time, numbers, and for different languages if you have the appropriate client
installed for that language.
Table 20. 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 |
The following options apply when you use Tivoli Storage Manager
commands.
Table 21. Command Processing Options
Option | Description | Page |
---|---|---|
editor | Specifies if the command-line interface editor and command retrieve capability is turned on or off. | Editor |
guitreeviewafterbackup | Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. | Guitreeviewafterbackup |
quiet | Specifies that processing information does not display on your screen. This option can be overidden by the 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 |
These options control access to a Tivoli Storage Manager server.
Table 22. 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 |
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 |
revokeremoteaccess | Restricts an administrator with client access privileges from accessing your workstation through the Web client. | Revokeremoteaccess |
These options specify the name of the error log file and how Tivoli Storage
Manager treats the entries in the log file.
Table 23. 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 |
These options control how Tivoli Storage Manager processes transactions
between the client and server.
Table 24. 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 |
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 |
The following are options for the Tivoli Storage Manager Web Client.
Option | Description | Page |
---|---|---|
httpport | Specifies a TCP/IP port address for the Web client. | Httpport |
httpsport | Specifies a TCP/IP Secure Socket Layer (SSL) port address for the Web client. 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 service and the Web Client Agent service for communications with the Web GUI. | Webports |
This section describes how to set options in your client options filedsm.opt , and how to use options with commands.
To view or modify the options file, click Edit and then click Preferences from the GUI. The graphical options editor updates the client configuration options file if any options have changed.
You can edit the client options file 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.
You can override some of the options in your options file by entering them with appropriate backup-archive commands.
Options are processed in the following order (precedence):
Tivoli Storage Manager also includes a group of client command options that you can enter only on the command line with specific commands. For a complete list of command line options, a description, and where to go in this book for more information, see Chapter 9, "Using Options with Commands".
To use an option with a command, enter a dash (-), the option name, an equal sign (=), and the option parameters. For example,
dsmc incremental -domain=c:
For options that do not include parameters, enter a dash (-) and the option name. For example,
dsmc incremental -quiet
You can enter the entire option name or its abbreviation. For information about how to read the syntax diagrams, see "Reading Syntax Diagrams".
Follow these general rules to enter options with a command:
dsmc selective -subdir=yes c:\devel\proj1\* dsmc selective c:\devel\proj1\* -subdir=yes
dsmc archive -description="Project A" "c:\devel\proj1\*"
The following sections contain detailed information about each of the Tivoli Storage Manager processing options. Information for each option includes:
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.
Syntax
.-Yes-. >>-ACTIVATEkey--+-----+---------------------------------------->< '-No--'
Parameters
Examples
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 Client.
To restore or retrieve from a file space that is not Unicode enabled, specify the source on the server and the destination on the client. See "Restoring from File Spaces that are not Unicode Enabled" for information on how to restore from file spaces that are not Unicode enabled. See "Retrieving from File Spaces that are not Unicode Enabled" for information on how to retrieve from file spaces that are not Unicode enabled.
Place this option in the client options file (dsm.opt).
Syntax
.-Prompt-. >>-AUTOFsrename-+--------+------------------------------------->< +-Yes----+ '-No-----'
Parameters
Considerations:
Examples
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.
Syntax
.-Yes-. >>-BACKUPRegistry-+-----+-------------------------------------->< '-No--'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
Syntax
.---------------. V | >>-CHAngingretries---numberretries-+---------------------------><
Parameters
Examples
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 the Appendix in Tivoli Storage Manager Installing the Clients, SH26-4119.
This option is for Windows NT and Windows 2000 clients only.
Syntax
.-No--. >>-CLUSTERnode-+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The commmethod option specifies the communication method you use to provide connectivity for client-server communication.
Syntax
>>-COMMMethod-+- TCPip------+---------------------------------->< '- NAMedpipes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
You can use the commrestartduration option and the commrestartinterval in busy or unstable network environments to decrease connection failures.
Syntax
>>-COMMRESTARTDuration- minutes--------------------------------><
Parameters
Examples
The commrestartinterval option specifies the number of seconds you want the client to wait between attempts to reconnect with a server after a communication error occurs.
You can use the commrestartduration option and the commrestartinterval in busy or unstable network environments to decrease connection failures.
Syntax
>>-COMMRESTARTInterval- seconds--------------------------------><
Parameters
Examples
The compressalways option specifies whether to continue compressing an object if it grows during compression, or resend the object uncompressed. Use this option with the compression option.
Use the compressalways option with the archive, incremental, and selective commands.
Syntax
.-Yes-. >>-COMPRESSAlways-+-----+-------------------------------------->< '-No--'
Parameters
Examples
This option is valid only on the initial command line.
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.
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.
Syntax
.-No--. >>-COMPRESSIon-+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
The dateformat option specifies the format you want to use to display dates.
Use this option if you want to change the default date format for the language of the message repository you are using.
Notes:
Syntax
>>-DATEformat- format_number-----------------------------------><
Parameters
Examples
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.
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 valid for Windows 2000 only.
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.
For more information on backing up a DFS root, see "Backing Up Microsoft Dfs Files".
Syntax
.-Yes-. >>-DFSBackupmntpnt-+-----+------------------------------------->< '-No--'
Parameters
Examples
The dirmc option specifies the management class you want to use for directories. If you do not specify this option to associate a management class with directories, the client program uses the management class in the active policy set of your policy domain with the longest retention period. Select a management class for individual directories that retains directories at least as long as it retains the files associated with them.
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.
Syntax
>>-DIRMc- mgmtclassname----------------------------------------><
Parameters
Examples
The domain option specifies the drives 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 options file to define your default client domain. Tivoli Storage Manager uses your default client domain in the following situations to determine which local drives to process during an incremental backup:
If you do not use the domain option to specify local drives in your client options file, Tivoli Storage Manager uses the all-local parameter as the default.
When you use the domain option with the incremental command, Tivoli Storage Manager adds local drives that you specify to the local drives defined in your client options file. For example, if you enter the following in your client options file:
domain c: d: e:
and the following on the command line:
dsmc incremental -domain="g: h:"
Tivoli Storage Manager performs an incremental backup for your c: d: e: g: and h: local drives.
If you use both a file specification and the domain option with the incremental command, Tivoli Storage Manager ignores the domain option and processes only those drives specified in the file specification. For example, if you enter:
dsmc incremental e: f: -domain="g: h:"Tivoli Storage Manager performs an incremental backup for the e: and f: drives only.
Syntax
.- ----------------. V .-all-local----. | >>-DOMain----+--------------+-+-------------------------------->< +-domain-------+ '-systemobject-'
Parameters
When you use domain with the incremental command, it processes these drives in addition to those specified in your default client domain.
Examples
domain c: d: e:
domain c: systemobject (Windows 2000 only)
-domain="c: d:"
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 options file (dsm.opt), 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.opt file. For example, if you enter the following in your dsm.opt 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.opt 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 and Windows 2000 clients only
Place this option in the client options file (dsm.opt).
Syntax
.- -----------. V .-all-nas-. | >>-DOMAIN.Nas----+---------+-+--------------------------------->< '-domain--'
Parameters
Examples
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.
Syntax
.-Yes-. >>-Editor-+-----+---------------------------------------------->< '-No--'
Parameters
Examples
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 Tivoli Storage Manager for Windows Managed System for SAN Storage Agent User's Guide, GC35-0434.
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.
Syntax
.-No--. >>-ENABLELanfree-+-----+--------------------------------------->< '-Yes-'
Parameters
Examples
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 Registry 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.
Note: The Web client saves the encryption key password in the Registry. If there no key is saved, you are prompted for the initial encryption key password when you begin encryption processing.
Syntax
.-save---. >>-ENCryptkey-+--------+--------------------------------------->< '-prompt-'
Parameters
Examples
The errorlogname option specifies the fully qualified path and file name of the file where you want to store information about errors that occur during processing. 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.
Syntax
>>-ERRORLOGName- filespec--------------------------------------><
Parameters
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.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
Syntax
.-N----. .-D-. >>-ERRORLOGRetention--+------+--+---+-------------------------->< '-days-' '-S-'
Parameters
The pruned entries are copied from the error log to the dsmerlog.pru file located in the same directory as the error log.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The exclude options exclude objects from backup or archive services. For example, you might want to exclude all temporary files, any local caches of network files, all files that contain compiled object code that you can easily reproduce using other methods, or your operating system files.
You can exclude specific files from encryption processing during a backup.
You can exclude remotely accessed files by specifying Universal Naming Convention (UNC) names in your exclude statement. See "Excluding Files with UNC Names" for examples of statements using UNC file names.
Notes:
Exclude any system files 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 , enter the following:
exclude.dir c:\any\test
To exclude subdirectories that begin with test under the any directory, enter the following:
exclude.dir c:\any\test*
Attention: See "Excluding System Files" for a list of files that you should always exclude.
If you want to exclude specific files or groups of files from compression processing during a backup or archive operation, consider the following:
If you specify compression=yes and no exclude.compression statements exist, Tivoli Storage Manager considers all files for compression processing.
exclude c:\test\*.* exclude.compression c:\test\file.txt include c:\test\file.txt
Tivoli Storage Manager examines the first and last statements (reading from bottom to top) and determines that c:\test\file.txt is a candidate for back up. Tivoli Storage Manager then examines the exclude.compression c:\test\file.txt statement and determines that it is not a candidate for compression processing.
If you want to exclude files from adaptive subfile backup processing using the exclude.subfile option, consider the following:
If you specify subfilebackup=yes and no exclude.subfile statements exist, Tivoli Storage Manager considers all files for adaptive subfile backup processing.
exclude c:\test\*.* exclude.subfile c:\test\file.txt include c:\test\file.txt
Tivoli Storage Manager examines the first and last statements (reading from bottom to top) and determines that c:\test\file.txt is a candidate for back up. Tivoli Storage Manager then examines the exclude.subfile c:\test\file.txt statement and determines that it is not a candidate for adaptive subfile backup
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
Syntax
.- ---------------. V | >>---options pattern-+-----------------------------------------><
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.
Parameters
If the pattern begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks.
Examples
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
The guitreeviewafterbackup option specifies whether the client returns to the Backup, Restore, Archive, or Retrieve window after a successful operation completes.
Syntax
.-No--. >>-GUITREEViewafterbackup-+-----+------------------------------>< '-Yes-'
Parameters
Examples
The httpport option specifies a TCP/IP port address for the Web client.
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 service 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.
See Tcpport and Webports for more information. See "Tivoli Storage Manager Firewall Support" for further considerations regarding Tivoli Storage Manager firewall support.
Syntax
>>-HTTPport- port_address--------------------------------------><
Parameters
Examples
httpport 1502
-httpport=1502 (Windows Windows 98, Windows Me)
The httpsport option specifies a TCP/IP port address for the HTTPS secure socket layer (SSL) interface to the Web client.
Syntax
>>-HTTPSport- port_address-------------------------------------><
Parameters
Examples
-httpsport (Windows 98, Me)
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.
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.
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.
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:
For more information about creating an include-exclude options file, see Chapter 7, "Creating an Include-Exclude List".
Syntax
>>-INCLExcl- filespec------------------------------------------><
Parameters
Examples
inclexcl c:\dsm\backup.excl
Does not apply.
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.
You can include remotely accessed files by specifying Universal Naming Convention (UNC) names in your include statement. See "Excluding Files with UNC Names" for example statements using UNC file names.
Notes:
If you want to include specific files or groups of files for compression processing during a backup or archive operation, consider the following:
include.compression c:\test\file.txt exclude c:\test\file.txt
Tivoli Storage Manager examines the exclude c:\test\file.txt statement first and determines that c:\test\file.txt is excluded from processing and is not a candidate for compression processing.
If you want to include files for adaptive subfile backup processing using the include.subfile option, consider the following:
include.subfile c:\test\file.txt exclude c:\test\file.txt
Tivoli Storage Manager examines the exclude c:\test\file.txt statement first and determines that c:\test\file.txt is excluded from processing and is not a candidate for subfile processing.
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.
Syntax
.- -----------------------------------. V | >>---options pattern -+----------------+-+--------------------->< '- mgmtclassname-'
Parameters
If the pattern begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks.
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.
Examples
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
Does not apply.
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). This option is for Windows NT, 2000 clients only.
See Incremental for more information about journaled backups.
Syntax
>>-INCRTHreshold--numberdirectories----------------------------><
Parameters
Examples
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.
Place this option in the client options file (dsm.opt).
Syntax
>>-LANFREECommmethod- commmethod-------------------------------><
Parameters
Use the lanfreetcpport to specify the TCP/IP port number where the Storage Agent is listening. See Lanfreetcpport for more information.
Examples
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.
Place this option in the client options file (dsm.opt).
See Lanfreecommmethod for more information about the lanfreecommmethod option.
Syntax
>>-LANFREETCPport- port_address--------------------------------><
Parameters
Examples
The language option specifies the national language in which to present client messages.
You can use American English (AMENG) with all clients.
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.
Syntax
>>-LANGuage- language------------------------------------------><
Parameters
Examples
The largecommbuffers option specifies whether the client uses increased buffers to transfer large amounts of data between the client and the server. You can disable this option when your workstation is running low on memory.
Syntax
.-No--. >>-LARGECOMmbuffers-+-----+------------------------------------>< '-Yes-'
Parameters
Examples
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
Syntax
.-No--. >>-LOCALbackupset-+-----+-------------------------------------->< '-Yes-'
Parameters
Examples
The managedservices option specifies whether the Tivoli Storage Manager Client Acceptor service (CAD) manages the scheduler, the Web client, or both.
See "Configuring the CAD to Manage the Scheduler" for instructions to set up the CAD to manage the scheduler.
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:
Using the managedservices option can provide the following benefits:
Place this option in the client options file (dsm.opt).
Syntax
>>-MANAGEDServices--+----------+------------------------------->< | .- ----. | | V | | '---mode-+-'
Parameters
Examples
managedservices webclient
managedservices schedule
managedservices schedule webclient
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 file after your client node successfully contacts the server.
Syntax
>>-MAXCMDRetries- maxcmdretries--------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
Syntax
.-No--. >>-MEMORYEFficientbackup-+-----+------------------------------->< '-Yes-'
Parameters
Examples
The namedpipename option specifies the name of a named pipe to use for communications between a client and a server on the same Windows server domain. This option is valid for the Windows NT and Windows 2000 clients only.
Syntax
>>-NAMedpipename- name-----------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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 options file (dsm.opt).
You can override the default value in the dsm.opt file by entering a different value on the command line. If you do not specify the nasnodename option in the dsm.opt file, you must specify this option on the command line when processing NAS file systems.
The nasnodename option is valid for Windows NT and Windows 2000 clients only
Syntax
>>-NASNodename- nodename---------------------------------------><
Parameters
Examples
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.
The node name is not necessarily the TCP/IP host name.
Syntax
>>-NODename- nodename------------------------------------------><
Parameters
The default is the name of the workstation unless clusternode=yes. Then, the default is the cluster name.
Permit the node name to default to the workstation name.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The numberformat option specifies the format you want to use to display numbers.
Use this option if you want to change the default number format for the language of the message repository you are using.
Syntax
>>-NUMberformat- number----------------------------------------><
Parameters
Examples
This option is valid on the initial command line and in interactive mode.
The optfile option specifies the client options file you want to use when you start a Tivoli Storage Manager session.
Syntax
>>-OPTFILE- file_name------------------------------------------><
Parameters
Examples
dsmc query session -optfile= myopts.opt
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
The password option is ignored when the passwordaccess option is set to generate.
Syntax
>>-PASsword- password------------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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:
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:
Syntax
.-prompt---. >>-PASSWORDAccess-+----------+--------------------------------->< '-generate-'
Parameters
To keep your client node password secure, enter commands without the password and wait for Tivoli Storage Manager to prompt you for the password.
A password prompt displays when registering a workstation with a server using open registration or if your administrator changes your password manually.
Examples
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.
Syntax
>>-+-POSTSchedulecmd--+-- "cmdstring"-------------------------->< '-POSTNschedulecmd-'
Parameters
Use a blank, or null, string for cmdstring if you want to prevent any commands from running that the administrator uses for postschedulecmd or preschedulecmd. If you specify a blank or null string on either option, it prevents the administrator from using a command on both options.
If your administrator uses a blank or null string on the postschedulecmd option, you cannot run a post-schedule command.
If the command string contains blanks, enclose it in double quotes. If you have double quotes within the command string, use single quotes to enclose them.
Examples
The command string is a valid command for restarting your database.
The preschedulecmd option specifies a command that the client program processes before it runs a schedule. The client program waits for the command to complete before it starts the schedule.
If you do not want it to wait, specify prenschedulecmd.
Syntax
>>-+-PRESchedulecmd--+-- "cmdstring"--------------------------->< '-PRENSchedulecmd-'
Parameters
Use a blank or null string for cmdstring if you want to prevent any commands from running that the administrator uses for postschedulecmd and preschedulecmd. If you specify a blank or null string on either option, it prevents the administrator from using a command on both options.
If your administrator uses a blank or null string on the preschedulecmd option, you cannot run a pre-schedule command.
If the command string contains blanks, enclose it in double quotes. If you placed double quotes within the command string, use single quotes to enclose them.
Examples
The command string is a valid command for quiescing your database.
The queryschedperiod option specifies the number of hours you want the client scheduler to wait between attempts to contact the server for scheduled work. This option applies only when you set the schedmode option to polling. This option is used only when the scheduler is running.
Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides the value set in your client options file after your client node successfully contacts the server.
Syntax
>>-QUERYSCHedperiod- hours-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The quiet option limits the number of messages that display on your screen during processing. 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.
This option also affects the amount of information reported in the NT eventlog and schedule log.
Syntax
>>-QUIET-------------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
This option is valid on the initial command line and in interactive mode.
The replace option specifies what you want the system to do when it restores files that already exist on your workstation. This option applies to the restore, retrieve, and restore backupset commands only.
Syntax
.-Prompt-. >>-REPlace-+--------+------------------------------------------>< +-All----+ +-Yes----+ '-No-----'
Parameters
Examples
The resourceutilization option regulates the level of resources the 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.
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:
Syntax
>>-RESOURceutilization- number---------------------------------><
Parameters
Examples
The retryperiod option specifies the number of minutes the client scheduler waits between attempts to process a scheduled command that fails, or between unsuccessful attempts to report results to the server. 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 file after your client node successfully contacts the server.
Syntax
>>-RETRYPeriod- minutes----------------------------------------><
Parameters
Examples
-retryperiod=15
This option is valid only on the initial command line. It is not valid in interactive mode.
The revokeremoteaccess option restricts an administrator with client access privilege from accessing a client workstation that is running the Web client. This option does not restrict administrators with client owner, system, or policy privilege from accessing your workstation through the Web client.
Syntax
.-None---. >>-REVOKEremoteaccess-+--------+------------------------------->< '-Access-'
Parameters
Examples
The runasservice option forces the client command process to continue running, even if the account that started the client logs off. Use this option with the AT command and the NT scheduler when you schedule client command batch jobs. This option is valid for the Windows NT and Windows 2000 clients only.
Syntax
.-No--. >>-RUNASSERVice--+-----+--------------------------------------->< '-Yes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The 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. See Query Schedule for more information.
Place this option in your client options file.
Syntax
.-No--. >>-SCHEDCMDDisabled-+-----+------------------------------------>< '-Yes-'
Parameters
Examples
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.
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.
Syntax
>>-SCHEDLOGName- filespec--------------------------------------><
Parameters
If you specify a file name only, the file is stored in your current directory. The default is the installation directory with a file name of dsmsched.log.
Examples
schedlogname c:\mydir\schedlog.jan
-schedlogn=c:\mydir\schedlog.jan
This option is valid only on the initial command line. It is not valid in interactive mode.
The schedlogretention option specifies the number of days to keep entries in the schedule log, and whether to save the pruned entries. The schedule log is pruned after a scheduled event completes.
Syntax
.-N----. .-D-. >>-SCHEDLOGRetention--+------+--+---+-------------------------->< '-days-' '-S-'
Parameters
Pruned entries are copied to the dsmsched.pru file that is stored in the same directory as the schedule log.
Examples
-schedlogretention=30,S
This option is valid only on the initial command line. It is not valid in interactive mode.
The schedmode option specifies whether you want to use the polling mode (your client node periodically queries the server for scheduled work), or the prompted mode (the server contacts your client node when it is time to start a scheduled operation). All communication methods can use the client polling mode, but only TCP/IP can use the server prompted mode.
Your administrator can specify that the server support both modes or just one mode. If your administrator specifies that both modes are supported, you can select either schedule mode. If your administrator specifies only one mode, you must specify that mode in your client options file or scheduled work will not process.
If 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:
Syntax
.-POlling--. >>-SCHEDMODe-+----------+-------------------------------------->< '-PRompted-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The scrolllines option specifies the number of lines of information that display on your screen at one time. Use this option when you set the scrollprompt option to Yes and you use commands.
Syntax
>>-SCROLLLines- number-----------------------------------------><
Parameters
Examples
This option is valid on the initial command line and in interactive mode.
The scrollprompt option specifies whether you want 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.
Syntax
.-No--. >>-SCROLLPrompt-+-----+---------------------------------------->< '-Yes-'
Parameters
Press 'Q' to quit, 'C' to continuous scroll, or 'Enter' to continue.
Examples
This option is valid on the initial command line and in interactive mode.
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:
Syntax
.-No--. >>-SKIPNTPermissions-+-----+----------------------------------->< '-Yes-'
Parameters
Examples
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:
This option is valid for Windows NT, 2000 clients only.
Syntax
.-No--. >>-SKIPNTSecuritycrc-+-----+----------------------------------->< '-Yes-'
Parameters
Examples
The subdir option specifies whether you want to include subdirectories of named directories for processing on the following commands:
Place this option in your client options file (dsm.opt).
Syntax
.-No--. >>-SUbdir-+-----+---------------------------------------------->< '-Yes-'
Parameters
If a subdirectory is a mounted file system, it will not process even if you specfify subdir=yes.
Examples
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
The subfilebackup option specifies whether to enable adaptive subfile backup.
Syntax
.-no--. >>-SUBFILEBackup-+-----+--------------------------------------->< '-yes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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:
Syntax
>>-SUBFILECACHEPath- path_name---------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
Syntax
>>-SUBFILECACHESize- size--------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The tapeprompt option specifies whether you want to wait for a tape to mount if it is required for a backup, archive, restore, or retrieve process, or to be prompted for a choice.
Tape prompting does not occur during a scheduled operation regardless of the setting for the tapeprompt option.
The tapeprompt option can be used with the following commands:
Syntax
.-No--. >>-TAPEPrompt-+-----+------------------------------------------>< '-Yes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpbuffsize option specifies the size of the internal TCP/IP communication buffer. Although it uses more memory, a larger buffer can improve communication performance.
Syntax
>>-TCPBuffsize- size-------------------------------------------><
Parameters
Depending on the operating system communication settings, your system might not accept all values in the range of 1 through 512.
Examples
-tcpbuffsize=31
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpclientaddress option specifies a TCP/IP address if your client node has more than one address, and you want the server to contact an address other than the one that was used to make the first server contact.
Use this option only if you use the prompted parameter with the schedmode option or when the schedule command is running.
Syntax
>>-TCPCLIENTAddress- client_address----------------------------><
Parameters
Examples
tcpclienta dsmclnt.sanjose.ibm.com
-tcpclientaddress=128.33.10.249
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpclientport option specifies a different TCP/IP port number for the server to contact than the one that was used to make the first server contact. If the default port or the specified port is busy, the server attempts to use any available port. Use this option only if you specify the prompted parameter with the schedmode option or when the schedule command is running.
Syntax
>>-TCPCLIENTPort- client_port_address--------------------------><
Parameters
Examples
-tcpclientport=1492
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
Syntax
.-No--. >>-TCPNodelay--+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
The tcpport option specifies a TCP/IP port address for a server. You can obtain this address from your administrator.
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.
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 service 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.
See "Tivoli Storage Manager Firewall Support" for further considerations regarding Tivoli Storage Manager firewall support.
Syntax
>>-TCPPort- port_address---------------------------------------><
Parameters
Examples
-tcpport=1501
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpserveraddress option specifies the TCP/IP address for a server. You can obtain this server address from your administrator.
Syntax
>>-TCPServeraddress- server_address----------------------------><
Parameters
Examples
-tcpserveraddress=129.33.24.99
This option is valid only on the initial command line. It is not valid in interactive mode.
The tcpwindowsize option specifies the amount of data in kilobytes that is buffered when receiving data on a TCP/IP connection. To improve backup or archive performance, increase the tcpwindowsize on the server. To improve restore or retrieve performance, increase the tcpwindowsize on the client.
Syntax
>>-TCPWindowsize- window_size----------------------------------><
Parameters
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.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The timeformat option specifies the format in which you want to display system time.
Use this option if you want to change the default time format for the language of the message repository you are using.
Syntax
>>-TIMEformat- format_number-----------------------------------><
Parameters
Examples
The txnbytelimit option specifies the number of kilobytes the client program buffers before it sends a transaction to the server.
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.
Syntax
>>-TXNBytelimit- number----------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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.
This option is valid for Windows 2000 only.
Syntax
.-No--. >>-USEDIRectory-+-----+---------------------------------------->< '-Yes-'
Parameters
Examples
The verbose option specifies that you want processing information to display on your screen. This is the default. When you run the incremental, selective, or 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.
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.
Syntax
>>-VErbose-----------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
This option is valid on the initial command line and in interactive mode.
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 (dsm.opt).
When you use the virtualnodename option in your client options file, 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.
Syntax
>>-VIRTUALNodename- nodename-----------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
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 service and Web Client Agent service for communications with the Web GUI.
If you do not specify this option, values for both the Client Acceptor service 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 service 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.
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.
See "Tivoli Storage Manager Firewall Support" for further considerations regarding Tivoli Storage Manager firewall support.
Syntax
>>-WEBPorts- cadport- agentport--------------------------------><
Parameters
Examples
-webports=2123,2124