You can use defaults for processing options or you can tailor the processing options to meet specific needs. This chapter:
As a quick reference, this chapter includes instructions for the following
tasks:
Task | Page |
---|---|
Setting Options in a File | "Setting Options in a File" |
Using Options with Commands | "Using Options with Commands" |
Tivoli Storage Manager uses processing options to control communications, backup-archive processing, and other types of processing.
This section provides an overview of the following options that you can enter in your client options file:
On UNIX systems, these options reside in three types of files:
On all other platforms, all options reside in the client options file (Preferences file for Macintosh) and an include-exclude options file.
You can enter common options with specific commands to override many of the options set in your client options file. Tivoli Storage Manager processes these options in the following order (precedence):
There are also options that are used only with commands. For more information about those options, see the following publications:
You use communication options to specify how your client node communicates
with a Tivoli Storage Manager server. Table 12 shows communication protocols supported for various Tivoli
Storage Manager client platforms. See "Options and Commands Available by Platform" for a list of options supported on each platform.
Table 12. Communication Protocols by Client
Protocol | Macintosh | NetWare | UNIX | Windows NT, 2000 | Windows 98, Me |
---|---|---|---|---|---|
IPX/SPX |
| x |
|
|
|
Named Pipes |
|
|
| x |
|
Shared Memory |
|
| x1 |
|
|
SNA LU6.2 |
| x |
|
|
|
TCP/IP | x | x | x | x | x |
|
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.
For UNIX: If you plan to back up an NFS system, see Nfstimeout.
Option | Description | Page |
---|---|---|
httpport | Specifies a TCP/IP port address for the Tivoli Storage Manager Web client. | Httpport |
httpsport | Specifies a TCP/IP port address for the HTTPS secure socket layer (SSL) interface to the Tivoli Storage Manager Web client. This option is for AIX, AIX 5L, and Windows clients only. | Httpsport |
lanfreetcpport | Specifies the TCP/IP port number where the Tivoli Storage Manager storage agent is listening. | Lanfreetcpport |
tcpbuffsize | Specifies the size, in kilobytes, of the Tivoli Storage Manager internal TCP/IP communication buffer. | Tcpbuffsize |
tcpnodelay | Specifies that Tivoli Storage Manager immediately sends small transactions to the server.This option is for a AIX and AIX 5L clients only. | Tcpnodelay |
tcpport | Specifies the TCP/IP port address for a Tivoli Storage Manager server. | Tcpport |
tcpserveraddress | Specifies the TCP/IP address for a Tivoli Storage Manager server. | Tcpserveraddress |
tcpwindowsize | Specifies the size, in kilobytes, of the TCP/IP sliding window for your client node. | Tcpwindowsize |
webports | Enables the use of the Web client outside a firewall by specifying the TCP/IP port number used by the Client Acceptor and the Web Client Agent service for communications with the Web GUI. | Webports |
The communication options for IPX/SPX have default values which you
can be modify.
Option | Description | Page |
---|---|---|
ipxbuffersize | Specifies the size, in kilobytes, of the IPX/SPX communication buffer. | Ipxbuffersize |
ipxserveraddress | Specifies the IPX/SPX address for a Tivoli Storage Manager server. | Ipxserveraddress |
ipxsocket | Specifies the IPX/SPX socket number for a Tivoli Storage Manager server. | Ipxsocket |
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 |
For NetWare: First, install SNA LU6.2 on the NetWare server. For information about how to install SNA, see Novell NetWare for SAA Version 1.3 Administration Guide (Document Number 100-001166-002).
To use SNA LU6.2 you must include either the
symbolicdestination option or all three of the following
options: cpicmodename, partnerluname, and
tpname.
Table 16. SNA LU6.2 (APPC) Options
Option | Description | Page |
---|---|---|
cpicbuffersize | The buffer size for SNA LU6.2 communication. | Cpicbuffersize |
cpicmodename | The mode name for SNA LU6.2 communication. | Cpicmodename |
partnerluname | A logical unit name used by the transaction program to identify the Tivoli Storage Manager server in the SNA network. | Partnerluname |
symbolicdestination | A symbolic Tivoli Storage Manager server name. | Symbolicdestination |
tpname | A symbolic name for a transaction program in an SNA network. The transaction program identifies the target logical unit (LU), which is the Tivoli Storage Manager server. | Tpname |
You must install TCP/IP on your workstation to use the shared memory
communication method.
Table 17. Shared Memory Communication Options
Option | Description | Page |
---|---|---|
shmport | Specifies the TCP/IP port address on which the server listens to establish a shared memory connection. | Shmport |
lanfreeshmport | Specifies the Shared Memory port number where the Tivoli Storage Manager storage agent is listening. Use this option when lanfreecommmethod=SHAREdmem is specified for communication between the Tivoli Storage Manager client and storage agent for processing between the client and the SAN-attached storage device. | Lanfreeshmport |
Use the following options to specify the server to contact for
backup-archive services, and the client node for which to request
backup-archive services.
Table 18. Server and Node Options
Option | Description | Page |
---|---|---|
defaultserver | The name of the Tivoli Storage Manager server to contact for
backup-archive services by default if more than one server is defined in the
client system options file (dsm.sys).
Also specifies the server to contact for space management services if you have the HSM client installed and do not specify a server with the migrateserver option. See Tivoli Space Manager for Unix Using the Hierarchical Storage Management Clients, SH26-4115 for more information. | Defaultserver |
clusternode | Specifies whether Tivoli Storage Manager is running as a cluster node. | Clusternode |
nasnodename | Specifies the node name for the NAS file server. | Nasnodename |
nodename | Specifies one of the following:
| Nodename |
servername | In the client system options file, this option specifies the name of a server. In the client user options file, this option specifies the Tivoli Storage Manager server to contact for services. | Servername |
virtualnodename | Specifies the name of another client node. Use this option if you want to restore or retrieve your files from a Tivoli Storage Manager server to a client node other than the one on which you stored files. | Virtualnodename |
You can use the following options to control some aspects of backup and
archive processing.
Table 19. Backup and Archive Processing Options
Option | Description | Page |
---|---|---|
archsymlinkasfile | Specifies whether you want Tivoli Storage Manager to follow a symbolic link and archive the file or directory it points to, or archive the symbolic link only. This option is for UNIX clients only. | Archsymlinkasfile |
automount | The automount option is used with the domain option to specify all automounted file systems in the domain that will be mounted when the Tivoli Storage Manager client starts, and included for backup services. This option is for UNIX clients only. | Automount |
autofsrename |
Specifies whether to rename an existing file space on a Unicode-enabled
server so a Unicode-enabled file space can be created for the current
operation. This option is for Windows NT and Windows 2000 clients
only.
| Autofsrename |
backupregistry | Specifies whether to back up the Windows registry during domain incremental backup or backup which includes the Windows system drive. This option is for the Windows client only. | Backupregistry |
changingretries | Specifies the number of retries when attempting to back up or archive a file that is in use. | Changingretries |
compressalways | Specifies whether to continue compressing an object if it grows during compression, or resend the object uncompressed. This option is used with the compression option. | Compressalways |
compression | Specifies whether to compress files before sending them to the
server.
Note: The compression option also applies to migrated files if you install the Tivoli Storage Manager HSM client on your workstation. | Compression |
dfsbackupmntpnt | Specifies whether Tivoli Storage Manager sees a DFS (NTFS or FAT) as a junction or a directory. This option is valid for Windows 2000 only. | Dfsbackupmntpnt (Windows) |
dfsbackupmntpnt | Specifies whether you want Tivoli Storage Manager to see a DFS mount point as a mount point or as a directory. | Dfsbackupmntpnt (UNIX) |
dirmc | Specifies the management class to use for directories. If not specified, Tivoli Storage Manager uses the management class with the longest retention period. | Dirmc |
domain | Specifies the volumes, file systems, or drives to include in your default client domain for an incremental backup. | Domain |
domain.image | Specifies the file systems included in your default client domain for an image backup. This option is for AIX, AIX 5L, HP-UX, and Solaris only. | Domain.image |
domain.nas | Specifies the volumes to include in your default domain for nas backups. This option is for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only. | Domain.nas |
enablelanfree | Specifies whether to enable an available LAN-Free path to a storage area network (SAN) attached storage device. | Enablelanfree |
exclude | Excludes a file or group of files from backup services and space management services (if the HSM client is installed). Any file in your client domain that is not specifically excluded with this option is considered for backup. Equivalent to the exclude.backup, exclude.file, and exclude.file.backup options. | Exclude Options |
exclude.archive | Excludes a file or group of files from archive services. | Exclude Options |
exclude.backup | Excludes a file or a group of files from normal backup services, but not from HSM. | Exclude Options |
exclude.compression | Excludes files from compression processing. | Exclude Options |
exclude.dir | Excludes the specified directory, its files, and all its subdirectories and their files from backup services. | Exclude Options |
exclude.encrypt | Excludes specified files from encryption processing. | Exclude Options |
exclude.file | Excludes files, but not directories, that match a pattern. Equivalent to the exclude, exclude.file.backup, and exclude.backup options. | Exclude Options |
exclude.file.backup | Excludes a file from normal backup services. Equivalent to the exclude, exclude.file, and exclude.backup options. | Exclude Options |
exclude.fs | Excludes file spaces matching a pattern. This option is valid for all UNIX clients. | Exclude Options |
exclude.fs.nas | Excludes file systems on the NAS file server from an image backup when used with the backup nas command. If you do not specify a NAS node name, the file system identified applies to all NAS servers. The backup nas command ignores all other exclude statements including exclude.fs and exclude.dir statements. This option is for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only. | Exclude Options |
exclude.image | Excludes mounted file systems and raw logical volumes that match the pattern from image processing. This option is valid for AIX, AIX 5L, HP-UX, and Solaris only. | Exclude Options |
exclude.subfile | Excludes files from adaptive subfile backup processing. | Exclude Options |
guitreeviewafterbackup | Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. | Guitreeviewafterbackup |
inclexcl | Specifies the path and file name of an include-exclude options file. | Inclexcl |
include | Includes files or assigns management classes for backup or archive processing. | Include Options |
include.archive | Includes files or assigns management classes for archive processing. | Include Options |
include.backup | Includes files or assigns management classes for backup processing. | Include Options |
include.compression | Includes files for compression processing. | Include Options |
include.encrypt | Includes specified files for encryption processing. | Include Options |
include.file | Includes a file for backup services, or assigns a management class to a file. | Include Options |
include.fs.nas | Assigns a management class when used with the backup nas command. If you do not specify a NAS node name, the file system identified applies to all NAS file servers. The backup nas command ignores all other include statements. This option is for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only. | Include Options |
include.image | Includes a file space or logical volume, or assigns a management class when used with the backup image command. The backup image command ignores all other include options. | Include Options |
include.subfile | Includes files for adaptive subfile backup processing. | Include Options |
include.systemobject | Assigns management classes for backup of Windows 2000 system objects. By default, Tivoli Storage Manager binds all system objects to the default management class. You cannot use this option to bind individual systemobject components to a different management class. You cannot use this option to include or exclude a system object from processing. This option is valid for Windows 2000 only. | Include Options |
incrthreshold | The incrthreshold option specifies the threshold value for the number of directories in any journaled file space that might have active objects on the server, but no equivalent object on the workstation. | Incrthreshold |
memoryefficientbackup | Specifies a memory-saving backup algorithm for incremental backups when used with the incremental command. | Memoryefficientbackup |
nwignorecompressbit | Specifies whether you want to ignore the setting of the compressed file (Co) attribute during selection processing for incremental backups. | Nwignorecompressbit |
skipntpermissions | Specifies whether to back up Windows NT, 2000 security information. | Skipntpermissions |
skipntsecuritycrc | Specifies whether to compute the security CRC for permission comparison during subsequent backups. Use this option on Windows NT, 2000 only. | Skipntsecuritycrc |
subdir | Specifies whether to include subdirectories of a named directory. | Subdir |
subfilebackup | Specifies whether Tivoli Storage Manager uses adaptive subfile backup. This option is for the Windows client only. | Subfilebackup |
subfilecachepath | Specifies the path where the client cache resides for adaptive subfile backup processing. This option is for the Windows client only. | Subfilecachepath |
subfilecachesize | Specifies the client cache size for adaptive subfile backup. This option is for the Windows client only. | Subfilecachesize |
tapeprompt | Specifies whether you want Tivoli Storage Manager to wait for a tape required for a backup or archive to be mounted, or whether to prompt you for your choice. | Tapeprompt |
virtualmountpoint | Specifies a directory to serve as a virtual mount point for a file system. This provides a direct path to the files you want Tivoli Storage Manager to consider for backup, saving processing time. | Virtualmountpoint |
The following options relate to restore and retrieve processing.
Table 20. Restore and Retrieve Processing Options
Option | Description | Page |
---|---|---|
activatekey | Specifies whether to activate the registry key to update the registry after restoring files. | Activatekey |
followsymbolic | Specifies that you want to restore files to symbolic links, and permit a symbolic link to be used as a virtual mount point. | Followsymbolic |
guitreeviewafterbackup | Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. | Guitreeviewafterbackup |
localbackupset | Specifies whether the Tivoli Storage Manager GUI bypasses initial logon with the server to restore a local backup set on a Windows or UNIX standalone workstation. | Localbackupset |
replace | Specifies whether to overwrite an existing file, or to prompt you for your selection when you restore or retrieve files. | Replace |
subdir | Specifies whether you want to include subdirectories of a named directory. | Subdir |
tapeprompt | Specifies whether you want Tivoli Storage Manager to wait for a tape required for a restore or retrieve to be mounted, or to prompt you for your choice. | Tapeprompt |
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 |
schedcompleteaction | Specifies an action to take after a schedule has been completed. This option is for the Macintosh client only. | Schedcompleteaction |
schedlogname | Specifies the name of the file where schedule log information is stored. | Schedlogname |
schedlogretention | Specifies the number of days to keep log file entries in the schedule log, and whether to save pruned entries. | Schedlogretention |
schedmode | Specifies which schedule mode to use, polling or prompted. | Schedmode |
tcpclientaddress | Specifies the TCP/IP address of your client node. Use this option only with the schedule command when you specify prompted as the schedule mode. | Tcpclientaddress |
tcpclientport | Specifies the TCP/IP port number of your client node. Use this option only with the schedule command when you specify prompted as the schedule mode. | Tcpclientport |
You can use the following options to select different formats for date,
time, and numbers, and for different languages if you have the appropriate
client installed for that language.
Table 22. Format and Language Options
Option | Description | Page |
---|---|---|
dateformat | Specifies the format for displaying dates. | Dateformat |
language | Specifies the language used for messages. | Language |
numberformat | Specifies the format for displaying numbers. | Numberformat |
timeformat | Specifies the format for displaying time. | Timeformat |
The following options apply when you use Tivoli Storage Manager
commands.
Table 23. Command Processing Options
Option | Description | Page |
---|---|---|
editor | Specifies if the command-line interface editor and command retrieve capability is turned on or off. | Editor |
guitreeviewafterbackup | Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. | Guitreeviewafterbackup |
matchallchar | Specifies the character to use as a match-all wildcard character. This option is for the Macintosh client only. | Matchallchar |
matchonechar | Specifies the character to use as a match-one-character wildcard character. This option is for the Macintosh client only. | Matchonechar |
quiet | Specifies that processing information does not display on your screen. This option can be overidden by the server. | Quiet |
scrolllines | Specifies the number of lines to display at one time when displaying a list of items. Use this option only when scrollprompt is set to yes. | Scrolllines |
scrollprompt | Specifies whether Tivoli Storage Manager stops after displaying the number of lines specified by scrolllines, or it scrolls to the end of the list. | Scrollprompt |
verbose | Specifies that processing information should display on your screen. The alternative is quiet. This option can be overridden by the server. | Verbose |
These options control access to a Tivoli Storage Manager server.
Table 24. Authorization Options
Option | Description | Reference |
---|---|---|
encryptkey | Specifies whether to save the encryption key locally or whether to prompt the user for the encryption key. | Encryptkey |
groups | Specifies the groups on your workstation that you want to authorize to request services from the server. | Groups |
mailprog | Specifies the program and user ID where you want to send a newly generated password when the old one expires. | Mailprog |
nwpwfile | Specifies whether to encrypt and save a NetWare user's ID and password to the TSM.PWD file. | Nwpwfile |
nwuser | Specifies a user ID and password to connect to a NetWare server when you start a session. | Nwuser |
optfile | Specifies the options file you want to use when you start a session. | Optfile |
password | Specifies a Tivoli Storage Manager password. | Password |
passwordaccess | Specifies how Tivoli Storage Manager handles a password if one is required for your workstation. | Passwordaccess |
passworddir | Specifies the directory in which you want to store the automatically generated password for your client node. The password is stored in the TSM.PWD file. This option is for Macintosh, NetWare and UNIX clients only. | Passworddir |
revokeremoteaccess | Restricts an administrator with client access privileges from accessing your workstation through the Web client. | Revokeremoteaccess |
users | Specifies users on your workstation who can request services from a server. | Users |
These options specify the name of the error log file and how Tivoli Storage
Manager treats the entries in the log file.
Table 25. Error Processing Options
Option | Description | Page |
---|---|---|
errorlogname | Specifies the path and name of the error log. | Errorlogname |
errorlogretention | Specifies the number of days to keep log file entries in the error log, and whether to save pruned entries. | Errorlogretention |
nwwaitonerror | Specifies whether an error message is displayed if an error occurs while exiting a session. If this option is set to no, the window closes automatically, and the client program returns to the NetWare console. | Nwwaitonerror |
These options control how Tivoli Storage Manager processes transactions
between the client and server.
Table 26. Transaction Processing Options
Option | Description | Page |
---|---|---|
commrestartduration | Specifies the maximum number of minutes you want the client to try to reconnect to a Tivoli Storage Manager server after a communication error occurs. | Commrestartduration |
commrestartinterval | Specifies the number of seconds you want the client to wait between attempts to reconnect to a Tivoli Storage Manager server after a communication error occurs. | Commrestartinterval |
largecommbuffers | Specifies whether the client will use increased buffers to transfer large amounts of data between the client and the server. | Largecommbuffers |
nfstimeout | Specifies the amount of time, in seconds, Tivoli Storage Manager waits for an NFS system call response before timing out. | Nfstimeout |
resourceutilization | Specifies the number of sessions opened between the Tivoli Storage Manager server and client during processing. | Resourceutilization |
txnbytelimit | Specifies the number of kilobytes Tivoli Storage Manager can buffer together in a transaction before sending data to the server. | Txnbytelimit |
usedirectory | Specifies whether the client should ignore commmethod parameters set in the client options file and query the Active Directory for the communication method and server with which to connect. Use with Windows 2000 only. | Usedirectory |
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 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.
You can edit the client options file or Preferences file (Macintosh) with your favorite text editor.
To set an option in your client options file, enter the option name and one or more blank spaces, followed by the option value. For example:
compression yes nodename client_a
Some options consist of only the option name, such as verbose and quiet. You can enter the entire option name or its abbreviation. For example, you can specify the verbose option as either of the following:
verbose ve
Follow these additional rules when entering options in your client options file:
For NetWare: The maximum number of characters in a file name is 256. The maximum combined length of the file name and path name is 512 characters.
For UNIX: The maximum number of characters in a file name is 256. The maximum combined length of the file name and path name is 1024 characters.
For Windows: The maximum number of characters in a file name is 256. The maximum combined length of the file name and path name is 256 characters.
If you update the client options file while a GUI or Web client session is active, you must restart the session to pick up the changes. If you use the Setup Wizard to make changes, the changes are effective immediately.
You can override some of the options in your options file by entering them with appropriate backup-archive commands. You cannot override options by entering them with HSM commands. See the following client publications for more information:
The following sections contain detailed information about each of the Tivoli Storage Manager processing options. Information for each option includes:
Tivoli Storage Manager processing options reside in these files:
This file contains required communication options, authorization options, a subset of options that relate to backup and archive processing, scheduling options, and options that relate to HSM.
If you are a root user, you are responsible for creating and modifying the client system options file.
The client user options file contains options that control processing for sessions with Tivoli Storage Manager, including some additional options that relate to backup, archive, restore, and retrieve processing.
If you are a root user, you create a default client user options file for all users on your workstation.
If you want to use different options than those specified in the default client user options file, you can create your own options file.
Any option that you can use on the command line will override settings in the client options file. For more information, see Using Options with Commands.
The include-exclude options file contains a list of the include and exclude options. See Chapter 7, Creating an Include-Exclude List for detailed examples for each platform.
Table 28 lists the common options available for all
supported platforms.
Table 28. Common Options Available by Platform
Common Options | Macintosh | NetWare | UNIX | Windows NT, 2000 | Windows 98, Me |
---|---|---|---|---|---|
activatekey |
|
|
| x | x |
afsbackupmntpnt |
|
| x |
|
|
archsymlinkasfile |
|
| x |
|
|
autofsrename |
|
|
| x |
|
automount |
|
| x6 |
|
|
backupregistry |
|
|
| x | x |
changingretries | x | x | x | x | x |
clusternode |
|
|
| x |
|
commmethod | x | x | x | x | x |
commrestartduration | x | x | x | x | x |
commrestartinterval | x | x | x | x | x |
compressalways | x | x | x | x | x |
compression | x | x | x | x | x |
cpicbuffersize |
| x |
|
|
|
cpicmodename |
| x |
|
|
|
dateformat | x | x | x | x | x |
defaultserver |
|
| x |
|
|
dfsbackupmntpnt (Windows) |
|
|
| x4 |
|
dfsbackupmntpnt (UNIX) |
|
| x |
|
|
dfsinclexcl |
|
| x |
|
|
dirmc | x | x | x | x | x |
domain | x | x | x | x | x |
domain.image |
|
| x1 |
|
|
domain.nas |
|
| x5 | x |
|
editor |
| x | x3 | x | x |
enablelanfree |
|
| x5 | x |
|
encryptkey |
| x | x | x | x |
errorlogname | x | x | x | x | x |
errorlogretention | x | x | x | x | x |
exclude | x | x | x | x | x |
exclude.archive | x | x | x | x | x |
exclude.backup | x | x | x | x | x |
exclude.compression |
| x | x | x | x |
exclude.dir | x | x | x | x | x |
exclude.encrypt |
| x | x | x | x |
exclude.file | x | x | x | x | x |
exclude.file.backup | x | x | x | x | x |
exclude.fs |
|
| x |
|
|
exclude.fs.nas |
|
| x5 | x |
|
exclude.image |
|
| x1 |
|
|
exclude.subfile |
|
|
| x | x |
followsymbolic |
|
| x |
|
|
groups |
|
| x |
|
|
guitreeviewafterbackup | x |
| x | x | x |
httpport |
| x | x | x | x |
httpsport |
|
| x2 | x | x |
inclexcl | x | x | x | x | x |
include | x | x | x | x | x |
include.archive | x | x | x | x | x |
include.backup | x | x | x | x | x |
include.compression |
| x | x | x | x |
include.encrypt |
| x | x | x | x |
include.file | x | x | x | x | x |
include.fs.nas |
|
| x5 | x |
|
include.image |
|
| x1 |
|
|
include.subfile |
|
|
| x | x |
include.systemobject |
|
|
| x4 |
|
incrthreshold |
|
|
| x |
|
ipxbuffersize |
| x |
|
|
|
ipxserveraddress |
| x |
|
|
|
ipxsocket |
| x |
|
|
|
lanfreecommmethod |
|
| x5 | x |
|
lanfreeshmport |
|
| x5 |
|
|
lanfreetcpport |
|
| x5 | x |
|
language | x | x |
| x | x |
largecommbuffers | x | x | x | x | x |
localbackupset |
|
| x | x | x |
mailprog |
|
| x |
|
|
managedservices |
| x | x | x | x |
matchallchar | x |
|
|
|
|
matchonechar | x |
|
|
|
|
maxcmdretries | x | x | x | x | x |
memoryefficientbackup | x | x | x | x | x |
namedpipename |
|
|
| x |
|
nasnodename |
|
| x5 | x |
|
nfstimeout |
|
| x |
|
|
nodename | x | x | x | x | x |
numberformat | x | x | x | x | x |
nwignorecompressbit |
| x |
|
|
|
nwpwfile |
| x |
|
|
|
nwuser |
| x |
|
|
|
nwwaitonerror |
| x |
|
|
|
optfile |
| x | x | x | x |
partnerluname |
| x |
|
|
|
password | x | x | x | x | x |
passwordaccess | x | x | x | x | x |
passworddir | x | x | x |
|
|
postnschedulecmd | x |
| x | x | x |
postschedulecmd | x | x | x | x | x |
prenschedulecmd | x |
| x | x | x |
preschedulecmd | x | x | x | x | x |
processorutilization |
| x |
|
|
|
queryschedperiod | x | x | x | x | x |
quiet | x | x | x | x | x |
replace |
| x | x | x | x |
resourceutilization | x | x | x | x | x |
retryperiod | x | x | x | x | x |
revokeremoteaccess |
| x | x | x | x |
runasservice |
|
|
| x |
|
schedcmddisabled |
| x | x | x | x |
schedcompleteaction | x |
|
|
|
|
schedlogname | x | x | x | x | x |
schedlogretention | x | x | x | x | x |
schedmode |
| x | x | x | x |
scrolllines |
| x | x | x | x |
scrollprompt |
| x | x | x | x |
servername |
|
| x |
|
|
shmport |
|
| x1 |
|
|
skipntpermissions |
|
|
| x |
|
skipntsecuritycrc |
|
|
| x |
|
subdir |
| x | x | x | x |
subfilebackup |
|
|
| x | x |
subfilecachepath |
|
|
| x | x |
subfilecachesize |
|
|
| x | x |
symbolicdestination |
| x |
|
|
|
tapeprompt | x | x | x | x | x |
tcpbuffsize | x | x | x | x | x |
tcpclientaddress |
| x | x | x | x |
tcpclientport |
| x | x | x | x |
tcpnodelay |
|
| x2 | x | x |
tcpport | x | x | x | x | x |
tcpserveraddress | x | x | x | x | x |
tcpwindowsize | x | x | x | x | x |
timeformat | x | x | x | x | x |
tpname |
| x |
|
|
|
txnbytelimit |
| x | x | x | x |
usedirectory |
|
|
| x4 |
|
users |
|
| x |
|
|
verbose | x | x | x | x | x |
virtualmountpoint |
|
| x |
|
|
virtualnodename | x | x | x | x | x |
webports |
| x | x | x | x |
|
This publication does not document Tivoli Storage Manager client
command line options or commands. For detailed information
about client command line options and commands, see the following
publications:
Table 29. Tivoli Storage Manager Client Publications
Publication Title | Order Number |
---|---|
Tivoli Storage Manager for Windows Using the Backup-Archive Clients | SH26-4117 |
Tivoli Storage Manager for NetWare Using the Backup-Archive Client | SH26-4116 |
Tivoli Storage Manager for UNIX Using the Backup-Archive Clients | SH26-4122 |
Table 30. Command Line Options Available by Platform
Command Line Options | NetWare | UNIX | Windows NT, 2000 | Windows 98, Me |
---|---|---|---|---|
archmc | x | x | x | x |
class |
| x1 | x |
|
deletefiles | x | x | x | x |
description | x | x | x | x |
detail | x | x | x | x |
dirsonly | x | x | x | x |
filelist | x | x | x | x |
filesonly | x | x | x | x |
fromdate | x | x | x | x |
fromnode | x | x | x | x |
fromowner |
| x |
|
|
fromtime | x | x | x | x |
ifnewer | x | x | x | x |
inactive | x | x | x | x |
incrbydate | x | x | x | x |
incremental |
| x |
|
|
latest | x | x | x | x |
location | x | x | x | x |
mode |
| x | x | x |
monitor |
| x1 | x |
|
nojournal |
|
| x |
|
noprompt | x | x | x | x |
pick | x | x | x | x |
pitdate | x | x | x | x |
pittime | x | x | x | x |
preservepath | x | x | x | x |
todate | x | x | x | x |
totime | x | x | x | x |
type |
| x1 | x |
|
v2archive | x | x | x | x |
volinformation | x | x |
|
|
|
Table 31 lists the commands available for all
supported platforms.
Table 31. Commands Available by Platform
Commands | NetWare | UNIX | Windows NT, 2000 | Windows 98, Me |
---|---|---|---|---|
archive | x | x | x | x |
backup activedirectory |
|
| x3 |
|
backup certserverdb |
|
| x3 |
|
backup clusterdb |
|
| x3 |
|
backup complusdb |
|
| x3 |
|
backup eventlog |
|
| x |
|
backup frs |
|
| x3 |
|
backup image |
| x1 |
|
|
backup nas |
| x2 | x |
|
backup registry |
|
| x | x |
backup rsm |
|
| x |
|
backup sysfiles |
|
| x3 |
|
backup systemobject |
|
| x3 |
|
backup sysvol |
|
| x3 |
|
cancel process |
| x2 | x |
|
cancel restore | x | x | x | x |
delete access | x | x | x | x |
delete archive | x | x | x | x |
delete filespace | x | x | x | x |
expire | x | x | x | x |
help | x | x | x | x |
incremental | x | x | x | x |
loop | x | x | x | x |
macro | x | x | x | x |
monitor process |
| x2 | x |
|
query access | x | x | x | x |
query activedirectory |
|
| x3 |
|
query archive | x | x | x | x |
query backup | x | x | x | x |
query backupset | x | x | x | x |
query certserverdb |
|
| x3 |
|
query clusterdb |
|
| x3 |
|
query complusdb |
|
| x3 |
|
query eventlog |
|
| x3 |
|
query filespace | x | x | x | x |
query frs |
|
| x3 |
|
query image |
| x1 |
|
|
query inclexcl | x | x | x | x |
query mgmtclass | x | x | x | x |
query node |
| x2 | x |
|
query registry |
|
| x3 |
|
query restore | x | x | x | x |
query rsm |
|
| x3 |
|
query schedule | x | x | x | x |
query session | x | x | x | x |
query sysfiles |
|
| x3 |
|
query systemobject |
|
| x3 |
|
query sysvol |
|
| x3 |
|
query tsa | x |
|
|
|
restart restore | x | x | x | x |
restore | x | x | x | x |
restore activedirectory |
|
| x3 |
|
restore backupset | x | x | x | x |
restore certserverdb |
|
| x3 |
|
restore clusterdb |
|
| x3 |
|
restore complusdb |
|
| x3 |
|
restore eventlog |
|
| x |
|
restore frs |
|
| x3 |
|
restore image |
| x1 |
|
|
restore nas |
| x2 | x |
|
restore registry |
|
| x | x |
restore rsm |
|
| x |
|
restore sysfiles |
|
| x3 |
|
restore systemobject |
|
| x3 |
|
restore sysvol |
|
| x3 |
|
retrieve | x | x | x | x |
schedule | x | x | x | x |
selective | x | x | x | x |
set access | x | x | x | x |
set password | x | x | x | x |
|
The activatekey option specifies whether to activate the registry key to update the registry after restoring files. Use this option with the restore registry command.
Supported Clients
This option is for Windows clients only.
Syntax
.-Yes-. >>-ACTIVATEkey--+-----+---------------------------------------->< '-No--'
Parameters
Examples
Root User
The afsbackupmntpnt option specifies whether you want Tivoli Storage Manager to see an AFS mount point as a mount point or as a directory. If Tivoli Storage Manager sees it as a mount point, it backs up only the name of the mounted volume during a backup operation. It does not back up the subtree by starting from the mount point directory.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) or the client options file (dsm.opt). Use this option with dsmafs and dsmcafs.
Syntax
.-Yes-. >>-AFSBackupmntpnt--+-----+------------------------------------>< '-No--'
Parameters
Examples
The archsymlinkasfile option specifies whether Tivoli Storage Manager follows a symbolic link and archives the file or directory it points to, or archives the symbolic link only. Use this option with the archive command.
Use the followsymbolic option to restore to a symbolic link (that is a virtual mount point). The followsymbolic option is not related to the archsymlinkasfile option.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-Yes-. >>-ARCHSYMLinkasfile-+-----+----------------------------------->< '-No--'
Parameters
Examples
The autofsrename option renames an existing file space on a server so that a Unicode-enabled file space with the original name can be created for the current operation. The server can define the autofsrename option and override the autofsrename setting on the client. This option is for Windows NT and Windows 2000 clients only.
When you specify autofsrename yes in your client options file, and the server value of autofsrename is set to client, Tivoli Storage Manager generates a unique name by appending _OLD to the file space name you specify in the current operation. For example, Tivoli Storage Manager renames the file space \\your-node-name\h$ to \\your-node-name\h$_OLD. If the new file space name is too long, the suffix replaces the last characters of the file space name, as follows:
\\your-node-name_OLD
If the new file space name already exists on the server, Tivoli Storage Manager renames the new file space \\your-node-name_OLDx, where x is a unique number.
Tivoli Storage Manager proceeds to create new Unicode-enabled file spaces that contain only the data specified in the current operation. For example, to archive files from your H-disk named \\your-node\h$, issue the following archive command:
arc h:\logs\*.log
Before the archive takes place, the server renames the file space to \\your-node\h$_OLD. The archive places the data specified in the current operation into the Unicode-enabled file space named \\your-node\h$. The new Unicode-enabled file space now contains only the \logs directory and the *.log files specified in the operation. Tivoli Storage Manager stores all subsequent full and partial incremental, selective backup, and archive data in the new Unicode-enabled file spaces.
Renamed file spaces remain on the server as stabilized file spaces. These file spaces contain all the original data, which you can restore as long as they remain on the server.
After installing the Windows NT, 2000 client, perform a full incremental backup and rename all existing file spaces that are not Unicode enabled and back up the files and directories within them under the new Unicode-enabled file spaces. This operation requires increased processing time and storage on the server.
File spaces that are not Unicode enabled can be viewed in the character set of the locale from which Tivoli Storage Manager backed up the files. A workstation running in a different locale may be unable to view or restore from these file spaces. Unicode-enabled file spaces that are backed up in one locale are visible in all other locales, provided that the workstation has the proper fonts installed. For more information on migrating to Unicode-enabled file spaces, see Migrating to the Unicode-Enabled TSM Client.
Place this option in the client options file (dsm.opt).
Supported Clients
This option is for Windows NT and Windows 2000 Unicode-enabled clients only.
Syntax
.-Prompt-. >>-AUTOFsrename-+--------+------------------------------------->< +-Yes----+ '-No-----'
Parameters
Considerations:
Examples
Authorized User (UNIX requires access authority)
The automount option specifies all automounted file systems in the domain that you want to mount when Tivoli Storage Manager starts so they can be included in backup processing. Use this option with the domain option.
It is unnecessary to explicitly specify the file system in the domain statement if the keywords all-auto-nfs or all-auto-lofs are used.
Supported Clients
This option is valid for all UNIX platforms except Linux86 and Linux390.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.- --------------. V | >>-AUTOMount--- filespacename-+--------------------------------><
Parameters
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.
Supported Clients
This option is for Windows clients only.
Syntax
.-Yes-. >>-BACKUPRegistry-+-----+-------------------------------------->< '-No--'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The changingretries option specifies how many additional times you want the client to attempt to back up or archive a file that is in use. Use this option with the archive, incremental, and selective commands.
Use this option only when serialization, an attribute in a management class copy group, is shared static or shared dynamic.
With shared static serialization, if a file is open during an operation, the operation repeats the number of times that you specified. If the file is open during each attempt, the operation does not complete.
With shared dynamic serialization, if a file is open during an operation, the operation repeats the number of times that you specified. The backup or archive occurs during the last attempt whether the file is open or not.
For NetWare: If the open file has the share flag set to deny_read, the client program cannot back it up.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.---------------. V | >>-CHAngingretries---numberretries-+---------------------------><
Parameters
Examples
Does not apply. (UNIX)
The clusternode option specifies whether Tivoli Storage Manager manages cluster drives in a Microsoft Cluster Server (MSCS) environment. For information on how to configure a cluster server, see Appendix F, "Configuring the Backup-Archive Client in a Microsoft Cluster Server Environment", SH26-4119.
Supported Clients
This option is for Windows NT and Windows 2000 clients only.
Syntax
.-No--. >>-CLUSTERnode-+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The commmethod option specifies the communication method you use to provide connectivity for client-server communication.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-COMMMethod-+- TCPip------+---------------------------------->< +- IPXspx-----+ +- NAMedpipes-+ +- SHAREdmem--+ '- SNALu6.2---'
Parameters
When specifying this communications method on AIX, you must be log in as root or have the same user ID as the process running the server.
When specifying this communications method on AIX, the API client user must log in as root or have the same user ID as the process running the server. This restriction does not apply if you alter your API program file permissions by using the following commands:
chown root.system your_api_program chmod u+s your_api_program
When specifying the Shared Memory communication method on AIX, the administrative client user must log in as root or have the same user ID as the process running the server. This restriction does not apply if you alter the administrative client programs file permissions by using the following commands:
cd /usr/tivoli/tsm/bin chown root.system dsmadm chmod u+s dsmadm chown root.system dsmadmc chmod u+s dsmadmc
Examples
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The commrestartduration option specifies the maximum number of minutes you want the client to attempt to reconnect with a server after a communication error occurs.
You can use the commrestartduration option and the commrestartinterval in busy or unstable network environments to decrease connection failures.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-COMMRESTARTDuration- minutes--------------------------------><
Parameters
Examples
Authorized User (UNIX requires access authority.)
The commrestartinterval option specifies the number of seconds you want the client to wait between attempts to reconnect with a server after a communication error occurs.
You can use the commrestartduration option and the commrestartinterval in busy or unstable network environments to decrease connection failures.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-COMMRESTARTInterval- seconds--------------------------------><
Parameters
Examples
The compressalways option specifies whether to continue compressing an object if it grows during compression, or resend the object uncompressed. Use this option with the compression option.
Use the compressalways option with the archive, incremental, and selective commands.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-Yes-. >>-COMPRESSAlways-+-----+-------------------------------------->< '-No--'
Parameters
Examples
This option is valid only on the initial command line.
Authorized User (UNIX requires access authority.)
The compression option compresses files before you send them to the server. Compressing your files reduces data storage for backup versions and archive copies of your files. It can, however, affect Tivoli Storage Manager throughput. A fast processor on a slow network connection benefits from compression, but a slow processor on a fast network connection does not.
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza.
Syntax
.-No--. >>-COMPRESSIon-+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
Does not apply. (UNIX)
The cpicbuffersize option specifies the size of the CPIC buffer for SNA LU6.2 communication. A larger buffer can improve communication performance, but uses more memory.
Supported Clients
This option is valid for the NetWare client only.
Syntax
>>-CPICBuffersize- size----------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The cpicmodename option defines the mode name for the SNA LU6.2 communication method. For CPIC, this option identifies the SNA connection to the gateway and target logical unit. The CPIC mode name is used if the symbolic destination is not provided and the partner LU is located on another system. The mode name must be known on both the local and remote systems.
If you use this option, you must also use the tpname and partnerluname options.
Supported Clients
This option is valid for the NetWare client only.
Syntax
>>-CPICModename- name------------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The dateformat option specifies the format you want to use to display dates.
For all clients except UNIX: Use this option if you want to change the default date format for the language of the message repository you are using.
The AIX, AIX 5L, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. Solaris and HP-UX clients only support English, Korean, Simplified Chinese, Traditional Chinese, and Japanese locale information. The default directories for system-supplied locales are as follows:
The backup-archive and administrative clients obtain format information from the locale definition in effect at the time you start the client. Consult the documentation on your local system for details about setting up your locale definition.
Notes:
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-DATEformat- format_number-----------------------------------><
Parameters
For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: This is the default if the locale-specified date format consists of anything but digits and separator characters.
For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: To set a particular date format, edit the source file for your locale and modify the d_fmt line to support your needs. Whatever date format you select applies both to output and to input; however, the input year can be either 2 or 4 digits.
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.
Authorized User (UNIX requires access authority.)
The defaultserver option specifies the default server to which you want to back up or archive files from your local systems.
If you have the HSM client installed on your workstation, and you do not specify a migration server with the migrateserver option, use this option to specify the server to which you want to migrate files. See Tivoli Space Manager for Unix Using the Hierarchical Storage Management Clients for more information.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas.
Syntax
>>-DEFAULTServer- servername-----------------------------------><
Parameters
Examples
The dfsbackupmntpnt option specifies whether Tivoli Storage Manager views a Microsoft DFS junction residing on an NTFS or FAT drive as a junction or a directory. If Tivoli Storage Manager views Microsoft DFS junction as a junction, only the name of the mounted junction is backed up or archived. The subtree under the junction point is not backed up or archived.
Place this option in the client options file (dsm.opt). You can specify this option by using the preferences editor.
This option is effective only when you back up or archive a Microsoft DFS root and is ignored when you back up or archive a Microsoft DFS junction. To restore a DFS tree, the root of the tree must already exist.
Supported Clients
This option is valid for Windows 2000 only.
Syntax
.-Yes-. >>-DFSBackupmntpnt-+-----+------------------------------------->< '-No--'
Parameters
Examples
Root User
The dfsbackupmntpnt option specifies whether you want Tivoli Storage Manager to see a DFS mount point as a mount point or as a directory. If Tivoli Storage Manager sees it as a mount point, it backs up only the name of the mounted fileset during a backup operation. It does not back up the subtree by starting from the mount point directory.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza, or in the client options file (dsm.opt). Use this option with dsmdfs and dsmcdfs.
Syntax
.-Yes-. >>-DFSBackupmntpnt--+-----+------------------------------------>< '-No--'
Parameters
Examples
Root User
If you use a DFS include-exclude options file, the dfsinclexcl option specifies the path and file name. You can use a DFS include-exclude options file to exclude DFS files or directories from backup. You can use a DFS include-exclude options file to assign different management classes to specific files or groups of files.
A DFS include-exclude options file pointed to by the dfsinclexcl option is used only when DFS files are examined for backup.
Attention: A separate DFS include-exclude options file is required because the prefix /... means the global root in DFS. In a DFS include-exclude options file, the /... prefix is interpreted as the global root of DFS, and the /... prefix is used to match zero or more directories.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-DFSInclexcl filespec----------------------------------------><
Parameters
Examples
Authorized User (UNIX requires access authority.)
The dirmc option specifies the management class you want to use for directories. If you do not specify this option to associate a management class with directories, the client program uses the management class in the active policy set of your policy domain with the longest retention period. Select a management class for individual directories that retains directories at least as long as it retains the files associated with them.
If you specify a management class with this option, all directories specified in a backup operation are bound to that management class.
The dirmc option specifies the management class of directories you back up and does not effect archived directories. Archived directories are always bound to the default management class.
The server can also define this option.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-DIRMc- mgmtclassname----------------------------------------><
Parameters
Examples
The domain option specifies the drives, volumes, or file systems that you want to include for incremental backup in your client domain. The server can also define this option.
Use the domain option in your client system options file or Preferences file to define your default client domain. Tivoli Storage Manager uses your default client domain in the following situations to determine which local drives, volumes, or file systems to process during an incremental backup:
If you do not use the domain option to specify local drives, volumes, or file systems in your client options or Preferences file, Tivoli Storage Manager uses the all-local parameter as the default.
When you use the domain option with the incremental command, Tivoli Storage Manager adds local drives, volumes, or file systems that you specify to the local drives, volumes, or file system defined in your client options or Preferences file. For example, if you enter the following in your client options file:
domain c: d: e: (Windows)
domain /home /usr /datasave (UNIX)
domain sys: data: bindery: (NetWare)
and the following on the command line:
dsmc incremental -domain="g: h:" (Windows)
dsmc incremental -domain="/fs1 /fs2" (UNIX)
load dsmc incremental -domain=usr: (NetWare)
Tivoli Storage Manager performs an incremental backup for your c: d: e: g: and h: local drives. (Windows)Tivoli Storage Manager performs an incremental backup for your /home, /usr, /datasave, /fs1, and /fs2 file systems (UNIX).Tivoli Storage Manager performs an incremental backup for your sys:, data:, and usr: volumes and the bindery: (NetWare).
If you use both a file specification and the domain option with the incremental command, Tivoli Storage Manager ignores the domain option and processes only those drives, volumes, or file systems specified in the file specification. For example, if you enter:
dsmc incremental e: f: -domain="g: h:" (Windows)
dsmc incremental /fs1 /fs2 -domain="/fs3 /fs4" (UNIX)Tivoli Storage Manager performs an incremental backup for the e: and f: drives only. (Windows)
Tivoli Storage Manager performs an incremental backup for the /fs1 and /fs2 file systems only. (UNIX)
Attention: If you are running GPFS for AIX in a multi-node cluster, and all nodes share a mounted GPFS file system, Tivoli Storage Manager processes this file system as a local file system. Tivoli Storage Manager backs up the file system on each node during an incremental backup. To avoid this, you can do one of the following:
When performing a backup with domain=all-local, files handled by automounter and loopback file systems are not backed up.
When performing a file system backup with domain=all-local, any subdirectories that are mount points for an automounted file system (autofs) are excluded from backup when the automounter has mounted these mount points. Any files that exist on the server for the automounted subdirectory are expired.
When performing a backup with domain=all-lofs, all explicit loopback file systems (lofs) are backed up and all automounted file systems are excluded. For loopback file systems handled by automounter, use domain=all-auto-lofs.
Only those automounted file systems that are mounted when the client starts, can be backed up using the domain option or the GUI. You cannot back up unmounted file systems monitored by an automounter.
You can use the automount option with the domain option to specify one or more file systems to be mounted when the client starts. See Automount for more information.
An automounted file system that is mounted when starting the client can be explicitly backed up by specifying the automounted file system with the incremental command. For example:
dsmc incremental autofs_name
Virtual mount points cannot be used with automounted file systems.
For HP-UX: The domain option is enhanced with the new keywords all-auto-lofs and all-auto-nfs to support automounted file systems. To use this enhancement, set the autofs parameter to 1 in the /etc/rc.config.d/nfsconf file. Changing this parameter requires a reboot. For further information please refer to the HP documentation on this issue.
The following UNIX platforms support automounter, LOFS, or LOFS
through automounter, as indicated:
Platform | automounter | LOFS | LOFS through automounter |
---|---|---|---|
AIX and AIX 5L | yes | yes | yes |
Solaris | yes | yes | yes |
HP-UX | yes | yes | no |
SGI | yes | no | yes |
Tru64 UNIX | yes | no | no |
NUMA-Q | yes | no | no |
OS/390 UNIX | yes | no | no |
Notes:
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) or the client user options file (dsm.opt).
Syntax
.- --------------------. V .-all-local--------. | >>-DOMain----+------------------+-+---------------------------->< +-domain-----------+ +-systemobject-----+ +-BINdery----------+ +-DIRectory or NDS-+ +-all-lofs---------+ +-all-nfs----------+ +-all-auto-nfs-----+ '-all-auto-lofs----'
Parameters
For UNIX: The /tmp directory is not included.
For NetWare: The NDS is not included in the all-local domain. To include the NDS, add the directory to the domain entry.
For Windows, NetWare, or UNIX: When you use domain with the incremental command, it processes these drives, volumes, or file systems in addition to those specified in your default client domain.
For Macintosh: A volume name must be enclosed in quotes if it includes any spaces.
For NetWare: The NDS is not included in the all-local domain. To include the NDS, add the directory to the domain entry.
Examples
domain c: d: e: (Windows)
domain c: systemobject (Windows 2000 only)
domain sys:tsm\nds (NetWare)
domain /tst /datasave /joe (UNIX) "domain all-local" (UNIX)
-domain="c: d:" (Windows)
-domain="servera\sys: serverb/sys:" (NetWare)
-domain=""/fs1 /fs2"" (UNIX) -domain=/tmp (UNIX)
The domain.image option specifies the mounted file systems and raw logical volumes that you want to include for an image backup in your client domain. Raw logical volumes must be named explicitly. Use this option in your client options file to define your default client image domain.
If you do not specify a file system with the backup image command, the file systems you specified with the domain.image option are backed up.
When you specify a file system with the backup image command, the domain.image option is ignored.
If you do not use the domain.image option to specify file systems in your client options file, and you do not specify a file system with the backup image command, a message is issued and no backup occurs.
Supported Clients
This option is for AIX, AIX 5L, HP-UX, and Solaris only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.- ----------. V | >>-DOMAIN.Image----+--------+-+-------------------------------->< '-domain-'
Parameters
Examples
The domain.nas option specifies the volumes to include in your NAS image backups. You can specify all-nas to include all the mounted file systems on the NAS file server, except those you exclude with the exclude.fs.nas option. When you use this option in your client system option file dsm.sys (UNIX) or client options file dsm.opt (Windows), the domain.nas option defines your default domain for NAS image backups.
Tivoli Storage Manager uses your domain for NAS image backups when you run a backup nas command and you do not specify which volumes to process.
When you perform a NAS file system image backup using the backup nas command, Tivoli Storage Manager adds volumes that you specify on the command line to the volumes defined in your dsm.sys (UNIX) or dsm.opt (Windows) file. For example, if you enter the following in your dsm.sys (UNIX) or dsm.opt (Windows) file:
domain.nas nas1/vol/vol0 nas1/vol/vol1
and you enter the following on the command line
dsmc backup nas -nasnodename=nas1 /vol/vol2
Tivoli Storage Manager performs a backup for the following volumes on node nas1: vol/vol0, vol/vol1, and vol/vol2.
When performing a backup, if you use a file specification and specify domain.nas=all-nas in the dsm.sys (UNIX) or dsm.opt (Windows) file, all-nas takes precedence. Tivoli Storage Manager processes all mounted volumes on the NAS file server.
The domain.nas option is valid for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only
Place this option in the client options file (dsm.opt).
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
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.
Supported Clients
This option is valid for the NetWare, UNIX (except OS/390 UNIX System Services), and Windows clients.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) or the client options file (dsm.opt).
Syntax
.-Yes-. >>-Editor-+-----+---------------------------------------------->< '-No--'
Parameters
Examples
Authorized User (UNIX requires access authority.)
The enablelanfree option specifies whether to enable an available LAN-Free path to a storage area network (SAN) attached storage device. A LAN-Free path allows backup, restore, archive, and retrieve processing between the Tivoli Storage Manager client and the SAN-attached storage device.
To support LAN-Free data movement you must install and configure the Tivoli Storage Manager Managed System for SAN feature on the client workstation. For more information, refer to the following publications:
For Windows NT, 2000: Place this option in the client options file (dsm.opt).
To specify a communication protocol between the Tivoli Storage Manager client and Storage Agent, see Lanfreecommmethod for more information.
Supported Clients
This option is valid for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-No--. >>-ENABLELanfree-+-----+--------------------------------------->< '-Yes-'
Parameters
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 TSM.PWD file (UNIX, NetWare) or the Registry (Windows) in encrypted format. If you save the encrypted key password, you are not prompted for it each time you perform a backup, archive, or restore. Place this option in your client options file or client system options file (UNIX).
Note: The Web client saves the encryption key password in the TSM.PWD file (UNIX, NetWare) or the Registry (Windows). If there no key is saved, you are prompted for the initial encryption key password when you begin encryption processing.
For UNIX: Both Authorized Users and non-root users can encrypt or
decrypt data during a backup or restore operation depending on the value you
specify for the passwordaccess option.
Operation | Passwordaccess Option | Encryptkey Option | Result |
---|---|---|---|
TSM Authorized Backup |
generate generate prompt prompt |
save prompt prompt save |
data encrypted data encrypted data encrypted data not encrypted |
TSM Authorized Restore | prompt | save | prompted for encryptkey password and data decrypted |
Non-Root User Backup |
generate generate prompt prompt |
prompt save prompt save |
data not encrypted data encrypted data not encrypted data not encrypted |
Non-Root User Restore |
generate generate prompt prompt |
prompt save prompt save |
menu to skip or proceed data decrypted menu to skip or proceed menu to skip or proceed |
Supported Clients
This option is for Windows, UNIX, and NetWare clients.
Syntax
.-save---. >>-ENCryptkey-+--------+--------------------------------------->< '-prompt-'
Parameters
Examples
Authorized User (UNIX requires access authority.)
The errorlogname option specifies the fully qualified path and file name of the file where you want to store information about errors that occur during processing. The value for this option overrides the DSM_LOG or DSM_DIR environment variables. The dsmwebcl.log and dsmsched.log files will be created in the same directory as dsmerror.log.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-ERRORLOGName- filespec--------------------------------------><
Parameters
For Windows or UNIX: The default is the path indicated by the DSM_LOG or DSM_DIR environment variable. If DSM_LOG or DSM_DIR are not specified, the dsmerror.log file will reside in the current working directory.
For UNIX: The dsmerror.log file cannot be a symbolic link.
For NetWare: The default file name is dsmerror.log; it is placed in your current working directory.
For Macintosh: The default file name is 'TSM Error Log'; it is placed in your current working directory.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The errorlogretention option specifies how many days to maintain error log entries before pruning, and whether to save the pruned entries. The error log is pruned when the first error is written to the log after a Tivoli Storage Manager session is started. If the only session you run is the client scheduler, and you run it twenty-four hours a day, the error log might not be pruned according to your expectations. Stop the session and start it again to prune the error log when the next error is written.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-N----. .-D-. >>-ERRORLOGRetention--+------+--+---+-------------------------->< '-days-' '-S-'
Parameters
For Windows, NetWare, or UNIX: The pruned entries are copied from the error log to the dsmerlog.pru file located in the same directory as the error log.
For Macintosh: The pruned entries are copied from the error log to TSM Error Pruned Log.
Examples
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The exclude options exclude objects from backup image, or archive services. For example, you might want to exclude all temporary files, any local caches of network files, all files that contain compiled object code that you can easily reproduce using other methods, or your operating system files.
For Windows, UNIX, and NetWare: You can exclude specific files from encryption processing during a backup.
For Windows: You can exclude remotely accessed files by specifying Universal Naming Convention (UNC) names in your exclude statement. See Tivoli Storage Manager for Windows Using the Backup-Archive Clients, SH26-4117, for examples of statements using UNC file names.
Notes:
Exclude any system files or images that could corrupt the operating system when recovered. You should also exclude the client directory containing the client files.
Use wildcard characters to exclude a broad range of files. See "Including and Excluding Groups of Files" for a list of wildcard characters that you can use. Then, if necessary, use the include option to make exceptions.
To exclude an entire directory called any/test (NetWare or UNIX) or any\test (Windows), enter the following:
exclude.dir c:\any\test (Windows)
exclude.dir /any/test (UNIX)
exclude.dir nw2:\sys:any/test (NetWare)
To exclude subdirectories that begin with test under the any directory, enter the following:
exclude.dir c:\any\test* (Windows)
exclude.dir /any/test* (for UNIX)
exclude.dir nw2:\sys:any/test* (for NetWare)
For NetWare: Wildcards are not supported for the server name or volume name. If you do not specify a server name, Tivoli Storage Manager uses the local server name.
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
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in an include-exclude options file or the client system options file (dsm.sys).
Syntax
.- ---------------. V | >>---options pattern-+-----------------------------------------><
For UNIX: If you have the Backup-Archive client and the HSM client installed on your workstation, use this option to exclude a file or group of files from both backup and space management services. Any files you exclude with this option are not considered for backup or migration.
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.
For UNIX: For the exclude.image option, the pattern is the name of a mounted file system or raw logical volume. Because this option excludes the entire named object and the files it contains from processing, you must use wildcards. For example, to exclude the /etc file system from image backup, enter the following:
exclude.image /etc/*/*
Please note, that this example does not conform with normal include-exclude wildcard processing for UNIX.
Examples
exclude ?:\...\swapper.dat exclude "*:\ea data. sf" exclude ?:\io.sys exclude ?:\...\spart.par exclude c:\*\budget.fin exclude c:\devel\* exclude.dir c:\home\jodda exclude.archive c:\home\*.obj exclude.encrypt c:\system32\mydocs\* exclude.compression c:\test\file.txt exclude.subfile c:\test\file.txt exclude.fs.nas netappsj/vol/vol0(NetWare)
exclude servera\*:.../swapper.dat exclude n1\*:io.sys exclude tfr\*:.../spart.par exclude nw2\sys:*/budget.fin exclude nw6\sys:devel/* exclude.archive servera*:/.../events.log exclude.compression nw6\sys:devel/* exclude.encrypt servera\*:.../gordon.dat(UNIX)
exclude /unix/ exclude /.../core exclude /home/jones/proj1/* exclude.archive /.../core exclude.backup /home/jones/proj1/devplan/ exclude.dir /home/jones/tmp exclude.backup /users/home1/file1 exclude.image /usr/*/* exclude.encrypt /users/home2/file1 exclude.compression /home/gordon/proj1/* exclude.fs.nas netappsj/vol/vol0
exclude "...:Desktop DB" exclude ":Norton FileSaver Data" exclude.archive "...:Desktop DF"
The followsymbolic option specifies whether you want to restore files to symbolic links or use a symbolic link as a virtual mount point. Use this option with the restore and retrieve commands.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-No--. >>-FOLlowsymbolic-+-----+-------------------------------------->< '-Yes-'
Parameters
Examples
Authorized User (UNIX requires access authority.)
The groups option specifies groups on your workstation that you want to authorize to request Tivoli Storage Manager services from the server. You can use the groups option more than once to specify several group names.
If you do not specify group names with the groups option, or user IDs with the users option, all users can request Tivoli Storage Manager services. If you use both the groups option and the users option, only users specified with these options can request Tivoli Storage Manager services. A root user is always authorized to request services.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.- ---------------------. | .- ----------. | V V | | >>---GRoups--- groupname-+-+-----------------------------------><
Parameters
Examples
groups dsmcdev group1 test1 test2 design1 groups endicott almaden qadev qadev1 tools23
Does not apply.
The guitreeviewafterbackup option specifies whether the client returns to the Backup, Restore, Archive, or Retrieve window after a successful operation completes.
Supported Clients
This option is valid for Macintosh, UNIX, and Windows clients.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt) or the client system options file (dsm.sys).
Syntax
.-No--. >>-GUITREEViewafterbackup-+-----+------------------------------>< '-Yes-'
Parameters
Examples
Authorized User (UNIX requires access authority.)
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 daemon and Web Client Agent service for communications with the Web GUI.
The ports you specify with the webports option and the client option httpport must be opened in the firewall.
To enable the backup-archive client, Command Line Admin client, and the Scheduler (running in polling mode) to run outside a firewall, the port specified by the server option tcpport (default 1500) must be opened in the firewall.
See Tcpport and Webports for more information.
Supported Clients
This option is valid on NetWare, all Windows clients, and all UNIX clients.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-HTTPport- port_address--------------------------------------><
Parameters
Examples
httpport 1502
-httpport=1502 (Windows Windows 98, Windows Me, NetWare)
Does not apply (UNIX)
Authorized User (UNIX requires access authority.)
The httpsport option specifies a TCP/IP port address for the HTTPS secure socket layer (SSL) interface to the Web client.
Supported Clients
This option is valid for AIX, AIX 5L, and all Windows clients.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-HTTPSport- port_address-------------------------------------><
Parameters
Examples
Does not apply (UNIX)
-httpsport (Windows 98, Me)
Authorized User (UNIX requires access authority.)
The inclexcl option specifies the path and file name of an include-exclude options file.
Place the inclexcl option in the include-exclude list in your client options file, Preferences file (Macintosh), or client system options file (UNIX).
Multiple inclexcl statements are permitted. However, you must specify this option for each include-exclude file.
Ensure that you soter your include-exclude options file in a directory to which all users have read access. For UNIX: Ensure that your include-exclude options file is stored in a directory such as /etc.
When processing occurs, the include-exclude statements within the include-exclude file are placed in the list position occupied by the inclexcl option and processed accordingly.
If you have the HSM client installed on your workstation, you can use an include-exclude options file to exclude files from backup and space management, from backup only or from space management only.
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".
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza.
Syntax
>>-INCLExcl- filespec------------------------------------------><
Parameters
Examples
(UNIX) inclexcl /usr/dsm/backup.excl inclexcl /etc/inclexcl.def
(Windows) inclexcl c:\dsm\backup.excl
(NetWare) inclexcl servera\sys:dsm/backup.excl
inclexcl La Pomme:Documents:backup.excl
Does not apply.
Authorized User (UNIX requires access authority)
The include options specify one of the following:
If you do not assign a specific management class to objects, Tivoli Storage Manager uses the default management class in the active policy set of your policy domain.
For Windows: You can include remotely accessed files by specifying Universal Naming Convention (UNC) names in your include statement. See Tivoli Storage Manager for Windows Using the Backup-Archive Clients, SH26-4117 for example statements using UNC file names.
Notes:
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the include-exclude options file or the client system options file (dsm.sys).
Syntax
.- -----------------------------------. V | >>---options pattern -+----------------+-+--------------------->< '- mgmtclassname-'
Parameters
If the pattern begins with a single or double quote or contains any embedded blanks or equal signs, you must surround the value in either single (') or double (") quotation marks. The opening and closing quotation marks must be the same type of quotation marks.
For UNIX: For the include.image option, the pattern is the name of a mounted file system or raw logical volume. Because this option includes the entire named object and the files it contains from processing, you must use wildcards. For example, to include the /etc file system for image backup, enter the following:
include.image /etc/*/*
Please note, that this example does not conform with normal include-exclude wildcard processing for UNIX.
Note: When using include.systemobject, the only valid pattern is ALL (all types of system objects). By default, Tivoli Storage Manager binds all system objects to the default management class.
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(NetWare)
include servera\sys:proj/text/devel.* include servera\sys:proj/text/* textfiles include *:* managall include.archive servera\sys:proj/text/* myarchiveclass include.backup servera\sys:proj/text/* mybackupclass include.compression servera\sys:proj/text/devel.* include.encrypt serverb\sys:proj/gordon/*(UNIX)
include /home/proj/text/devel.* include /home/proj/text/* textfiles include * managall include.image /home/*/* include.archive /home/proj/text/* myarchiveclass include.backup /home/proj/text/* mybackupclass include.compression /home/proj/text/devel.* include.encrypt /home/proj/gordon/* include.fs.nas netappsj/vol/vol0 homemgmtclass
include "...:Data:Test:Test*" include "...:System:...:*" mgmtcls1 include "...:*" managall
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).
See Tivoli Storage Manager for Windows Using the Backup-Archive Clients, SH26-4117 for more information about journaled backups.
Supported Clients
This option is for Windows NT, 2000 clients only.
Syntax
>>-INCRTHreshold--numberdirectories----------------------------><
Parameters
Examples
The ipxbuffersize option specifies the IPX buffer size needed to transfer data between the client node and the server. A larger buffer can improve communication performance, but uses more memory.
Supported Clients
This option is valid for the NetWare client only.
Syntax
>>-IPXBuffersize- size-----------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The ipxserveraddress option specifies the IPX/SPX address of a server on an AIX host that is not in the same network as the client node. If the IPX/SPX address is not specified, the server must be in the same network as the client node.
Supported Clients
This option is valid for the NetWare client only.
Syntax
>>-IPXSErveraddress- server_address----------------------------><
Parameters
If an IPX/SPX address is not specified, the default address for the server is the same address as the client workstation.
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The ipxsocket option specifies the socket number for a server on a NetWare host.
Supported Clients
This option is valid for the NetWare client only.
Syntax
>>-IPXSOcket- socketnumber-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The lanfreecommmethod option specifies the communications protocol between the Tivoli Storage Manager client and Storage Agent. This enables processing between the client and the SAN-attached storage device.
For AIX, AIX 5L, and Solaris: Use the lanfreeshmport to specify the Shared Memory port number where the Storage Agent is listening. See Lanfreeshmport for more information
For Windows NT, 2000: Place this option in the client options file (dsm.opt).
Supported Clients
This option is valid for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-LANFREECommmethod- commmethod-------------------------------><
Parameters
Use the lanfreetcpport to specify the TCP/IP port number where the Storage Agent is listening. See Lanfreetcpport for more information. For AIX, AIX 5L, and Solaris root users, the Shared Memory communication method is the default and TCP/IP is optional. AIX, AIX 5L, and Solaris non-root users can only use the TCP/IP communication method.
Examples
Authorized User (UNIX requires access authority.)
The lanfreeshmport option specifies the Shared Memory port number where the Tivoli Storage Manager Storage Agent is listening.
Use this option when lanfreecommmethod=SHAREdmem is specified for communication between the Tivoli Storage Manager client and Storage Agent. This enables processing between the client and the SAN-attached storage device.
See Lanfreecommmethod for more information about the lanfreecommmethod option.
Supported Clients
This option is valid for AIX, AIX 5L, and Solaris clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-LANFREEShmport- port_address--------------------------------><
Parameters
Examples
Authorized User (UNIX requires access authority.)
The lanfreetcpport option specifies the TCP/IP port number where the Tivoli Storage Manager Storage Agent is listening.
Use this option when you specify lanfreecommmethod=TCPip for communication between the Tivoli Storage Manager client and Storage Agent.
For Windows NT, 2000: Place this option in the client options file (dsm.opt).
See Lanfreecommmethod for more information about the lanfreecommmethod option.
Supported Clients
This option is valid for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris clients only.
Options File for UNIX Platforms
For AIX, AIX 5L, and Solaris clients: Place this option in the client system options file (dsm.sys).
Syntax
>>-LANFREETCPport- port_address--------------------------------><
Parameters
Examples
The language option specifies the national language in which to present client messages.
You can use American English (AMENG) with all clients. For Macintosh and NetWare: Currently, you can use American English (AMENG) only.
The Tivoli Storage Manager client automatically detects the language of the system locale and displays Tivoli Storage Manager for that language. For example, a supported operating system will display Tivoli Storage Manager in French by default, without specifying the language option. If Tivoli Storage Manager cannot load the French message catalog, it will default to the American English language pack. For example, if the client is running on an unsupported locale/language combination, such as French/Canada or Spanish/Mexico, Tivoli Storage Manager defaults to American English. You can override the default language by specifying the language option.
Supported Clients
This option is valid for Macintosh, NetWare, and Windows clients.
Syntax
>>-LANGuage- language------------------------------------------><
Parameters
Examples
Authorized User (UNIX requires access authority.)
The largecommbuffers option specifies whether the client uses increased buffers to transfer large amounts of data between the client and the server. You can disable this option when your workstation is running low on memory.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-No--. >>-LARGECOMmbuffers-+-----+------------------------------------>< '-Yes-'
Parameters
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
Supported Clients
This option is valid for Windows and UNIX clients only.
Options File for UNIX Platforms
Place this option in the client user options file (dsm.opt) or the client system options file (dsm.sys) .
Syntax
.-No--. >>-LOCALbackupset-+-----+-------------------------------------->< '-Yes-'
Parameters
Examples
Authorized User (UNIX requires access authority.)
The mailprog option specifies the program and user ID to which you want to send a newly-generated password when the old password expires. Use this option only when you select generate with the passwordaccess option.
Supported Clients
This option is for the UNIX clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-MAILprog filespec userid------------------------------------><
Parameters
Examples
mailprog /usr/bin/xsend root (for AIX, AIX 5L) mailprog /bin/mailx USER1 (for OS/390 UNIX System Services)
Does not apply.
Authorized User (UNIX requires access authority.)
The managedservices option specifies whether the Tivoli Storage Manager Client Acceptor daemon (CAD) manages the scheduler, the Web client, or both.
For instructions to set up the CAD to manage the scheduler, see the following sections:
The CAD serves as an external timer for the scheduler. When the scheduler is started, it queries the server for the next scheduled event. The event is either executed immediately or the scheduler exits. The CAD restarts the scheduler when it is time to execute the scheduled event.
Notes:
Using the managedservices option can provide the following benefits:
Place this option in the client options file (dsm.opt).
Supported Clients
This option is valid for Windows, UNIX, and NetWare clients.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-MANAGEDServices--+----------+------------------------------->< | .- ----. | | V | | '---mode-+-'
Parameters
Examples
managedservices webclient
managedservices schedule
managedservices schedule webclient
The matchallchar option specifies the character to use as a match-all wildcard character. For example, File* matches File1, FileA1, and File. Place this option in the Preferences file before any include or exclude statements.
Supported Clients
This option is for the Macintosh client only.
Syntax
>>-MATCHAllchar character--------------------------------------><
Parameters
Examples
The matchonechar option specifies the character to use as a match-one wildcard character. For example, File? matches File1, but it does not match File or File10. Place this option in the Preferences file before any include or exclude statements.
Supported Clients
This option is for the Macintosh client only.
Syntax
>>-MATCHOnechar character--------------------------------------><
Parameters
Examples
Authorized User (UNIX requires access authority.)
The maxcmdretries option specifies the maximum number of times the client scheduler (on your workstation) attempts to process a scheduled command that fails. The command retry starts only if the client scheduler has not yet backed up a file, never connected to the server, or failed before backing up a file. Use this option only when the scheduler is running.
Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides what you specify in the client options or Preferences file after your client node successfully contacts the server.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-MAXCMDRetries- maxcmdretries--------------------------------><
Parameters
Examples
Does not apply. (UNIX)
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-No--. .-Yes-. >>-MEMORYEFficientbackup-+-----+-"OR"-+-----+------------------>< '-Yes-' '-No--'
Parameters
Examples
The namedpipename option specifies the name of a named pipe to use for communications between a client and a server on the same Windows server domain.
Supported Clients
This option is valid for the Windows NT and Windows 2000 clients only.
Syntax
>>-NAMedpipename- name-----------------------------------------><
Parameters
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 system option file dsm.sys (UNIX) or client options file dsm.opt (Windows).
You can override the default value in the dsm.sys (UNIX) or dsm.opt (Windows) file by entering a different value on the command line. If you do not specify the nasnodename option in the dsm.sys (UNIX) or dsm.opt (Windows) file, you must specify this option on the command line when processing NAS file systems.
The nasnodename option is valid for Windows NT, Windows 2000, AIX, AIX 5L, and Solaris only
Options File for UNIX Platforms
This option can be specified on the command line or in the client system options file (dsm.sys).
Syntax
>>-NASNodename- nodename---------------------------------------><
Parameters
Examples
The nfstimeout option specifies the number of seconds the server waits for a status system call on an NFS file system before it times out.
You can use this option to mitigate the default behavior of status calls on NFS file systems. For example, if an NFS file system is stale, a status system call will be timed out by NFS (softmounted) or hang the process (hardmounted).
When the value of this option is changed to a value other than zero, a new (child) process is created to issue the status system call. The new process is timed out by the main (parent) process and the operation can continue.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza or the client options file (dsm.opt).
Syntax
>>-NFSTIMEout number-------------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The nodename option identifies your workstation to the server. You can use different node names to identify multiple operating systems on your workstation.
When you use the nodename option, Tivoli Storage Manager prompts for the password assigned to the node you specify, if a password is required.
If you want to restore or retrieve files from the server while you are working from a different workstation, use the virtualnodename option. See Virtualnodename for more information.
If you are working from a different workstation, you can use the nodename option only if you specify passwordaccess=prompt.
For Macintosh: If you do not specify this option in the Preferences file, Tivoli Storage Manager prompts you for the node name when it starts.
For Windows: The node name is not necessarily the TCP/IP host name.
For UNIX: When connecting to a server, the client must identity itself to the server. This login identification is determined in the following manner:
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza.
Syntax
>>-NODename- nodename------------------------------------------><
Parameters
For Windows: The default is the name of the workstation unless clusternode=yes. Then, the default is the cluster name.
For all clients except UNIX: Permit the node name to default to the workstation name.
Examples
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
The numberformat option specifies the format you want to use to display numbers.
For all clients except UNIX: Use this option if you want to change the default number format for the language of the message repository you are using.
The AIX, AIX 5L, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. Solaris and HP-UX clients only support English, Simplified Chinese, and Japanese locale information. The default directories for system-supplied locales are as follows:
The backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. Consult the documentation on your local system for details about setting up your locale definition.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-NUMberformat- number----------------------------------------><
Parameters
For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: To define number formats, modify the following lines in the source file of your locale. Whatever format you select applies both to output and to input.
Examples
This option is valid on the initial command line and in interactive mode.
The nwignorecompressbit option specifies whether you want to ignore the setting of the compressed file (Co) attribute during selection processing for incremental backups. This option is valid only on NetWare clients sending an incremental backup on a NetWare 4 file system.
Supported Clients
This option is valid for the NetWare client only.
Syntax
.-No--. >>-NWIGNORECOMpressbit--+-----+-------------------------------->< '-Yes-'
Parameters
Examples
The nwpwfile option encrypts the user ID and password for a local or remote NetWare server. Tivoli Storage Manager saves the encrypted user ID and password in the TSM.PWD file.
Supported Clients
This option is valid for the NetWare client only.
Syntax
.-Yes-. >>-NWPWFile--+-----+------------------------------------------->< '-No--'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The nwuser option specifies a user ID and password to connect to a local or remote NetWare server. The user must have NetWare supervisor authority. Use this option in your client options file for each NetWare server. If you do not use this option, you are prompted for a user ID and password for each target service when you start a backup or archive operation.
When logging into a NetWare server from Tivoli Storage Manager, enter one of the following:
For example, if you received the following message:
Please enter NetWare user for "ELLAS":
You can specify either: .CN=Zorba.OU=Islands.O=Greece or Zorba (if the Bindery Context is set to OU=Islands.O=Greece. Tivoli Storage Manager rejects the typeless name:
Zorba.Islands.Greece
Supported Clients
This option is valid for the NetWare client only.
Syntax
.- -------------------------------. V | >>---NWUSer servername\user:password-+-------------------------><
Parameters
Examples
To specify a user ID and password to back up an NDS tree, you would enter: nwuser treea:.admin.ibm:secret where treea is the NDS tree name.
This option is valid only on the initial command line. It is not valid in interactive mode.
The nwwaitonerror option specifies that the client program responds in one of the following ways, if an error occurs while exiting:
Supported Clients
This option is valid for the NetWare client only.
Syntax
.-Yes-. >>-NWWaitonerror--+-----+-------------------------------------->< '-No--'
Parameters
Examples
The optfile option specifies the client options file you want to use when you start a Tivoli Storage Manager session.
Supported Clients
This option is valid for NetWare, UNIX, and all Windows clients.
Syntax
>>-OPTFILE- file_name------------------------------------------><
Parameters
Examples
dsmc query session -optfile= myopts.opt (Windows or UNIX)
load dsmc query session -optfile= sys:tsm/spike.opt (NetWare)
This option is valid only on the initial command line. It is not valid in interactive mode.
The partnerluname option specifies a logical unit name that the transaction program uses to identify the server in the SNA network. The partner logical unit name is used if the symbolic destination name is not provided for SNA LU6.2 communications. If you use this option, also define the cpicmodename and tpname options.
Supported Clients
This option is valid for the NetWare client only.
Syntax
>>-PARtnerluname- logical_unit_name----------------------------><
Parameters
partnerluname nameone.nametwo
Contact your system administrator for this name. There is no default.
Examples
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.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-PASsword- password------------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The passwordaccess option specifies whether you want to generate your password automatically or set as a user prompt. Your administrator can require a password for your client node by enabling the authentication feature. Ask your administrator if a password is required for your client node.
If a password is required, you can choose to:
For all clients except Windows: Use the passworddir option in your client system options file (UNIX), Preferences file (Macintosh), or client options file to specify the directory location in which to store the encrypted password file. The default directory location depends on how the client was installed.
When the passwordaccess option is set to generate and you specify the password option, the password option is ignored.
Set the passwordaccess option to generate in the following situations:
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza.
Syntax
.-prompt---. >>-PASSWORDAccess-+----------+--------------------------------->< '-generate-'
Parameters
For all clients except Macintosh: To keep your client node password secure, enter commands without the password and wait for Tivoli Storage Manager to prompt you for the password.
For UNIX: Each user must know the Tivoli Storage Manager password for your client node. Any user who knows the password for your client node can gain access to all backups and archives that originate from your client node. For example:
API applications must supply the password when a session is initiated. The application is responsible for obtaining the password.
A password prompt displays when registering a workstation with a server using open registration or if your administrator changes your password manually.
For UNIX: You can use the mailprog option to specify the program and user ID where you want to send the new password each time the old password expires.
For UNIX: When logging in locally, users do not need to know the Tivoli Storage Manager password for the client node. However, by using the nodename option at a remote node, users can access files they own and files to which another user grants access. If you change the name of your client node (using the nodename option in the dsm.sys file, and the same node name is specified in the dsm.opt file, Tivoli Storage Manager prompts the users for the client node password. If a user enters the correct password, the user becomes a virtual root user. The same is true if a user specifies the same node name using the nodename option with a command.
Examples
Authorized User (UNIX requires access authority.)
The passworddir option forces the directory location in which to store an encrypted password file. The default directory location depends upon how the client was installed.
Supported Clients
These clients can use this option: Macintosh, NetWare, and UNIX.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-PASSWORDDIR- directoryname----------------------------------><
Parameters
For UNIX: The default directory for AIX and AIX 5L is /etc/security/adsm and for other UNIX platforms it is /etc/adsm.
Examples
passworddir /etc/security/tsm (UNIX)
passworddir dmmock\sys:security\tsm (NetWare)
Authorized User (UNIX requires access authority.)
The postschedulecmd option specifies a command that the client program processes after it runs a schedule. The client program waits for the command to complete before it continues with other processing.
If you do not want to wait, specify postnschedulecmd.
Supported Clients
All clients can use postschedulecmd. Postnschedulecmd is not valid for NetWare.
Options File for UNIX Platforms
Place these options in the client system options file (dsm.sys).
Syntax
>>-+-POSTSchedulecmd--+-- "cmdstring"-------------------------->< '-POSTNschedulecmd-'
Parameters
Use a blank, or null, string for cmdstring if you want to prevent any commands from running that the administrator uses for postschedulecmd or preschedulecmd. If you specify a blank or null string on either option, it prevents the administrator from using a command on both options.
If your administrator uses a blank or null string on the postschedulecmd option, you cannot run a post-schedule command.
If the command string contains blanks, enclose it in double quotes. If you have double quotes within the command string, use single quotes to enclose them.
For Macintosh: The command string should specify an AppleScript to launch. If it is only a file name, such as "Database Script", the client program searches for this file in the Scripts folder inside the Tivoli Storage Manager folder. Otherwise, the command string should contain the full path of the file, such as:
"La Pomme:Scripting:Database Script"
Examples
The command string is a valid command for restarting your database.
The command string is a valid command for restarting your database.
Authorized User (UNIX requires access authority.)
The preschedulecmd option specifies a command that the client program processes before it runs a schedule. The client program waits for the command to complete before it starts the schedule.
If you do not want it to wait, specify prenschedulecmd.
Supported Clients
All clients can use preschedulecmd. Prenschedulecmd is not valid for NetWare.
Options File for UNIX Platforms
Place these options in the client system options file (dsm.sys).
Syntax
>>-+-PRESchedulecmd--+-- "cmdstring"--------------------------->< '-PRENSchedulecmd-'
Parameters
Use a blank or null string for cmdstring if you want to prevent any commands from running that the administrator uses for postschedulecmd and preschedulecmd. If you specify a blank or null string on either option, it prevents the administrator from using a command on both options.
If your administrator uses a blank or null string on the preschedulecmd option, you cannot run a pre-schedule command.
If the command string contains blanks, enclose it in double quotes. If you placed double quotes within the command string, use single quotes to enclose them.
For Macintosh: The command string should specify an AppleScript to launch. If it is only a file name, such as "Database Script", the client program searches for this file in the Scripts folder inside the Tivoli Storage Manager folder. Otherwise, the command string should contain the full path of the file, such as:
"La Pomme:Scripting:Database Script"
Examples
The command string is a valid command for quiescing your database.
The command string is a valid command for quiescing your database.
The processorutilization option specifies the amount of CPU time assigned to the client program. Because this option can affect other applications on your client node, use it only when speed is a high priority.
Supported Clients
This option is valid for the NetWare client only.
Syntax
>>-PROCESSORutilization- number--------------------------------><
Parameters
Examples
Authorized User (UNIX requires access authority.)
The queryschedperiod option specifies the number of hours you want the client scheduler to wait between attempts to contact the server for scheduled work. This option applies only when you set the schedmode option to polling. This option is used only when the scheduler is running.
Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides the value set in your client options or Preferences file after your client node successfully contacts the server.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-QUERYSCHedperiod- hours-------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The quiet option limits the number of messages that display on your screen during processing. For all clients except Macintosh: For example, when you run the incremental, selective, or archive commands, information may appear about each file that is backed up. Use the quiet option if you do not want to display this information.
When you use the quiet option, error and processing information appears on your screen, and messages are written to log files. If you do not specify quiet, the default option, verbose is used.
For Windows: This option also affects the amount of information reported in the NT eventlog and schedule log.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-QUIET-------------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
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.
Supported Clients
This option is valid for NetWare, UNIX, and all Windows clients.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-Prompt-. >>-REPlace-+--------+------------------------------------------>< +-All----+ +-Yes----+ '-No-----'
Parameters
Examples
Authorized User (UNIX requires access authority.)
The resourceutilization option regulates the level of resources the Tivoli Storage Manager server and client can use during processing.
When you request a backup or archive, the client can use more than one session to the server. The default is to use a maximum of two sessions; one to query the server and one to send file data. The client can use only one server session if you specify a resourceutilization setting of 1. For UNIX: The client is also restricted to a single session if a user who is not authorized invokes a UNIX client with passwordaccess=generate specified.
A client can use more than the default number of sessions when connecting to a server that is Version 3.7 or higher. For example, resourceutilization=10 permits up to eight sessions with the server. Multiple sessions may be used for querying the server and sending file data.
Multiple query sessions are used when multiple file specifications are used with a backup or archive command. For example, if you enter:
inc filespaceA filespaceB
and you specified resourceutilization=5, the client may start a second session to query files on file space B. Whether or not the second session starts depends on how long it takes to query the server about files backed up on file space A. The client may also try to read data from the file system and send it to the server on multiple sessions.
The following factors can affect the throughput of multiple sessions:
Potentially undesirable aspects of running multiple sessions include:
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-RESOURceutilization- number---------------------------------><
Parameters
Examples
Authorized User (UNIX requires access authority.)
The retryperiod option specifies the number of minutes the client scheduler waits between attempts to process a scheduled command that fails, or between unsuccessful attempts to report results to the server. Use this option only when the scheduler is running.
Your administrator can also set this option. If your administrator specifies a value for this option, that value overrides the value in your client options or Preferences file after your client node successfully contacts the server.
Supported Clients
All clients can use option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-RETRYPeriod- minutes----------------------------------------><
Parameters
Examples
-retryperiod=15 (Windows or NetWare)
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
The revokeremoteaccess option restricts an administrator with client access privilege from accessing a client workstation that is running the Web client. This option does not restrict administrators with client owner, system, or policy privilege from accessing your workstation through the Web client.
Supported Clients
This option is valid for the NetWare, Windows, and UNIX clients.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt) or the client system options file (dsm.sys).
Syntax
.-None---. >>-REVOKEremoteaccess-+--------+------------------------------->< '-Access-'
Parameters
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.
Supported Clients
This option is for Windows NT and Windows 2000 clients only.
Syntax
.-No--. >>-RUNASSERVice--+-----+--------------------------------------->< '-Yes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The schedcmddisabled option specifies whether to disable the scheduling of commands by the server action=command option on the define schedule server command.
This option does not disable the preschedulecmd and postschedulecmd commands. However, you can specify preschedulecmd or postschedulecmd with a blank or a null string to disable the scheduling of these commands and the commands scheduled by the server using the action=command option on the define schedule server command.
Use the query schedule command to query the schedules defined by your administrator.
For Windows, NetWare, and Macintosh: Place this option in your client options file or Preferences file (Macintosh).
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys) within a server stanza.
Syntax
.-No--. >>-SCHEDCMDDisabled-+-----+------------------------------------>< '-Yes-'
Parameters
Examples
The schedcompleteaction option specifies an action to take when a schedule completes. This option is used only when the scheduler is running.
Supported Clients
This option is valid for the Macintosh client only.
Syntax
>>-SCHEDCOMpleteaction--+- Quit-----+-------------------------->< '- SHUTdown-'
Parameters
Examples
Authorized User (UNIX requires access authority.)
The schedlogname option specifies the path and file name where you want to store schedule log information. Use this option only when the scheduler is running.
For Windows, NetWare, and UNIX: When you run the schedule command, output from scheduled commands display on your screen. Output is also sent to the file you specify with this option.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-SCHEDLOGName- filespec--------------------------------------><
Parameters
For Windows, NetWare, and UNIX: If you specify a file name only, the file is stored in your current directory. The default is the installation directory with a file name of dsmsched.log. For UNIX: The dsmsched.log file cannot be a symbolic link.
For Macintosh: If you specify a file name only, the file is stored in your default folder. The default is the Tivoli Storage Manager application folder and a file name of TSM Schedule Log.
Examples
schedlogname c:\mydir\schedlog.jan (Windows)
schedlogname dmmock\sys:mydir/schedlog.jan (NetWare)
schedlogname /home/mydir/schedlog.jan (UNIX)
schedlogn "SupDrive:David Sched Log"
-schedlogn=c:\mydir\schedlog.jan (Windows)
-schedlogn=dmmock\sys:mydir/schedlog.jan (NetWare)
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The schedlogretention option specifies the number of days to keep entries in the schedule log, and whether to save the pruned entries. The schedule log is pruned after a scheduled event completes.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-N----. .-D-. >>-SCHEDLOGRetention--+------+--+---+-------------------------->< '-days-' '-S-'
Parameters
For Windows, NetWare, or UNIX: Pruned entries are copied to the dsmsched.pru file that is stored in the same directory as the schedule log.
For Macintosh: Tivoli Storage Manager copies the entries pruned from the log to TSM Sched Pruned Log.
Examples
-schedlogretention=30,S (Windows or NetWare)
Does not apply. (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The schedmode option specifies whether you want to use the polling mode (your client node periodically queries the server for scheduled work), or the prompted mode (the server contacts your client node when it is time to start a scheduled operation). All communication methods can use the client polling mode, but only TCP/IP can use the server prompted mode.
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:
Supported Clients
This option is valid for the NetWare, Windows, and UNIX clients.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-POlling--. >>-SCHEDMODe-+----------+-------------------------------------->< '-PRompted-'
Parameters
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.
Supported Clients
This option is valid for the NetWare, Windows, and UNIX clients.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-SCROLLLines- number-----------------------------------------><
Parameters
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.
Supported Clients
This option is valid for the NetWare, Windows, and UNIX clients.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-No--. >>-SCROLLPrompt-+-----+---------------------------------------->< '-Yes-'
Parameters
Press 'Q' to quit, 'C' to continuous scroll, or 'Enter' to continue.
Examples
This option is valid on the initial command line and in interactive mode.
In your client system options file (dsm.sys), the servername option specifies the name you want to use to identify a server and to begin a stanza containing options for that server. You can name and specify options for more than one server.
The following example demonstrates how to specify options for two different servers:
SErvername server_a COMMMethod TCPip TCPPort 1500 TCPServeraddress almvmd.almaden.ibm.com PASSWORDAccess prompt GRoups tsm USERs sullivan mushock tallan INCLExcl /adm/tsm/backup.excl SErvername server_b COMMMethod SHAREdmem shmport 1520 PASSWORDAccess generate MAILprog /usr/bin/xsend root GRoups system tsm INCLExcl /adm/tsm/archive.excl
In your client options file (dsm.opt), the servername option specifies which server, of those named in dsm.sys, to contact for backup-archive services. When specified in a client options file or on the command line, the servername option overrides the default server specified in your client system options file.
Supported Clients
This option is for UNIX clients only.
Options File for UNIX Platforms
Place this option in both the client options file (dsm.opt) and the client system options file (dsm.sys).
Syntax
>>-SErvername servername---------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The shmport option specifies the TCP/IP port address that the server is listening on to establish a shared memory connection. See "Communication Options" for a list of clients on which the shared memory communication is supported. To use shared memory, TCP/IP must be installed on your workstation.
Supported Clients
This option is valid for AIX, AIX 5L, HP-UX, and Solaris clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-SHMPort port_address----------------------------------------><
Parameters
Examples
The skipntpermissions option bypasses processing of NTFS security information on Windows NT and Windows 2000 clients only. Select this option for incremental backups, selective backups, or restores. Use this option with the following commands:
Supported Clients
This option is valid for Windows NT, 2000 clients only.
Syntax
.-No--. >>-SKIPNTPermissions-+-----+----------------------------------->< '-Yes-'
Parameters
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:
Supported Clients
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).
Supported Clients
This option is valid for the NetWare, Windows, and UNIX clients.
Options File for UNIX Platforms
Place this option in your client options file (dsm.opt).
Syntax
.-No--. >>-SUbdir-+-----+---------------------------------------------->< '-Yes-'
Parameters
If a subdirectory is a mounted file system, it will not process even if you specfify subdir=yes.
Examples
For Windows: To restore the structure:
\path2\dir1 \path2\dir1\file1 \path2\dir1\dir2 \path2\dir1\dir2\file1
enter any of the following commands:
rest \path\dir1\* \path2\ -su=yes rest \path\dir1\file* \path2\ -su=yes rest \path\dir1\file1* \path2\ -su=yes
For NetWare: To restore the structure:
/path2/dir1 /path2/dir1/file1 /path2/dir1/dir2 /path2/dir1/dir2/file1
enter any of the following commands:
load dsmc rest sys:path/nds1/* sys:path2/ -su=y load dsmc rest sys:path/nds1/file* sys:path2/ -su=y load dsmc rest sys:path/nds1/file1* sys:path2/ -su=y
For UNIX: To restore the structure:
/path2/dir1 /path2/dir1/file1 /path2/dir1/dir2 /path2/dir1/dir2/file1
enter any of the following commands:
dsmc rest "/path/dir1/*" /path2/ -su=yes dsmc rest "/path/dir1/file*" /path2/ -su=yes dsmc rest "/path/dir1/file1*" /path2/ -su=yes
The subfilebackup option specifies whether to enable adaptive subfile backup.
Supported Clients
This option is valid for all Windows clients.
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:
Supported Clients
This option is valid for all Windows clients.
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.
Supported Clients
This option is valid for all Windows clients.
Syntax
>>-SUBFILECACHESize- size--------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
The symbolicdestination option specifies a symbolic server name that indexes SNA routing and security parameters stored in communication directory files. Contact your administrator for the correct name.
When a symbolic destination is used with the SNA LU6.2 communication protocol, you do not need to specify the tpname, partnerluname, or cpicmodename options.
This option is required if your communication protocol is SNA LU6.2 and a transaction program name or partner logical unit name is not provided.
Supported Clients
This option is valid for the NetWare client only.
Syntax
>>-SYMbolicdestination- sym_dest_name--------------------------><
Parameters
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:
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
.-No--. >>-TAPEPrompt-+-----+------------------------------------------>< '-Yes-'
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The tcpbuffsize option specifies the size of the internal TCP/IP communication buffer. Although it uses more memory, a larger buffer can improve communication performance.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TCPBuffsize- size-------------------------------------------><
Parameters
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.
Authorized User (UNIX requires access authority.)
The tcpclientaddress option specifies a TCP/IP address if your client node has more than one address, and you want the server to contact an address other than the one that was used to make the first server contact.
Use this option only if you use the prompted parameter with the schedmode option or when the schedule command is running.
Supported Clients
This option is valid for the NetWare, Windows, and UNIX clients.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TCPCLIENTAddress- client_address----------------------------><
Parameters
Examples
tcpclienta dsmclnt.sanjose.ibm.com (UNIX or Windows)
tcpclienta 128.33.10.249 (NetWare)
-tcpclientaddress=128.33.10.249
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The tcpclientport option specifies a different TCP/IP port number for the server to contact than the one that was used to make the first server contact. If the default port or the specified port is busy, the server attempts to use any available port. Use this option only if you specify the prompted parameter with the schedmode option or when the schedule command is running.
Supported Clients
This option is valid for the NetWare, Windows, and UNIX clients.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TCPCLIENTPort- client_port_address--------------------------><
Parameters
Examples
-tcpclientport=1492
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The tcpnodelay specifies whether to send small transactions to the server, without buffering them first. A small transaction is smaller than the byte limit set with the txnbytelimit option. Specifying tcpnodelay yes might improve performance in higher-speed networks.
Supported Clients
This option is valid for AIX, AIX 5L, and all Windows clients.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.-No--. >>-TCPNodelay--+-----+----------------------------------------->< '-Yes-'
Parameters
Examples
Authorized User (UNIX requires access authority.)
The tcpport option specifies a TCP/IP port address for a server. You can obtain this address from your administrator. For Macintosh: This option is required in your Preferences file.
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 daemon and the Web Client Agent service for communications with the Web GUI.
The ports specified with the webports option and the client option httpport must be opened in the firewall. See Httpport and Webports for more information.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TCPPort- port_address---------------------------------------><
Parameters
Examples
-tcpport=1501 (Windows or NetWare)
Does not apply (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The tcpserveraddress option specifies the TCP/IP address for a server. You can obtain this server address from your administrator. For Macintosh: This option is required in your Preferences file.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TCPServeraddress- server_address----------------------------><
Parameters
Examples
-tcpserveraddress=129.33.24.99 (Windows or NetWare)
Does not apply (UNIX)
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The tcpwindowsize option specifies the amount of data in kilobytes that is buffered when receiving data on a TCP/IP connection. To improve backup or archive performance, increase the tcpwindowsize on the server. To improve restore or retrieve performance, increase the tcpwindowsize on the client.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TCPWindowsize- window_size----------------------------------><
Parameters
For Windows: The range of values is 1 through 2048 for Windows 2000 only. For Windows 98, Me, and NT 4.0, we recommend a maximum value of 63 or less. The default is 32.
For UNIX: The range of values is 1 through 2048. For Solaris the maximum value is 1024. The default is 32.
For NetWare: The range of values is 1 through 64; the default is 32.
For Macintosh: The range of values is 1 through 128; the default is 16.
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.
For all clients except UNIX: Use this option if you want to change the default time format for the language of the message repository you are using.
The AIX, AIX 5L, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. Solaris and HP-UX clients only support English, Simplified Chinese, and Japanese locale information. The default directories for system-supplied locales are as follows:
The backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. Consult the documentation on your local system for details about setting up your locale definition.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-TIMEformat- format_number-----------------------------------><
Parameters
For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: This is the default if the locale-specified format consists of digits, separator characters, and, if applicable, the AM or PM string.
For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: This is the default if the locale-specified format does not consist of digits, separator characters, and, if applicable, the AM or PM string.
For AIX, AIX 5L, Tru64 UNIX, HP-UX, SGI, and Solaris: To set a particular time format, edit the source file for your locale and modify the t_fmt line to support your needs. Whatever time format you select applies both to output and to input.
Examples
The tpname option specifies a symbolic name for the transaction program name. The transaction program name is required if the symbolic destination name is not provided for SNA LU6.2 communication.
If you use this option, define the cpicmodename and partnerluname options also.
Supported Clients
This option is valid for the NetWare client only.
Syntax
>>-TPname- tp_name---------------------------------------------><
Parameters
Examples
This option is valid only on the initial command line. It is not valid in interactive mode.
Authorized User (UNIX requires access authority.)
The txnbytelimit option specifies the number of kilobytes the client program buffers before it sends a transaction to the server.
This option permits you to control the amount of data sent between the client and server before the server commits the data and changes to the server database, thus changing the speed with which the client performs work. The amount of data sent applies when files are batched together during backup or when receiving files from the server during a restore procedure.
The server administrator can limit the number of files or directories contained within a transaction group using the txngroupmax option; the actual size of a transaction can be less than your limit. Once this number is reached, the client sends the files to the server even if the transaction byte limit is not reached.
Supported Clients
These clients can use this option: NetWare, UNIX, and all Windows clients.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-TXNBytelimit- number----------------------------------------><
Parameters
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.
Supported Clients
This option is valid for Windows 2000 clients only.
Syntax
.-No--. >>-USEDIRectory-+-----+---------------------------------------->< '-Yes-'
Parameters
Examples
Authorized User (UNIX requires access authority.)
The users option authorizes specific users on your workstation to request services from a server. You can use this option more than once to specify a large number of user IDs. If you do not specify group names with the groups option, or user IDs with the users option, all users can request Tivoli Storage Manager services. If you use the groups option, the users option, or both, only users included in one of the specified groups, or included in the list of users, can request Tivoli Storage Manager services.
Define your root user name only with the users option to exclude all other users from accessing the server.
Supported Clients
This option is valid for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.- -------------------. | .- ---------. | V V | | >>---USERs--- username-+-+-------------------------------------><
Parameters
Examples
users carol larry davecd kathyba michelle users amyb tkaspar kbsmith egray srjames
The verbose option specifies that you want processing information to display on your screen. This is the default. For all clients except Macintosh: When you run the incremental, selective, or archive commands, information displays about each file that is backed up. Use the quiet option if you do not want to display this information.
This option also affects the amount of information displayed in NT event log and schedule log files.
For Windows, NetWare, or UNIX: If the server specifies either the quiet or verbose option in the server client option set, the server settings override the client values, even if force is set to No on the server.
For Macintosh: The information displays on your screen in the Scheduler Status window. This option only applies when you are running the scheduler and Tivoli Storage Manager is performing scheduled work.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-VErbose-----------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
This option is valid on the initial command line and in interactive mode.
Authorized User (UNIX requires access authority.)
The virtualmountpoint option defines a virtual mount point for a file system if you want to consider files for backup that begin with a specific directory within that file system. Using the virtualmountpoint option to identify a directory within a file system provides a direct path to the files you want to back up, saving processing time. It is more efficient to define a virtual mount point within a file system than it is to define that file system using the domain option, and then to use the exclude option in your include-exclude options list to exclude the files that you do not want to back up.
Use the virtualmountpoint option to define virtual mount points for multiple file systems, for local and remote file systems, and to define more than one virtual mount point within the same file system. Virtual mount points cannot be used in a file system handled by automounter. Use the AFS/DFS backup clients to process virtual mount points for AFS/DFS file systems.
After you define a virtual mount point, you can specify the path and directory name with the domain option in either the default client options file or on the incremental command to include it for incremental backup services. Users can also specify the path and directory name of the virtual mount point with the domain option in their own client options files and on the incremental command.
Supported Clients
This option is valid for UNIX clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
.- ---------------------------. V | >>---VIRTUALMountpoint directory-+-----------------------------><
Parameters
Define only one virtual mount point with each virtualmountpoint option that you include in your client system options file. Use the virtualmountpoint option as many times as necessary to define all of the virtual mount points that you want to use.
Examples
virtualmountpoint /afs/xyzcorp.com/home/ellen/ virtualmountpoint /afs/xyzcorp.com/home/ellen/test/data/
The virtualnodename option specifies the node name of your workstation when you want to restore or retrieve files to a different workstation. Place this option in the client options file or Preferences file (Macintosh).
When you use the virtualnodename option in your client options file or Preferences file (Macintosh), or with a command:
When connecting to a server, the client must identity itself to the server. This login identification is determined in the following ways:
When the virtual node name is accepted by the server, a password is required (assuming authentication is on), even if the passwordaccess option is generate. Once a connection to the server is established, then access is permitted to any file backed up using this login ID.
Supported Clients
All clients can use this option.
Options File for UNIX Platforms
Place this option in the client options file (dsm.opt).
Syntax
>>-VIRTUALNodename- nodename-----------------------------------><
Parameters
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 daemon and Web Client Agent service for communications with the Web GUI.
If you do not specify this option, values for both the Client Acceptor daemon and the Web Client Agent service are required.
If you do not specify this option, the default value, zero (0), is used for both ports. This causes TCP/IP to randomly assign a free port number for the Client Acceptor daemon and the Web Client Agent service. The port value TCP/IP assigns is in the range of 1024 through 5000.
The ports you specify with the webports and httpport options must be opened in the firewall.
To enable the backup-archive client, Command Line Admin client, and the Scheduler (running in polling mode) to run outside a firewall, the port specified by the server option tcpport (default 1500) must be opened in the firewall.
To enable the administrative Web interface to run outside a firewall the port specified by server option httpport (default is 1580) must be opened in the firewall.
See Httpport and Tcpport for more information.
Supported Clients
This option is valid for UNIX, Windows, and NetWare clients only.
Options File for UNIX Platforms
Place this option in the client system options file (dsm.sys).
Syntax
>>-WEBPorts- cadport- agentport--------------------------------><
Parameters
Examples
Does not apply (UNIX)
-webports=2123,2124 (Windows 98, Me or NetWare)