Tivoli Storage Manager for Macintosh Using the Backup-Archive Client


Chapter 8. Setting Common Options

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

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

Task Page
"Creating and Modifying a Preferences File" "Creating and Modifying a Preferences File"
"Setting Options in the TSM Backup Preferences File" "Setting Options in the TSM Backup Preferences File"
"Creating Multiple Preferences Files" "Creating Multiple Preferences Files"

Creating and Modifying a Preferences File

During the installation of TSM, you are provided with a sample Preferences file called TSM Backup Preferences-Sample located in the system folder's preference folder. This file contains processing options that are categorized as follows:

By default, TSM will create a TSM Backup Preferences file in the Tivoli Storage Manager folder in the system's preferences folder. With the Setup Assistant, you can import the sample preferences file, or any other ADSM/TSM preferences file.

To view or modify the Preferences file, select the Edit menu> Preferences item on the backup-archive GUI. The graphical options editor updates the client configuration Preferences file, if any options have changed.

The graphical options editor groups the options in the following categories:

Options are processed in the following order (precedence):

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

Communication Options

You use communication options to specify how your client node communicates with a TSM server. TSM for Apple Macintosh uses the TCP/IP communication protocol.

Use the commmethod option to specify the communication protocol. For more information, see Commmethod. Ask your TSM administrator for assistance in setting your communication options.

TCP/IP Options

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

Table 9. TCP/IP Options

Option Description Page
tcpbuffsize Specifies the size, in kilobytes, of the TSM internal TCP/IP communication buffer. Tcpbuffsize
tcpport Specifies the TCP/IP port address for a TSM server. Tcpport
tcpserveraddress Specifies the TCP/IP address for a TSM server. Tcpserveraddress
tcpwindowsize Specifies the size, in kilobytes, of the TCP/IP sliding window for your client node. Tcpwindowsize

Node Option

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

Table 10. Node Options

Option Description Page
nodename Specifies one of the following:
  • The name of your workstation so that you can establish communications with the TSM server.
  • The name of another workstation. Use this if you want to restore or retrieve your files from a TSM server to a different workstation than the one from which you stored the files.
Nodename

Backup and Archive Processing Options

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

Table 11. Backup and Archive Processing Options

Option Description Page
changingretries Specifies the number of retries when attempting to back up or archive a file that is in use. Changingretries
compressalways 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 TSM server. Compression
dirmc Specifies the management class to use for directories. If not specified, TSM uses the management class with the longest retention period. Dirmc
domain Specifies the volumes to include in your default client domain for an incremental backup. Domain
exclude Excludes a file or group of files from backup services. Any file in your client domain that is not specifically excluded with this option is considered for backup. Exclude Options
exclude.archive Excludes a file or group of files from archive services. Exclude Options
exclude.backup Excludes a file or a group of files from backup services only. Exclude Options
exclude.dir Excludes the specified directory, its files, and all its subdirectories and their files from backup services. Exclude Options
exclude.file Excludes files, but not directories, that match a pattern. Exclude Options
exclude.file.backup Excludes a file from normal backup services. Exclude Options
guitreeviewafterbackup Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. Guitreeviewafterbackup
include Includes files or management classes for backup or archive processing. Include Options
include.file Includes a file for backup services, or assigns a management class to a file. Include Options
memoryefficientbackup Specifies a memory-saving backup algorithm for incremental backups when used with the incremental command. Memoryefficientbackup
tapeprompt Specifies whether you want TSM to wait for a tape required for a backup or archive to be mounted, or to prompt you for your choice. Tapeprompt

Restore and Retrieve Processing Options

The following options relate to restore and retrieve processing.

Table 12. Restore and Retrieve Processing Options

Option Description Page
guitreeviewafterbackup Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. Guitreeviewafterbackup
tapeprompt Specifies whether you want TSM to wait for a tape required for a restore or retrieve to be mounted, or to prompt you for your choice. Tapeprompt

Scheduling Options

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

Table 13. Scheduling Options

Option Description Page
maxcmdretries Specifies the maximum number of times the client scheduler attempts to process a scheduled command that fails. Maxcmdretries
postschedulecmd, postnschedulecmd Specifies a command to process after running a schedule. Postschedulecmd/Postnschedulecmd
preschedulecmd, prenschedulecmd Specifies a command to process before running a schedule. Preschedulecmd/Prenschedulecmd
queryschedperiod Specifies the number of hours the client scheduler waits between unsuccessful attempts to contact the TSM server for scheduled work. Queryschedperiod
retryperiod Specifies the number of minutes the client scheduler waits between attempts to process a scheduled command that fails or between unsuccessful attempts to report results to the server. Retryperiod
schedcompleteaction Specifies an action to take after a schedule has been completed. 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

Format and Language Options

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

Table 14. 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 only when you use certain TSM commands.

Table 15. Command Processing Options

Option Description Page
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. Matchallchar
matchonechar Specifies the character to use as a match-one-character wildcard character. Matchonechar
quiet Specifies that processing information does not display on your screen. This option can be overidden by the TSM server. Quiet
verbose Specifies that processing information should display on your screen. The alternative is quiet. This option can be overridden by the TSM server. Verbose

Authorization Options

These options control access to a TSM server.

Table 16. Authorization Options

Option Description Reference
password Specifies a TSM password. Password
passwordaccess Specifies how TSM handles a password if one is required for your workstation. Passwordaccess
passworddir Specifies the directory in which you want TSM to store an automatically generated password for your client node. Passworddir

Error Processing Options

These options specify the name of the error log file and how TSM treats the entries in the log file.

Table 17. Error Processing Options

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

Transaction Processing Options

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

Table 18. Transaction Processing Option

Option Description Page
commrestartduration Specifies the maximum number of minutes you want the TSM client to try to reconnect to a TSM server after a communication error occurs. Commrestartduration
commrestartinterval Specifies the number of seconds you want the TSM client to wait between attempts to reconnect to a TSM server after a communication error occurs. Commrestartinterval
largecommbuffers Specifies whether the client will use increased buffers to transfer large amounts of data between the client and the server. Largecommbuffers
resourceutilization Specifies the number of sessions opened between the TSM server and client during processing. Resourceutilization

Setting Options in the TSM Backup Preferences File

This section describes how to set options in your Preferences file.

To view or modify the Preferences file, select the Edit menu> Preferences item on the backup-archive GUI. The graphical options editor updates the client configuration Preferences file, if any options have changed.

The Preferences file can also be edited with your favorite text editor.

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

   compression  yes
   nodename     client_a

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

   verbose
   ve

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

If you update the Preferences file while a GUI session is active, you must restart the session to pick up the changes.

Creating Multiple Preferences Files

Some tasks require changes to the Preferences file. For example, suppose you want to back up your files to one server and archive them to another. Or, suppose you want to retrieve files to a different workstation. Instead of editing your Preferences file each time you want to connect to a different server or use a different workstation, you can create multiple Preferences files. Depending on what you want to do, you can launch TSM with a different Preferences file that suits your needs.

Suppose you have two servers named Alpha and Bravo. Simply create two Preferences files named, for example, Prefs Alpha and Prefs Bravo. When you want to connect to Bravo, locate Prefs Bravo on your desktop and drop it onto the TSM icon. TSM starts using all options specified in Prefs Bravo, including the server address.

Note:Remember to make duplicates of your original Preferences file and modify the duplicates. Always keep the original TSM Backup Preferences-Sample intact.

Client Options Reference

The following sections contain detailed information about each of the TSM processing options. These options are arranged in alphabetical order. Information for each option includes:

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.

Changingretries

The changingretries option specifies how many additional times you want the TSM client program to attempt to back up or archive a file that is in use.

This option is used only when serialization, an attribute in a management class copy group, is shared static or shared dynamic.

With shared static serialization, if a file is in use during the first backup or archive attempt, the operation is attempted again the number of times you specified. If the file is in use during each attempt, the operation does not complete.

With shared dynamic serialization, if a file is in use during the first backup or archive attempt, the operation is attempted again the number of times you specified. The backup or archive operation occurs during the last attempt whether the file is in use or not.

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

Syntax

                   .-----------------.
                   V                 |
>>-CHAngingretries----numberretries--+-------------------------><
 

Parameters

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

Examples

Preferences file:
changingretries 3

Commmethod

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

Syntax

>>-COMMMethod--- TCPip-----------------------------------------><
 

Parameters

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

Examples

Preferences file:
commm tcp

Commrestartduration

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:When a schedule is running, the connection and schedule fail if a communication failure occurs and the client cannot reconnect with the server before the startup window for the schedule ends.

You can use the commrestartduration option and the commrestartinterval in busy or unstable network environments to decrease connection failures.

Syntax

>>-COMMRESTARTDuration- minutes--------------------------------><
 

Parameters

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

Examples

Preferences file:
commrestartduration 90

Commrestartinterval

The commrestartinterval option specifies the number of seconds you want the client to wait between attempts to reconnect with a server after a communication error occurs.

Note:This option is used only when commrestartduration is set to a value greater than zero.

You can use the commrestartduration option and the commrestartinterval in busy or unstable network environments to decrease connection failures.

Syntax

>>-COMMRESTARTInterval- seconds--------------------------------><
 

Parameters

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

Examples

Preferences file:
commrestartinterval 30

Compressalways

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

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

Syntax

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

Parameters

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

No
The object is resent uncompressed, if it grows during compression.

Examples

Preferences file:
compressalways yes

Compression

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

If compressalways yes (the default) is specified, files continue compression even if the file size increases. To stop compression if the file size grows, and resend the file, uncompressed, specify compressalways No.

This option controls compression only if your administrator specifies that your client node determines the selection.

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

Syntax

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

Parameters

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

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

Examples

Preferences file:
compression yes

Dateformat

The dateformat option selects the format used to display dates.

Note:When the date format is changed and the schedlogretention option is used to prune the schedule log, all entries in the schedule log with a different date format are removed when the log is pruned. When the date format is changed and the errorlogretention option is used to prune the error log, then all entries in the error log with a different date are removed when the log is pruned. When changing the date format, copy the schedule log and error log if you want to preserve log entries that contain a different date format.

Syntax

>>-DATEformat- format_number-----------------------------------><
 

Parameters

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

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

2
DD-MM-YYYY

3
YYYY-MM-DD

4
DD.MM.YYYY

5
YYYY.MM.DD

Examples

Preferences file:
dateformat 3

Dirmc

The dirmc option specifies the management class you want to use for directories. If you do not specify this option to associate a management class with directories, the client program uses the management class in the active policy set of your policy domain with the longest retention period. Select a management class for individual directories that retains directories at least as long as it retains the files associated with them.

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

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

Syntax

>>-DIRMc- mgmtclassname----------------------------------------><
 

Parameters

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

Examples

Preferences file:
dirm managdir

Domain

The domain option specifies the volumes that you want to include for incremental backup in your client domain. This option can also be defined on the server.

When used in your Preferences file, the domain option defines your default client domain. TSM uses your default client domain when your administrator defines a schedule to run an incremental backup for you, but does not specify which volumes to process.

If domain is not used to specify volumes in your Preferences file, TSM uses the all-local parameter as the default.

Syntax

           .- ----------------.
           V  .-all-local--.  |
>>-DOMain-----+------------+--+--------------------------------><
              '-domain-----'
 

Parameters

all-local
Backs up all local volumes. This is the default.

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

A volume name must be enclosed in quotes if it includes any spaces.

Examples

Preferences file:
domain "la pomme"

Errorlogname

The errorlogname option specifies the fully-qualified path and file name of the file where you want to store information about errors that occur during processing. The value for this option overrides the DSM_LOG environment variable.

Syntax

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

Parameters

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

The default file name is TSM Error Log; it is placed in your TSM application folder.

Examples

Preferences file:
errorlogname "SupDrive:tsm Error Log"

Errorlogretention

The errorlogretention option specifies how many days to maintain error log entries before pruning, and whether to save the pruned entries. The error log is pruned when the first error is written to the log after a TSM session is started. If the only session you run is the client scheduler, and you run it twenty-four hours a day, the error log might not be pruned according to your expectations. Stop the session and start it again to prune the error log when the next error is written.

Syntax

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

Parameters

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

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

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

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

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

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

The pruned entries are copied from the error log to TSM Error Pruned Log.

Examples

Preferences file:
errorlogretention 400 S

Exclude Options

The exclude options exclude objects from backup, or archive services. For example, you might want to exclude all temporary files, any local caches of network files, all files that contain compiled object code that you can easily reproduce using other methods, or your operating system files.

Exclude any system files that could corrupt the operating system when recovered. The client directory where TSM is stored should be excluded, also.

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.

Notes:

  1. If you change your include-exclude list so that a previously included file is now excluded, any pre-existing backup versions of that file become inactive the next time an incremental backup is run.

  2. These options can be defined on the server with the inclexcl option.

Syntax

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

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

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

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

exclude.dir
Excludes an entire directory that matches the pattern from backup services only.

If a matching directory is found, that directory, its files, and all its subdirectories and their files are excluded from backup services.

When you exclude a directory, you can still back up specific files within that directory, using a selective backup. However, the next time you perform an incremental backup, these backup versions are expired.

The exclude.dir option works only if the excluded directory is a subdirectory.

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

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

Parameters

pattern
Specifies the file or group of files that you want to exclude from backup services. End the pattern with a file specification.

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

You cannot use the match-all character (or any wildcard character) when specifying the high-level qualifier of an object, only use it for the low-level qualifier.

Examples

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

Guitreeviewafterbackup

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

Syntax

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

Parameters

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

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

Examples

Preferences file:
guitreeviewafterbackup yes

Include Options

The include options specify one of the following:

If you do not assign a specific management class to objects, the default management class in the active policy set of your policy domain is used.

Note:You cannot use the include option to override an exclude.dir option.

See Chapter 7, "Creating an Include-Exclude List" for more information.

Note:These options can be defined on the server with the inclexcl option.

Syntax

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

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

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

Parameters

pattern
Specifies the objects to include for backup services or to assign a specific management class. End this variable with a file specification.

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

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

Examples

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

Language

The language option specifies the national language in which to present client messages.

You can use American English (AMENG) with all clients. Currently, you can use American English (AMENG) only.

Syntax

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

Parameters

language
Specifies the language you want to use.

Examples

Preferences file:
language ameng

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

Largecommbuffers

The largecommbuffers option specifies whether the client uses increased buffers to transfer large amounts of data between the client and the server. You can disable this option when your machine is running low on memory.

Syntax

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

Parameters

No
Specifies that increased buffers are not used to transfer large amounts of data to the server. This is the default.

Yes
Specifies that increased buffers are used to transfer large amounts of data to the server.

Examples

Preferences file:
largecommbuffers yes

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

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.

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.

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

The maxcmdretries option specifies the maximum number of times the client scheduler (on your workstation) attempts to process a scheduled command that fails. The command retry starts only if the client scheduler has not yet backed up a file, never connected to the server, or failed before backing up a file. This option is used only when the scheduler is running.

Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides what you specify in the Preferences file after your client node successfully contacts the server.

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

Syntax

>>-MAXCMDRetries- maxcmdretries--------------------------------><
 

Parameters

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

Examples

Preferences file:
maxcmdr 4

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 when your machine is memory constrained.

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

Syntax

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

Parameters

No
Your client node uses the faster, more memory-intensive method when processing incremental backups.

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

Examples

Preferences file:
memoryefficientbackup yes

Nodename

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

You can also use the nodename option if you want to restore or retrieve files from the server while you are working from a different workstation. When you use the nodename option, you are prompted for the TSM password assigned to the node you specify, if a password is required.

If you do not specify this option in the Preferences file, TSM prompts you for the node name when it starts.

Syntax

>>-NODename- nodename------------------------------------------><
 

Parameters

nodename
Specifies a one to 64 character node name for which you want to request TSM services. The default is the name of the machine.

Permit the node name to default to the machine name.

Examples

Preferences file:
nodename cougar

Numberformat

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

Syntax

>>-NUMberformat- number----------------------------------------><
 

Parameters

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

1
1,000.00 (This is the default)

2
1,000,00

3
1 000,00

4
1 000.00

5
1.000,00

6
1'000,00

Examples

Preferences file:
num 4

Password

The password option specifies a TSM password. If this option is not used and your administrator has set authentication to On, you are prompted for a password when you start a TSM session.

Note:If you are prompted for a password, it is not displayed as you enter it. However, if you use the password option, your password is displayed when you enter it.

The password option is ignored when the passwordaccess option is set to generate.

Syntax

>>-PASsword- password------------------------------------------><
 

Parameters

password
Specifies a one 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

Preferences file:
password secretword

Passwordaccess

The passwordaccess option specifies whether you want your TSM password generated automatically, or set as a user prompt. A password is required for your client node only when your administrator enables the authentication feature. Check with your administrator to verify that a password is required for your client node.

If a password is required, you can choose to:

Use the passworddir option in your Preferences 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.

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.

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

A password prompt displays when registering a workstation with a server using open registration, or if your password was changed manually by the administrator.

Examples

Preferences file:
passwordaccess generate

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

Passworddir

The passworddir option forces the directory location in which to store an encrypted password file. The default directory location depends upon how the client was installed.

Syntax

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

Parameters

directoryname
Specifies the path in which to store the encrypted password file. The actual name of the password file is derived from the servername option.

Examples

Preferences file:
passworddir "SecDrive:tsm Security"

Postschedulecmd/Postnschedulecmd

The postschedulecmd option specifies a command that the client program processes after it runs a schedule. The client program waits for the command to complete before it continues with other processing.

If you do not want to wait, specify postnschedulecmd.

Note:The postschedulecmd option (and the postnschedulecmd option) can be defined on the server.

Syntax

>>-+-POSTSchedulecmd--+--- "cmdstring"-------------------------><
   '-POSTNschedulecmd-'
 

Parameters

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

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

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

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

The command string should specify an AppleScript to launch. If it is only a file name, such as "Database Script", the client program searches for this file in the Scripts folder inside the TSM folder. Otherwise, the command string should contain the full path of the file, such as:

   "La Pomme:Scripting:Database Script"

Examples

Preferences file:
postschedulecmd "restart database"

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

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

Preschedulecmd/Prenschedulecmd

The preschedulecmd option specifies a command that the client program processes before it runs a schedule. The client program waits for the command to complete before it starts the schedule.

If you do not want it to wait, specify prenschedulecmd.

Note:The preschedulecmd option (and the prenschedulecmd option) can also be defined on the server.

Syntax

>>-+-PRESchedulecmd--+--- "cmdstring"--------------------------><
   '-PRENSchedulecmd-'
 

Parameters

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

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

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

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

The command string should specify an AppleScript to launch. If it is only a file name, such as "Database Script", the client program searches for this file in the Scripts folder inside the TSM folder. Otherwise, the command string should contain the full path of the file, such as:

   "La Pomme:Scripting:Database Script"

Examples

Preferences file:
preschedulecmd "quiesce database"

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

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

Queryschedperiod

The queryschedperiod option specifies the number of hours you want the client scheduler to wait between attempts to contact the server for scheduled work. This option applies only when you set the schedmode option to polling. This option is used only when the scheduler is running.

Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides the value set in your Preferences file after your client node successfully contacts the server.

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

Syntax

>>-QUERYSCHedperiod- hours-------------------------------------><
 

Parameters

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

Examples

Preferences file:
querysch 6

Quiet

The quiet option limits the number of messages that display on your screen during processing.

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

Note:The quiet option can also be defined on the server and overrides the client setting.

Syntax

>>-QUIET-------------------------------------------------------><
 

Examples

Preferences file:
quiet

Resourceutilization

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

When a backup or archive operation is requested, the TSM client can use more than one session to the TSM server. The default is to use a maximum of two sessions; one to query the server, and one to send file data. The client is restricted to a single server session when a resourceutilization setting of 1 is specified..

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

The following factors can affect the throughput of multiple sessions:

Potentially undesirable aspects of running multiple sessions include:

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

Syntax

>>-RESOURceutilization- number---------------------------------><
 

Parameters

number
Specifies the level of resources the TSM server and client can use during processing. The range of values that you can specify is one through 10.

Examples

Preferences file:
resourceutilization 7

Retryperiod

The retryperiod option specifies the number of minutes the client scheduler waits between attempts to process a scheduled command that fails, or between unsuccessful attempts to report results to the server. This option is used only when the scheduler is running.

Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides the value specified in your Preferences file after your client node successfully contacts the server.

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

Syntax

>>-RETRYPeriod- minutes----------------------------------------><
 

Parameters

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

Examples

Preferences file:
retryp 10

Schedcompleteaction

The schedcompleteaction option specifies an action to take when a schedule completes. This option is used only when the scheduler is running.

Syntax

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

Parameters

Quit
The scheduler application quits when a schedule completes.

SHUTdown
Shuts down your machine 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 machine from shutting down until the prompt is dismissed.

Examples

 

Preferences file:
schedcompleteaction shutdown

Schedlogname

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

Syntax

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

Parameters

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

If you specify a file name only, the file is stored in your default folder. The default is the TSM application folder and a file name of TSM Schedule Log.

Examples

Preferences file:
schedlogn "SupDrive:David Sched Log"

Schedlogretention

The schedlogretention option specifies the number of days to keep entries in the schedule log, and whether to save the pruned entries. The schedule log is pruned after a scheduled event completes.

Syntax

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

Parameters

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

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

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

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

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

S
Saves the log entries when pruning the log.

TSM copies the entries pruned from the log to TSM Sched Pruned Log.

Examples

Preferences file:
schedlogretention 30 S

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.

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

Syntax

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

Parameters

No
You are not prompted for your choice. The server waits for the appropriate tape to mount. This is the default.

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

Examples

Preferences file:
tapeprompt yes

Tcpbuffsize

The tcpbuffsize option specifies the size of the internal TCP/IP communication buffer. Although it uses more memory, a larger buffer can improve communication performance.

Syntax

>>-TCPBuffsize- size-------------------------------------------><
 

Parameters

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

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

Examples

Preferences file:
tcpb 2

Tcpport

The tcpport option specifies a TCP/IP port address for a server. You can obtain this address from your administrator. This option is required in your Preferences file.

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

Preferences file:
tcpp 1501

Tcpserveraddress

The tcpserveraddress option specifies the TCP/IP address for a server. You can obtain this port address from your administrator. This option is required in your Preferences file.

Syntax

>>-TCPServeraddress- server_address----------------------------><
 

Parameters

server_address
Specifies a one to 64 character TCP/IP address for a server. Specify a TCP/IP domain name or a dot address.

Examples

Preferences file:
tcps dsmchost.endicott.ibm.com

Tcpwindowsize

The tcpwindowsize option specifies the amount of data in kilobytes that is buffered when receiving data on a TCP/IP connection. To improve backup or archive performance, increase the tcpwindowsize on the TSM server. To improve restore or retrieve performance, increase the tcpwindowsize on the TSM client. For more information about improving communication performance, see the ADSM Performance Tuning Guide at URL: http://www.tivoli.com/support/storage_mgr/tivolimain.html.

Syntax

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

Parameters

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

The range of values is one through 128; the default is 16.

Note:Depending on the operating system communication settings, your system might not accept all values in the range of values.

Examples

Preferences file:
tcpwindowsize 1

Timeformat

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

Syntax

>>-TIMEformat- format_number-----------------------------------><
 

Parameters

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

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

2
23,00,00

3
23.00.00

4
12:00:00 A/P

Examples

Preferences file:
timeformat 4

Verbose

The verbose option specifies that you want processing information to display on your screen. This is the default.

The information displays on your screen in the Scheduler Status window. This option only applies when you are running the Scheduler and TSM is performing scheduled work.

Note:This option can also be defined on the server and overrides the client setting.

Syntax

>>-VErbose-----------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Preferences file:
verbose


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]