IBM Tivoli Software IBM Tivoli Software

[ | | | ]


IBM Tivoli Storage Manager for UNIX: Backup-Archive Clients Installation and User's Guide


Chapter 9. Using processing options

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


Overview of processing options

Tivoli Storage Manager uses processing options that you specify in your client system options file (dsm.sys) or client user options file (dsm.opt) or on the command line to control communications, backup-archive processing, and other types of processing.

This section provides an overview of the following types of options that you can use:

See Chapter 2, Configuring Tivoli Storage Manager for information on how to create and modify your client system options file (dsm.sys) or client user options file (dsm.opt) file.

Tivoli Storage Manager also includes a group of client command options that you can enter only on the command line with specific commands. You can override some of the options in your options file by entering them with appropriate backup-archive commands. For a complete list of command line options, a description, and where to go in this book for more information, see Table 57.


Communication options

You use communication options to specify how your client node communicates with a Tivoli Storage Manager server.

For UNIX use one of the following communication protocols:

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

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

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

TCP/IP options

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

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

Table 44. TCP/IP options

Option Description Page
httpport Specifies a TCP/IP port address for the Tivoli Storage Manager Web client. Httpport
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 whether to send small transactions to the server, without buffering them first. This option is for AIX clients only. Tcpnodelay
tcpadminport Specifies a separate TCP/IP port number on which the server is waiting for requests for administrative client sessions, allowing secure administrative sessions within a private network. Tcpadminport
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 daemon and the Web Client Agent service for communications with the Web GUI. Webports

Shared Memory options

You must install TCP/IP on your workstation to use the Shared Memory communication method.

Table 45. Shared Memory communication options

Option Description Page
shmport Specifies the TCP/IP port address on which the Tivoli Storage Manager 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 you specify lanfreecommmethod=SHAREdmem for communication between the Tivoli Storage Manager client and storage agent when processing between the client and the SAN-attached storage device. Lanfreeshmport

Server and Node options

Authorized User

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.

Server options

Use the servername option in your client system options file (dsm.sys) to begin a group of options (stanza) used to connect to a Tivoli Storage Manager server. You can set up multiple stanzas in the dsm.sys file to connect to different servers. Each stanza must contain all options required to establish communication with a server. The stanza can also contain other options for backup-archive operations.

If your client system options file contains only one stanza - Your client node contacts the server you specify in that stanza for all services.

If your client system options file contains more than one stanza - You can specify a default server with the defaultserver option. If you do not specify a default server, by default Tivoli Storage Manager contacts the server you specify in the first stanza of your dsm.sys file.

Place the defaultserver option at the beginning of your dsm.sys file before any server stanzas. See Defaultserver for more information.

Use the servername option in the client user options file (dsm.opt) or on the command line to specify a server to contact for backup-archive services. This overrides the default server specified in your client system options file (dsm.sys).

Note: You cannot override the migration server specified in the client system options file.

Figure 2 shows a sample client system options file (dsm.sys).

Figure 2. Sample client system options file

+--------------------------------------------------------------------------------+
|DEFAULTServer                 server2                                           |
|                                                                                |
|SErvername     server1                                                          |
|  NODename                    node1                                             |
|  COMMMethod                  TCPip                                             |
|  TCPPort                     1500                                              |
|  TCPServeraddress            almvmd.almaden.ibm.com                            |
|  PASSWORDAccess              generate                                          |
|  MAILprog                    /usr/bin/xsend root                               |
|  GRoups                      system adsm                                       |
|  USERs                       ashton stewart kaitlin                            |
|  INCLExcl                    /adm/adsm/backup1.excl                            |
|                                                                                |
|SErvername     server2                                                          |
|  COMMMethod                  SHAREdmem                                         |
|  shmport                     1520                                              |
|  PASSWORDAccess              prompt                                            |
|  GRoups                      system adsm                                       |
|  USERs                       danielle derek brant                              |
|  INCLExcl                    /adm/adsm/backup2.excl                            |
+--------------------------------------------------------------------------------+

Node options

You may specify the following node options in your client system options file (dsm.sys):

Table 46. 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 IBM Tivoli Storage Manager for Space Management for UNIX User's Guide, GC32-0794 for more information.

Defaultserver
clusternode Specifies whether Tivoli Storage Manager participates in a High Availability Cluster Multi Processing (HACMP) environment. Clusternode
nasnodename Specifies the node name for the NAS file server when processing NAS file systems. Nasnodename
nodename Use the nodename option in your client system options file dsm.sys to identify your workstation to the server to establish communications. Nodename
servername In the client system options file (dsm.sys), this option specifies the name of a server. In the client user options file (dsm.opt), this option specifies the Tivoli Storage Manager server to contact for services. Servername
virtualnodename The virtualnodename option specifies the node name of your workstation when you want to restore or retrieve files to a different workstation. Virtualnodename

Backup and archive processing options

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

Table 47. Backup and archive processing options

Option Description Page
archmc Use the archmc option with the archive command to specify the available management class for your policy domain to which you want to bind your archived files. Archmc
archsymlinkasfile Specifies whether you want Tivoli Storage Manager to follow a symbolic link and archive the file or directory to which it points, or archive the symbolic link only. Archsymlinkasfile
automount Use this option with the domain option to specify all automounted file systems the Tivoli Storage Manager client tries to mount at the following points in time:
  • When Tivoli Storage Manager client starts
  • When the back up is started
  • When the Tivoli Storage Manager client has reached an automounted file system during backup
Automount
changingretries Specifies the number of retries when attempting to back up or archive a file that is in use. Changingretries
class Specifies whether to display a list of NAS, client, or WebSphere Application Server (WAS) objects during a query backup, query filespace, or delete filespace operation. Class
compressalways The compressalways option specifies whether to continue compressing an object if it grows during compression. Use this option with the compression option. Compressalways
compression 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.

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

Compression
deletefiles Use the deletefiles option with the archive command to delete files from your workstation after you archive them. You can also use this option with the restore image command and the incremental option to delete files from the restored image if they were deleted after the image was created. Deletefiles
description The description option assigns or specifies a description for files when performing archive, delete, retrieve, or query archive operations. Description
detail Use the detail option to display management class, file space, backup, and archive information depending on the command with which it is used. Detail
dirmc Specifies the management class to use for directories. If you do not specify this option, the client uses the management class in the active policy set of your policy domain with the longest retention period. Dirmc
dirsonly Backs up, restores, archives, retrieves, or queries directories only. Dirsonly
domain Specifies the file systems to include in your default client domain for an incremental backup. Domain
domain.image Specifies the mounted file systems and raw logical volumes that you want to include in your client domain for an image backup. This option is for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. Domain.image
domain.nas Specifies the volumes to include in your default domain for NAS image backups. This option is for AIX and Solaris clients only. Domain.nas
enablelanfree Specifies whether to enable an available LAN-free path to a storage area network (SAN) attached storage device. Enablelanfree
exclude
exclude.backup
exclude.file
exclude.file.backup
These options are equivalent. Use these options to exclude a file or group of files from backup services and space management services (if the HSM client is installed). The exclude.backup option only excludes files from normal backup, but not from HSM. Exclude options
exclude.archive Excludes a file or a group of files that match the pattern from archive services only. Exclude options
exclude.attribute.symlink Excludes a file or a group of files that are symbolic links from backup processing only. Exclude options
exclude.compression Excludes files from compression processing if you set the compression option to yes. This option applies to backups and archives. Exclude options
exclude.dir Excludes a directory, its files, and all its subdirectories and their files from backup processing. Exclude options
exclude.encrypt Excludes specified files from encryption processing. 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. This option is for AIX and Solaris clients 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, HP-UX, Solaris, Linux86, Linux IA64, Linux pSeries, and Linux iSeries only. Exclude options
filelist Specifies a list of files to be processed for the command. Tivoli Storage Manager opens the designated filelist and processes the files listed within according to the command. Filelist
filesonly Backs up, restores, retrieves, or queries files only. Filesonly
groupname Use this option with the backup group command to specify the fully qualified name of the group leader for a group. Groupname
guitreeviewafterbackup Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. Guitreeviewafterbackup
imagetype Use the imagetype option with the backup image command or the include.image option to specify the type of image backup you want to perform. This option is valid for AIX, Solaris, HP-UX, Linux86, Linux IA64, Linux pSeries, and Linux iSeries clients only. Imagetype
inclexcl Specifies the path and file name of an include-exclude options file. Inclexcl
include
include.backup
include.file
These options are equivalent. Use these options to include files or assign management classes for backup processing. Include options
include.archive Includes files or assigns management classes for archive processing. Include options
include.attribute.symlink Includes a file or a group of files that are symbolic links within broad group of excluded files for backup processing only. Include options
include.compression Includes files for compression processing if you set the compression option to yes. This option applies to backups and archives. Include options
include.encrypt Includes the specified files for encryption processing. By default, Tivoli Storage Manager does not perform encryption processing. Include options
include.fs.nas Use the include.fs.nas option to bind a management class to Network Attached Storage (NAS) file systems. You can also specify whether Tivoli Storage Manager saves Table of Contents (TOC) information during a NAS file system image backup, using the toc option with the include.fs.nas option in your client system options file (dsm.sys). See Toc for more information. This option is valid for AIX and Solaris clients only. Include options
include.image Includes a file system or logical volume or assigns a management class when used with the backup image command. The backup image command ignores all other include options. This option is valid for AIX, HP-UX, Solaris, Linux86, Linux IA64, Linux pSeries, and Linux iSeries only. Include options
incrbydate Use with the incremental command to request an incremental backup by date. Incrbydate
incremental Use with the restore image command to ensure that any changes that were made to the base image are also applied to the restored image. This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. Incremental
memoryefficientbackup Specifies a memory-saving backup algorithm for incremental backups when used with the incremental command. Memoryefficientbackup
mode Use the mode option with these commands, as follows:

backup image
To specify whether to perform a selective or incremental image backup of client file systems.

backup nas
To specify whether to perform a full or differential image backup of NAS file systems.

backup was
To specify whether to perform a full or differential backup of the WebSphere Application Server (WAS) Network Deployment Manager (contains setup, application files, and configuration information) or the Application Server to the Tivoli Storage Manager server.

backup group
To specify whether to perform a full or differential group backup containing a list of files from one or more file space origins.
Mode
monitor Specifies whether you want to monitor an image backup of file systems belonging to a Network Attached Storage (NAS) file server. Monitor
noprompt Suppresses the confirmation prompt that normally appears before you delete an archived file after using the deletefiles option with the archive command, or when performing an image restore operation. Noprompt
optfile Specifies the client user options file you want to use when you start a Tivoli Storage Manager session. Optfile
preservelastaccessdate Use this option during a backup or archive operation to specify whether to reset the last access date of any specified files to their original value following a backup or archive operation. By default, the Tivoli Storage Manager client will not reset the last access date of any backed up or archived files to their original value prior to the backup or archive operation. Preservelastaccessdate
removeoperandlimit Specifies that Tivoli Storage Manager removes the 20-operand limit for Unix-family platforms. If you specify the removeoperandlimit option with the incremental, selective, or archive commands, the 20-operand limit is not enforced and is restricted only by available resources or other operating system limits. Removeoperandlimit
snapshotcachesize During a snapshot image backup, use this option to specify an appropriate snapshot size so that all old data blocks can be stored. A snapshot size of 100 percent will ensure a valid snapshot. This option is valid for Linux86 and Linux IA64 clients only. Snapshotcachesize
snapshotroot Use the snapshotroot option with the incremental, selective, or archive commands in conjunction with a third-party application that provides a snapshot of a logical volume, to associate the data on the local snapshot with the real file space data that is stored on the Tivoli Storage Manager server. This option is valid for all UNIX clients. Snapshotroot
subdir Specifies whether to include subdirectories of a named directory. Subdir
tapeprompt Specifies whether you want Tivoli Storage Manager 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. Tapeprompt
toc Use the toc option with the backup nas command or the include.fs.nas option to specify whether Tivoli Storage Manager saves Table of Contents (TOC) information for each file system backup. If you save TOC information, you can use the query toc server command to determine the contents of a file system backup in conjunction with the restore node server command to restore individual files or directory trees. You can also use the Tivoli Storage Manager Web client to examine the entire file system tree and select files and directories to restore. Toc
type Use the type option with the query node command to specify the type of node to query. Type
v2archive Use the v2archive option with the archive command to archive only files to the server. Tivoli Storage Manager will not process directories that exist in the path of the source file specification. V2archive
virtualfsname Use this option with the backup group command to specify the name of the container for the group on which you want to perform the operation. Virtualfsname
virtualmountpoint 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. Virtualmountpoint
wasnode If WAS security is enabled, use the wasnode option with the set waspassword command to specify the node name when setting the user name and password for each installation of WAS on your machine. Wasnode
wasexphome To backup the WebSphere Application Server-Express, use the wasexphome option to specify the fully qualified installation path of the WebSphere Application Server-Express. Wasexphome
washome Use the washome option in your client user options file (dsm.opt) to specify an override base install path for the Application Server Washome
wasndhome Use the wasndhome option in your client user options file (dsm.opt) to specify an override base install path for the Network Deployment Manager. Wasndhome
wastype Use the wastype option with the backup was command to back up the WAS Network Deployment Manager or the Application Server. If WAS security is enabled, use the wastype option with the set waspassword command to specify the WAS Network Deployment Manager or Application Server when setting the user name and password for each installation of WAS on your machine. Wastype
wasuser If WAS security is enabled, use the wasuser option with the set waspassword command to set the user name for each installation of WAS on your machine. Wasuser

Restore and retrieve processing options

The following options relate to restore and retrieve processing.

Table 48. Restore and retrieve processing options

Option Description Page
dirsonly Backs up, restores, archives, retrieves, or queries directories only. Dirsonly
filelist Specifies a list of files to be processed for the command. Tivoli Storage Manager opens the designated filelist and processes the files listed within according to the command. Filelist
filesonly Backs up, restores, retrieves, or queries files only. Filesonly
followsymbolic Specifies whether you want to restore files to symbolic links or use a symbolic link as a virtual mount point. Followsymbolic
fromdate Use the fromdate option with the fromtime option to specify a date and time from which you want to search for backups or archives during a restore, retrieve, or query operation. Fromdate
fromnode Permits one node to perform commands for another node. A user on another node must use the set access command to permit you to query, restore, or retrieve files or images for the other node. Fromnode
fromowner Displays file spaces for an alternate owner. Also specifies an alternate owner from which to restore or retrieve files. Fromowner
fromtime Use the fromtime option with the fromdate option to specify a beginning time from which you want to search for backups or archives during a restore, retrieve or query operation. Fromtime
guitreeviewafterbackup Specifies whether the client is returned to the Backup, Restore, Archive, or Retrieve window after a successful operation completes. Guitreeviewafterbackup
ifnewer Replaces an existing file with the latest backup version only if the backup version is newer than the existing file. Ifnewer
imagetofile Use the imagetofile option with the restore image command to specify that you want to restore the source image to a file. You may need to restore the image to a file in the event of bad sectors present on the target volume, or if you want to do some manipulations with the image data. This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. Imagetofile
inactive Displays a list of active and inactive files when used with the pick option. Inactive
latest Restores the most recent backup version of a file whether it is active or inactive. Latest
localbackupset Specifies whether the Tivoli Storage Manager GUI bypasses initial logon with the server to restore a local backup set on a standalone workstation. Localbackupset
location Specifies where Tivoli Storage Manager searches for the backup set during a query or restore operation. Location
makesparsefile Use the makesparsefile option with the restore or retrieve commands to specify how sparse files are recreated. Makesparsefile
monitor Specifies whether you want to monitor an image restore of one or more file systems belonging to a Network Attached Storage (NAS) file server. Monitor
noprompt Suppresses the confirmation prompt that normally appears before you delete an archived file after using the deletefiles option with the archive command, or when performing an image restore operation. Noprompt
optfile Specifies the client user options file you want to use when you start a Tivoli Storage Manager session. Optfile
pick Creates a list of backup versions, images, or archive copies that match the file specification you enter. From the list, you can select the versions to process. Include the inactive option to view both active and inactive objects. Pick
pitdate Use the pitdate option with the pittime option to establish a point in time for which you want to display or restore the latest version of your backups. Pitdate
pittime Use the pittime option with the pitdate option to establish a point in time for which you want to display or restore the latest version of your backups. Pittime
preservepath Specifies how much of the source path to reproduce as part of the target directory path when you restore or retrieve files to a new location. Preservepath
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
showmembers Displays all members of a group. Showmembers
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
todate Use the todate option with the totime option to specify an ending date and time to which you want to search for backups or archives during a restore, retrieve, or query operation. Todate
totime Use the totime option with the todate option to specify an ending date and time to which you want to search for backups or archives during a restore, retrieve, or query operation. Todate
type Use the type option with the query node command to specify the type of node to query. Type
verifyimage Use the verifyimage option with the restore image command to specify that you want to enable detection of bad sectors on the destination target volume. If bad sectors are detected on the target volume, Tivoli Storage Manager issues a warning message on the console and in the error log. This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. Verifyimage
washome Use the washome option in your client user options file (dsm.opt) to specify an override base install path for the Application Server Washome
wasndhome Use the wasndhome option in your client user options file (dsm.opt) to specify an override base install path for the Network Deployment Manager. Wasndhome
wastype Use the wastype option with the restore was command to restore the WAS Network Deployment Manager or Application Server. Wastype

Scheduling options

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

Table 49. Scheduling options

Option Description Page
managedservices Specifies whether the Storage Manager Client Acceptor daemon manages the Web client, the scheduler, or both. 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
schedcmddisabled Specifies whether to disable the scheduling of generic commands specified by your Tivoli Storage Manager administrator. Schedcmddisabled
schedcmduser (server defined only) The scheduler executes commands under a uid of 0, however, there may be some users who have a different user ID. In this case, your Tivoli Storage Manager administrator can define schedules and allow these schedules to be executed under a uid other than 0, using this option. The Tivoli Storage Manager Client API does not support this option. "Scheduling options for commands"
schedlogname Specifies the path and file name where you want to store schedule log information. 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
sessioninitiation Use the sessioninitiation option to control whether the server or client initiates sessions through a firewall. The default is that the client can initiate sessions. Sessioninitiation
tcpclientaddress 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 specify the prompted parameter with the schedmode option or when the schedule command is running. Tcpclientaddress
tcpclientport Specifies a different TCP/IP port number for the server to contact than the one that was used to make the first server contact. Use this option only if you specify the prompted parameter with the schedmode option or when the schedule command is running. Tcpclientport

Format options

You can use the following options to select different formats for date, time, and numbers.

Table 50. Format options

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

Command processing options

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

Table 51. Command processing options

Option Description Page
editor Specifies if the command-line interface editor and command retrieve capability is turned on or off. Editor
quiet Limits the number of messages that display on your screen during processing. This option can be overidden by the server. Quiet
scrolllines Specifies the number of lines of information that display on your screen at one time. Use this option only when scrollprompt is set to yes. Scrolllines
scrollprompt 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. Scrollprompt
verbose Specifies that processing information should display on your screen. The alternative is quiet. This option can be overridden by the server. Verbose

Authorization options

These options control access to a Tivoli Storage Manager server.

Table 52. Authorization options

Option Description Page
encryptkey Specifies whether to save the encryption key password locally when performing a backup-archive operation or whether to prompt for the encryption key password. Encryptkey
groups Specifies the groups on your workstation that you want to authorize to request Tivoli Storage Manager 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
password Specifies a Tivoli Storage Manager password. Password
passwordaccess Specifies whether you want to generate your password automatically or set as a user prompt. Passwordaccess
passworddir Specifies the directory in which you want to store the automatically generated password for your client node. The encryption key and password are encrypted and stored in the TSM.PWD file. Passworddir
revokeremoteaccess Restricts an administrator with client access privileges from accessing your workstation through the Web client. Revokeremoteaccess
users Authorizes specific users on your workstation to request services from a server. Users

Error processing options

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

Table 53. Error processing options

Option Description Page
errorlogname Specifies the fully qualified path and file name of the file where you want to store information about errors that occur during processing. Errorlogname
errorlogretention Specifies how many days to maintain error log entries before pruning, and whether to save the pruned entries. Errorlogretention

Transaction processing options

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

Table 54. Transaction processing options

Option Description Page
collocatebyfilespec Specifies that you want the Tivoli Storage Manager client to use only one server session to send objects generated from one file specification. Setting the collocatebyfilespec option to yes eliminates interspersing of files from different file specifications, by limiting the client to one server session per file specification. Therefore, if you store the data to tape, files for each file specification are stored together on one tape (unless another tape is required for more capacity). Collocatebyfilespec
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 uses increased buffers to transfer large amounts of data between the client and the server. Largecommbuffers
nfstimeout Specifies the number of seconds the server waits for a status system call on an NFS file system before it times out. Nfstimeout
resourceutilization Use the resourceutilization option in your client system options file dsm.sys to regulate the level of resources the Tivoli Storage Manager server and client can use during processing. Resourceutilization
txnbytelimit Specifies the number of kilobytes the client program buffers before it sends a transaction to the server. Txnbytelimit

Web client options

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

Table 55. Web client options

Option Description Page
httpport Specifies a TCP/IP port address for the Web client. Httpport
managedservices Specifies whether the Storage Manager Client Acceptor daemon manages the Web client, the scheduler, or both. 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 Client Acceptor daemon and the Web Client Agent service for communications with the Web GUI. Webports

Diagnostics options

Use the query systeminfo command to gather Tivoli Storage Manager system information and output this information to a file or the console. The query systeminfo command is intended primarily as a diagnostic aid. You can submit the resulting information to technical support personnel for problem diagnosis. See Query Systeminfo for more information.

Table 56. Diagnostics options

Option Description Page
console Use the console option with the query systeminfo command to output system information to the console. Console
filename Use the filename option with the query systeminfo command to specify a file name in which to store the system information. Filename

Using options with commands

You can override some of the options in your client system options file (dsm.sys) or client user options file (dsm.opt) by entering them with appropriate Tivoli Storage Manager commands.

Tivoli Storage Manager processes options in the following order (precedence):

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

Tivoli Storage Manager also includes a group of client command options that you can enter only on the command line with specific commands. For a complete list of command line options, a description, and where to go in this book for more information, see Table 57.

Entering options with a command

Follow these general rules to enter options with a command:

Table 57 lists client command options that you can enter only on the command line with specific commands.

Table 57. Client command options

Command option Description Commands Page
archmc Use the archmc option with the archive command to specify the available management class for your policy domain to which you want to bind your archived files. archive Archmc
class Specifies whether to display a list of NAS objects or client objects when using the following commands: query backup
delete filespace
query filespace
Class
console Use the console option with the query systeminfo command to output system information to the console. query systeminfo Console
deletefiles Deletes the local copy of files from your workstation after they are archived on the server. Can also be used with the restore image command and the incremental option to delete files from the restored image that are deleted from the file space after the image is created. archive
restore image
Deletefiles
description Assigns or specifies a description for files when performing archive, delete, retrieve, or query archive operations. archive
delete archive
query archive
query backupset
retrieve
Description
detail Displays management class, file space, backup, and archive information depending on the command with which it is used. delete filespace
query archive
query backup
query filespace
query mgmtclass
Detail
dirsonly Backs up, restores, archives, retrieves, or queries directories only. archive
incremental
query archive
query backup
restore
restore backupset
retrieve
selective
Dirsonly
filelist Specifies a list of files to be processed for the command. Tivoli Storage Manager opens the designated filelist and processes the files listed within according to the command. archive
backup group
delete archive
expire
incremental
query archive
query backup
restore
retrieve
selective
Filelist
filename Use the filename option with the query systeminfo command to specify a file name in which to store the system information. query systeminfo Filename
filesonly Backs up, restores, retrieves, or queries files only. archive
incremental
query archive
query backup
restore
restore backupset
retrieve
selective
Filesonly
fromdate Use the fromdate option with the fromtime option to specify a date and time from which you want to search for backups or archives during a restore, retrieve, or query operation. query archive
query backup
restore
retrieve
restore group
restore was
Fromdate
fromnode Permits one node to perform commands for another node. A user on another node must use the set access command to permit you to query, restore, or retrieve files or images for the other node. query archive
query backup
query filespace
query group
query image
query mgmtclass
query was
restore
restore group
restore image
restore was
retrieve
Fromnode
fromowner Displays file spaces for an alternate owner. Also specifies an alternate owner from which to restore or retrieve files. query archive
query backup
query group
query image
query was
restore
restore image
restore group
restore was
retrieve
Fromowner
fromtime Specifies a beginning time on the specified date. Use with the fromdate option. This option is ignored if the fromdate option is absent. query archive
query backup
restore
restore group
retrieve
restore was
Fromtime
groupname Specifies the fully qualified name for a group. backup group
Groupname
ifnewer Replaces existing files with the latest backup version only if the backup version is newer than the existing version. restore
restore backupset
restore group
retrieve
restore was
Ifnewer
imagetofile Use the imagetofile option with the restore image command to specify that you want to restore the source image to a file. You may need to restore the image to a file in the event of bad sectors present on the target volume, or if you want to do some manipulations with the image data. This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. restore image Imagetofile
inactive Displays a list of active and inactive files when used with the pick option. delete group
query backup
query group
query image
query nas
query was
restore
restore group
restore image
restore nas
restore was
Inactive
incrbydate Requests an incremental backup by date. incremental Incrbydate
incremental Applies changes to the base image using information from incremental backups made after the original image backup. This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. restore image Incremental
latest Restores the most recent backup version of a file whether it is active or inactive. restore
restore group
restore was
Latest
location Specifies whether Tivoli Storage Manager searches for a backup set on the server, in local files, or on a tape device during a query or restore operation. query backupset
restore backupset
Location
mode Use the mode option with these commands, as follows:

backup image
To specify whether to perform a selective or incremental image backup of client file systems.

backup nas
To specify whether to perform a full or differential image backup of NAS file systems.

backup was
To specify whether to perform a full or differential backup of the WebSphere Application Server (WAS) Network Deployment Manager (contains setup, application files, and configuration information) or the Application Server to the Tivoli Storage Manager server.

backup group
To specify whether to perform a full or differential group backup containing a list of files from one or more file space origins.
backup group
backup nas
backup image
backup was
restore nas
Mode
monitor Specifies whether you want to monitor an image backup or restore of one or more file systems belonging to a Network Attached Storage (NAS) file server. backup nas
restore nas
Monitor
noprompt Suppresses the confirmation prompt that normally appears before you delete an archived file after using the deletefiles option with the archive command, or when performing an image restore operation. delete archive
delete group
expire
restore image
Noprompt
optfile Specifies the client user options file you want to use when you start a Tivoli Storage Manager session. dsmc.exe Optfile
pick Creates a list of backup versions, images, or archive copies that match the file specification you enter. From the list, you can select the versions to process. Include the inactive option to view both active and inactive objects. delete archive
delete group
expire
query nas
restore
restore group
restore image
restore nas
restore was
retrieve
Pick
pitdate Use the pitdate option with the pittime option to establish a point in time for which you want to display or restore the latest version of your backups. query backup
query group
query image
query nas
query was
restore
restore group
restore image
restore nas
restore was
Pitdate
pittime Use the pittime option with the pitdate option to establish a point in time for which you want to display or restore the latest version of your backups. query backup
query image
query nas
restore
restore image
restore nas
Pittime
preservepath Specifies how much of the source path to reproduce as part of the target directory path when you restore or retrieve files to a new location. restore
restore backupset
retrieve
restore was
Preservepath
removeoperandlimit Specifies that Tivoli Storage Manager removes the 20-operand limit for Unix-family platforms. If you specify the removeoperandlimit option with the incremental, selective, or archive commands, the 20-operand limit is not enforced and is restricted only by available resources or other operating system limits. incremental
selective
archive
Removeoperandlimit
showmembers Displays all members of a group. query group
query was
restore group
restore was
Showmembers
todate Use the todate option with the totime option to specify an ending date and time to which you want to search for backups or archives during a restore, retrieve, or query operation. query archive
query backup
restore
retrieve
restore group
restore was
Todate
totime Use the totime option with the todate option to specify an ending date and time to which you want to search for backups or archives during a restore, retrieve, or query operation. query archive
query backup
restore
retrieve
restore group
restore was
Totime
type Use the type option with the query node command to specify the type of node to query. query node Type
v2archive Use the v2archive option with the archive command to archive only files to the server. Tivoli Storage Manager will not process directories that exist in the path of the source file specification. archive
V2archive
verifyimage Use the verifyimage option with the restore image command to specify that you want to enable detection of bad sectors on the destination target volume. If bad sectors are detected on the target volume, Tivoli Storage Manager issues a warning message on the console and in the error log. This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. restore image Verifyimage
virtualfsname Specifies the name of the virtual file space for the group on which you want to perform the operation. backup group
Virtualfsname
wasnode Use the wasnode option with the set waspassword commands to specify the WAS node name when performing the operation on the WAS Network Deployment Manager or Application Server. set waspassword
Wasnode
wastype Use the wastype option with the backup was, query was, restore was, or set waspassword commands to perform the operation on the WAS Network Deployment Manager or Application Server. backup was
query was
restore was
set waspassword
Wastype
wasuser If WAS security is enabled, use the wasuser option with the set waspassword command to set the user name for each installation of WAS on your machine. set waspassword
Wasuser

Initial command line only options

There is a subset of client options that are valid on the initial command line only. Many of these options establish the runtime environment, such as the commmethod and optfile options. Options in this category are not valid in interactive, macro, or scheduler modes. If used in interactive and macro mode, these options generate an error and cause processing to stop. If used in scheduler mode, they generate a warning message, but are ignored and processing continues. The following options are valid on the initial command line only:

Table 58. Options that are valid on the initial command line only

clusternode
commmethod
editor
enablelanfree
errorlogname
errorlogretention
lanfreecommmethod
lanfreeshmport
lanfreetcpport
language
largecommbuffers
maxcmdretries
nfstimeout
nodename
optfile
password
postschedulecmd, postnschedulecmd

preschedulecmd, prenschedulecmd
queryschedperiod
resourceutilization
retryperiod
schedlogname
schedlogretention
schedmode
servername
sessioninitiation
tapeprompt
tcpbuffsize
tcpclientaddress
tcpclientport
tcpport
tcpserveraddress
tcpwindowsize
txnbytelimit
virtualnodename


Client options reference

The following sections contain detailed information about each of the Tivoli Storage Manager processing options. Information for each option includes:

Note:
For options with a yes parameter, acceptable alternatives are 1, true, and on. For options with a no parameter, acceptable alternatives are 0, false, and off.

Archmc

Use the archmc option with the archive command to specify the available management class for your policy domain to which you want to bind your archived files and directories. When you archive a file, you can override the assigned management class using the archmc option on the archive command or by using the graphical user interface (GUI). Overriding the management class using the GUI is equivalent to using the archmc option on the archive command.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-ARCHMc =-managementclass------------------------------------><
 
 

Parameters

managementclass
Specifies an available management class in the active policy set of your policy domain. This management class overrides the default management class and any include statements for the files and directories you are archiving.

Examples

Command line:
dsmc archive -archmc=ret2yrs /home/plan/proj1/budget.jan

Archsymlinkasfile

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

Supported Clients

This option is valid for all UNIX clients. The server can also define this option.

Options File

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

Syntax

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

Parameters

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

Examples

Options file:
archsymlinkasfile no

Command line:
-archsyml=no

Automount

Authorized User

The automount option adds an automounted file system into the domain by mounting it. Use this option with the domain option.

Use this option to specify all automounted file systems the Tivoli Storage Manager client tries to mount at the following points in time:

It is unnecessary to explicitly specify an automounted file system in the automount statement if you use the keywords all-auto-nfs or all-auto-lofs in the domain statement and the file system is already mounted. However, you should add this file system in the automount statement to ensure the file system has been mounted at all the points in time mentioned above. The automounted file systems are remounted if they have gone offline in the meantime during a backup.

See Domain for more information about working with automounted file systems and the domain option.

Supported Clients

This option is valid for all UNIX platforms. The Tivoli Storage Manager client API does not support this option.

Options File

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

Syntax

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

Parameters

filespacename
Specifies one or more automounted file systems that are mounted and added into the domain.

Examples

Options file:
automount fs1 fs2

Command line:
Does not apply.

Changingretries

Authorized User

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.

This option is applied 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 specify. 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 specify. The backup or archive occurs during the last attempt whether the file is open or not.

Supported Clients

This option is valid for all UNIX clients. The server can also define this option. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Backup category, Number of retries if file is in use field of the Preferences editor.

Syntax

>>-CHAngingretries- numberretries------------------------------><
 
 

Parameters

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

Examples

Options file:
changingretries 3

Command line:
-cha=3

Class

The class option specifies whether to display a list of NAS or client objects when using the following commands:

For example, to display a list of the file spaces belonging to a NAS node, enter the following command:

  query filespace -class=nas 

Supported Clients

This option is valid for AIX and Solaris clients only. The Tivoli Storage Manager client API does not support this option.

Syntax

           .-client-.
>>-CLASS =-+--------+------------------------------------------><
           '-nas----'
 
 

Parameters

client
Specifies that you want to display a list of file spaces for a client node. This is the default.
nas
Specifies that you want to display a list of file spaces for a NAS node.

Examples

Command line:
q backup -nasnodename=nodename -class=nas

Clusternode

The clusternode option specifies whether Tivoli Storage Manager participates in a High Availability Cluster Multi Processing (HACMP) environment. For information on how to configure a Tivoli Storage Manager server to manage a cluster configured client, see Appendix B, Configuring the backup-archive client in an HACMP takeover environment.

Note: You must set the clusternode option to yes for all Tivoli Storage Manager-managed cluster operations. Inconsistent use of the clusternode option for a given Tivoli Storage Manager cluster node name can cause Tivoli Storage Manager to invalidate the cluster node name encrypted password, and prompt the user to reenter the password during the next Tivoli Storage Manager program invocation.

Use the optfile option to properly call the correct (cluster) dsm.opt for all Tivoli Storage Manager programs to ensure proper Tivoli Storage Manager functionality for cluster related operations. See Optfile for more information.

Supported Clients

This option is valid for the AIX clients.

Options File

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

Syntax

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

Parameters

Yes
Specifies that you want Tivoli Storage Manager to back up cluster resources and participate in cluster failover for high availability.
No
Specifies that you do not want the Tivoli Storage Manager client to participate in cluster failover. This is the default.

Examples

Options file:
cluster no

Command line:
-cluster=yes

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

|Collocatebyfilespec

| | | |

|Use the collocatebyfilespec option to specify whether the Tivoli |Storage Manager client uses only one server session to send objects generated |from one file specification.

|Setting the collocatebyfilespec option to yes |eliminates interspersing of files from different file specifications, by |limiting the client to one server session per file specification. |Therefore, if you store the data to tape, files for each file specification |are stored together on one tape (unless another tape is required for more |capacity).

|Considerations: |

|Supported Clients

|This option is valid for all UNIX clients. The server can also |define this option.

|Options File

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

|Syntax

|                       .-No--.
|>>-COLlocatebyfilespec-+-----+---------------------------------><
|                       '-Yes-'
| 
| 

|Parameters |

|Yes
|Specifies that you want the Tivoli Storage Manager client to use only one |server session to send objects generated from one file specification. |Therefore, if you store the data to tape, files for each file specification |are stored together on one tape, unless another tape is required for more |capacity. Restore performance can increase as a result.
|No
|Specifies that the Tivoli Storage Manager client may (depending on the |execution dynamics and on the setting of the resourceutilization |option of 3 or higher), use more than one server session to send the files |from one file specification. This is the default.

|Backup performance may increase as a result. If the files are backed |up to tape, files will be stored on multiple tapes. Generally, the |files specified in the file specification will still be contiguous. |

|Examples |

|Options file:
|collocatebyfilespec yes

|Command line:
|-collocatebyfilespec=yes |

|This option is valid on the initial command line and in interactive |mode. If you use this option in interactive mode, it affects only the |command with which it is specified. When that command completes, the |value reverts to the value at the beginning of the interactive session. |This will be the value from the client system options file (dsm.sys) |unless overridden by the initial command line or by an option forced by the |server.

Commmethod

Authorized User

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

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Communication category, Communication Method list of the Preferences editor.

Syntax

>>-COMMMethod-+- TCPip-----+-----------------------------------><
              '- SHAREdmem-'
 
 

Parameters

The Transmission Control Protocol/Internet Protocol (TCP/IP) communication method. This is the default.
SHAREdmem
Use the Shared Memory communication method when the client and server are running on the same system. This provides better performance over the TCP/IP protocol. This communication method is valid for AIX, HP-UX, and Solaris clients only.

When specifying this communication method on AIX, the client can be logged in as root or non-root, as long as the server is running as root. If the server is not running as root, the user ID running the client must match the user ID running the server.

Examples

Options file:
commm tcpip

Command line:
-commm=tcpip

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

Commrestartduration

Authorized User

The commrestartduration option 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.

Note: A scheduled event will continue if the client reconnects with the server before the commrestartduration value elapses, even if the event's startup window has elapsed.

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

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Communication category, Common Options section of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
commrestartduration 90

Command line:
Does not apply.

Commrestartinterval

Authorized User

The commrestartinterval option 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.

Note:
Use this option only when commrestartduration is a value greater than zero.

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

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Communication category, Common Options section of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
commrestartinterval 30

Command line:
Does not apply.

Compressalways

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

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

Supported Clients

This option is valid for all UNIX clients. The server can also define this option.

Options File

Place this option in the client user options file (dsm.opt). You can set this option on the Backup category, Continue Compressing if Object Grows check box of the Preferences editor.

Syntax

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

Parameters

Yes
File compression continues even if the file grows as a result of compression. This is the default.
No
Backup-archive client objects are resent uncompressed if they grow during compression. API behavior depends on the application. Application backups may fail.

Examples

Options file:
compressalways yes

Command line:
-compressa=no

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

Compression

Authorized User

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.

Use the compression option with the archive, incremental, and selective commands. The backup image command uses the compression option value specified in the dsm.sys. This option is valid on the initial command line and in interactive mode. The server can also define this option which overrides the client value.

If you set the compressalways option to yes, compression continues even if the file size increases. To stop compression if the file size grows, and resend the file uncompressed, set the compressalways option to no.

If you set the compression option to 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.

Supported Clients

This option is valid for all UNIX clients. The server can also define this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Backup category, Compress objects check box of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
compression yes

Command line:
-compressi=no

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.sys file unless overridden by the initial command line or by an option forced by the server.

Console

Use the console option with the query systeminfo command to output information gathered from one or more of the following items to the console:

Note:
The query systeminfo command is intended primarily as an aid for IBM support to assist in diagnosing problems, although users who are familiar with the concepts addressed by this information may also find it useful. If you use the console option, no special formatting of the output is performed to accommodate screen height or width. Therefore, the console output may be difficult to read due to length and line-wrapping. In this case, it is recommended that you use the filename option with the query systeminfo command to allow the output to be written to a file that can subsequently be submitted to IBM support. See Filename for more information.

Supported Clients

This option is valid for all UNIX clients.

Syntax

>>-CONsole-----------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
query systeminfo dsmoptfile errorlog -console

Dateformat

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

The AIX, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. See for supported locales. The following are default directories for system-supplied locales:

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:

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

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

You can use the dateformat option with the following commands:

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client user options file (dsm.opt). You can set this option on the Regional Settings category, Date Format drop-down list of the Preferences editor.

Syntax

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

Parameters

format_number
Displays the date using one of the following formats. Select the number that corresponds to the date format you want to use:
0
Use the locale-specified date format. For AIX, HP-UX, and Solaris: This is the default if the locale-specified date format consists of digits and separator characters.
1
MM/DD/YYYY

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

This is the default for the following supported languages:

  • US English
  • Chinese (Traditional)
  • Korean
2
DD-MM-YYYY

This is the default for the following supported languages:

  • Brazilian Portuguese
  • Italian
3
YYYY-MM-DD

This is the default for the following supported languages:

  • Japanese
  • Chinese (Simplified)
  • Polish
4
DD.MM.YYYY

This is the default for the following supported languages:

  • German
  • French
  • Spanish
  • Czech
  • Russian
5
YYYY.MM.DD

This is the default for the following supported languages:

  • Hungarian

For AIX, HP-UX, and Solaris: To set a particular date format, edit the source file for your locale and modify the d_fmt line to support your needs. Whatever date format you select applies both to output and to input; however, the input year can be either 2 or 4 digits.

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

When you include the dateformat option with a command, it must precede the fromdate, pitdate, and todate options.

Examples

Options file:
dateformat 3

Command line:
-date=3

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

Defaultserver

Authorized User

Use the defaultserver option to specify 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).

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 IBM Tivoli Storage Manager for Space Management for UNIX User's Guide for more information.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option at the beginning of the client system options file (dsm.sys) before any server stanzas.

Syntax

>>-DEFAULTServer- servername-----------------------------------><
 
 

Parameters

servername
Specifies the name of the default server to which you back up or archive files. The server to which files are migrated from your local file systems can also be specified with this option.

Examples

Options file:
defaults server_a

Command line:
Does not apply.

Deletefiles

Use the deletefiles option with the archive command to delete files from your workstation after you archive them.

You can also use this option with the restore image command and the incremental option to delete files from the restored image if they were deleted after the image was created.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-DELetefiles-------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc archive "/home/foo/*.c" -deletefiles
dsmc restore image /local/data -incremental -deletefiles

Description

The description option assigns or specifies a description for files when performing archive, delete, retrieve, or query archive operations.

For example, if you want to archive a file named budget.jan and assign to it the description 2002 Budget for Proj 1, you would enter:

   dsmc archive -des="2003 Budget for Proj 1" /home/plan/
   proj1/budget.jan

Notes:

  1. The maximum length of a description is 254 characters.
  2. Enclose the value in quotes (" ") if the option value that you enter contains a blank space.

You can also use this option to specify the description of a backup set that you want to query.

Use the description option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-DEScription =- description----------------------------------><
 
 

Parameters

description
Assigns a description to the file you are archiving. If you do not specify a description with the archive command, the default is Archive Date:x, where x is the current system date. Note that the date is always 10 characters long. If your date format uses a two digit year, there will be two blank spaces at the end of the date. For example, a default description using a four-digit year might be "Archive Date: 2002/05/03", and the same default with a two-digit year might be "Archive Date: 02/05/03 " (note the two spaces at the end). When retrieving files using the two-digit year description, you can enter the -description option string in either of the following ways:
-description="ArchiveDate: 02/05/03  "
 or
-description="ArchiveDate: 02/05/03*"

If you use the archive command to archive more than one file, the description you enter applies to each file. For example, to archive a group of files and assign the same description, Project X, to each file, you would enter:

   dsmc archive -description="Project X" "/home/
   allproj/.*"

You can then use the description to retrieve all of the files.

Examples

Command line:
dsmc archive "/home/foo/*.prj" -des="2003 Budget for Proj 1"
dsmc query backupset -loc=server -descr="My Laptop"

Detail

Use the detail option to display management class, file space, backup, and archive information depending on the command with which it is used.

Use the detail option with the query mgmtclass command to display detailed information about each management class in your active policy set. If you do not use the detail option, only the management class name and a brief description displays on the screen. If you specify the detail option, information about attributes in each copy group contained in each management class displays on the screen. A management class can contain a backup copy group, an archive copy group, both, or neither.

Use the detail option with the delete filespace and query filespace commands to determine the fsID of a file space. The fsID also appears in the file information dialog in the native and Web client GUIs.

Use the detail option with the query backup and query archive commands to display the last modification date and the last access date of the file you specify.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-DETail------------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:

dsmc query mgmtclass -detail
dsmc query filespace -detail

Dirmc

Authorized User

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. It is recommended that you select a management class for individual directories that retains directories at least as long as it retains the files associated with them.

Note: If you want to backup specific files to a management class see Assigning a management class to files for more information.

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. Use the archmc option with the archive command to specify the available management class for your policy domain to which you want to bind your archived directories and files. If you do not use the archmc option, the server binds archived directories to the default management class. If the default management class has no archive copy group, the server binds archived directories to the management class with the shortest retention period.

Supported Clients

This option is valid for all UNIX clients. The server can also define this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Backup category, Directory Management Class section in the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
dirm managdir

Command line
Does not apply.

Dirsonly

The dirsonly option processes directories only. The client does not process files.

Use the dirsonly option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-DIrsonly----------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc query backup -dirsonly "*"

Domain

The domain option specifies the file systems that you want to include for incremental backup in your client domain.

Use the domain option in your client system options file (dsm.sys) or the client user options file (dsm.opt) to define your default client domain. Tivoli Storage Manager uses your default client domain in the following situations to determine which file systems to process during an incremental backup:

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

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

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

   domain /home /usr /datasave

and the following on the command line:

   dsmc incremental -domain="/fs1 /fs2"

Tivoli Storage Manager performs an incremental backup for your /home, /usr, /datasave, /fs1, and /fs2 file systems.

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 file systems that you specify in the file specification. For example, if you enter:

   dsmc incremental /fs1 /fs2 -domain="/fs3 /fs4"
Tivoli Storage Manager performs an incremental backup for the /fs1 and /fs2 file systems only.

You can also exclude file systems by specifying the dash (-) operator before the file systems. For example, in the following option Tivoli Storage Manager will process all local file systems except for the /home file system:

   domain ALL-LOCAL -/home

Note: You cannot use the (-) operator in front of a domain keyword such as ALL-LOCAL.

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

Automounted file systems

When performing a backup with the domain option set to all-local, files handled by automounter and loopback file systems are not backed up.

If you back up a file system with the domain option set to all-local, any subdirectories that are mount points for an automounted file system (autofs) are excluded from backup. Any files that exist on the server for the automounted subdirectory are expired.

When performing a backup with the domain option set to all-lofs, all explicit loopback file systems (LOFS) are backed up and all automounted file systems are excluded. For loop devices and local file systems handled by automounter, set the domain option to all-auto-lofs.

You should use the automount option with the domain option to specify one or more automounted file systems to be mounted and added into the domain. If you specify the automount option, automounted file systems are remounted if they have gone offline during the execution of the incremental command. See Automount for more information.

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.

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

Platform automounter LOFS LOFS through automounter
AIX yes yes yes
HP-UX yes yes no
All Linux clients yes yes yes
OS/390 UNIX yes no no
Solaris yes yes yes
Note:
For HP-UX 11i, you must use the new automounter, AutoFS. To activate AutoFS, set the autofs parameter to 1 in the /etc/rc.config.d/nfsconf file. Changing this parameter requires a reboot. If you encounter problems with NFS automounted file systems, install patches PHCO_24777 and PHNE_26388 (or later patches). For further information, refer to the HP-UX documentation.

Supported Clients

This option is valid for all UNIX clients. The server can also define this option. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys) or the client user options file (dsm.opt). You can set this option on the Backup category, Domain for Backup section of the Preferences editor.

Syntax

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

Parameters

all-local
Backs up all local file systems except LOFS file systems and LOFS through automounter. This is the default.

The /tmp directory is not included.

domain
Defines the file systems to include in your default client domain.

When you use domain with the incremental command, it processes these file systems in addition to those you specify in your default client domain.

-domain
Defines the file systems to exclude in your default client domain.
all-lofs
Backs up all loopback file systems, except those handled by automounter.
all-nfs
Backs up all network file systems, except those handled by automounter.
all-auto-nfs
Backs up all network file systems which are handled by automounter.
all-auto-lofs
Backs up all loop devices and local file systems which are handled through automounter.

Examples

Options file:
domain /tst /datasave /joe
"domain all-local"
domain ALL-LOCAL -/home
domain ALL-NFS -/mount/nfs1

Command line:
-domain="/fs1 /fs2"
-domain=/tmp
-domain="ALL-LOCAL -/home"

Domain.image

The domain.image option specifies the mounted file systems and raw logical volumes that you want to include in your client domain for an image backup. Raw logical volumes must be named explicitly.

If you do not specify a file system with the backup image command, the file systems you specify 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 valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, Solaris only. The server can also define this option. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys) or dsm.opt. You can set this option on the Backup category -> Domain for Backup box of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
domain.image /fs1 /fs2

Command line:
Does not apply.

Domain.nas

The domain.nas option specifies the volumes to include in your NAS image backups. You can specify all-nas to include all the mounted file systems on the NAS file server, except those you exclude with the exclude.fs.nas option. When you use this option in your client system options file (dsm.sys), 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 file. For example, if you enter the following in your dsm.sys 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 backs up the vol/vol0, vol/vol1, and vol/vol2 volumes on node nas1.

If you set the domain.nas option to all-nas in the dsm.opt file, Tivoli Storage Manager backs up all mounted volumes on the NAS file server. When performing a backup, if you use a file specification and set the domain.nas option to all-nas in the dsm.sys file, all-nas takes precedence.

Supported Clients

This option is valid for AIX and Solaris clients only. The server can also define this option.

Options File

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

Syntax

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

Parameters

domain
Defines the volumes you want to process. You cannot exclude volumes by specifying the dash (-) operator.
all-nas
Processes all mounted volumes on the NAS file server, except those you exclude with the exclude.fs.nas option. This is the default. If there is no domain.nas statement in the dsm.opt file and no volumes specified on the command line, Tivoli Storage Manager backs up all mounted volumes on the NAS server.

Examples

Options file:

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

Command line:
Does not apply.

Editor

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

Because certain terminal settings result in non-standard input, the editor may not work as defined in this document. In this case, you can disable the editor by setting the editor option to no in your client system options file (dsm.sys) or the client user options file (dsm.opt).

Supported Clients

This option is valid for all UNIX clients (except OS/390 UNIX System Services) clients.

Options File

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

Syntax

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

Parameters

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

Examples

Options file:
editor yes

Command line:
-editor=yes

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

Enablelanfree

Authorized User

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 Storage Agent on the client workstation. For more information, refer to the following publications:

Notes:

  1. If you place the enablelanfree option in the client option file (dsm.opt), but zero (0) bytes were transferred through the SAN during an operation, ensure that you bind the data to a LAN-free enabled management class.

  2. To restore backup sets in a SAN environment, see Restore Backupset for more information.

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 AIX, HP-UX, Linux86, Linux pSeries, Linux iSeries, and Solaris clients.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the General category -> Enable Lanfree check box of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
enablelanfree yes

Command line:
-enablelanfree=yes

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

Encryptkey

Authorized User

The encryptkey option specifies whether to save the encryption key password locally when performing a backup-archive operation or whether to prompt for the encryption key password. The encryption key password is saved to the TSM.PWD file in encrypted format.

If you set the encryptkey option to save, you are only prompted the first time you perform an operation. Thereafter, Tivoli Storage Manager does not prompt for the password.

The Web client saves the encryption key password in the TSM.PWD file. If you do not save the encryption key password, you are prompted for the initial encryption key password when you begin encryption processing.

You can encrypt the data that is sent to the server during a backup or archive operation using standard DES 56-bit encryption. If you use the DES 56-bit encryption feature to encrypt your data during backup or archive, you must have the encryption key in order to restore or retrieve the data. If the encryption key is not available on the client machine (via the encryptkey option) and you forgot the encryption key, then the data cannot be restored or retrieved under any circumstances.

Table 59 shows how both Authorized Users and non-Authorized Users can encrypt or decrypt data during a backup or restore operation depending on the value specified for the passwordaccess option. The TSM.PWD file must exist to perform the following Authorized User and non-Authorized User operations. The Authorized User creates the TSM.PWD file and sets the encryptkey option to save and the passwordaccess option to generate.

Note:
When both encryption and compression are enabled, Tivoli Storage Manager compresses the data first, and then encrypts the data.

Table 59. Encrypting or decrypting data

Operation Passwordaccess option Encryptkey option Result
Authorized user backup generate
generate
prompt
prompt
save
prompt
prompt
save
data encrypted
data encrypted
data encrypted
data not encrypted
Authorized user restore prompt save prompted for encryptkey password and data decrypted
Non-Authorized User Backup generate
generate
prompt
prompt
prompt
save
prompt
save
data not encrypted
data encrypted
data not encrypted
data not encrypted
Non-authorized 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 valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Authorization category, Encryption Key Password section of the Preferences editor.

Syntax

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

Parameters

save
Specifies that you want to save the encryption key password to a local TSM.PWD file. If you set the encryptkey option to save, you are only prompted the first time you perform an operation. Thereafter, Tivoli Storage Manager does not prompt for the password. This is the default.
prompt
Tivoli Storage Manager prompts for the password for each backup, archive, and restore operation.

Examples

Options file:
encryptkey prompt

Errorlogname

Authorized User

The errorlogname option specifies the fully qualified path and file name of the file in which 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 are created in the same directory as the error log file you specify with the errorlogname option.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the General category, Select Error Log button of the Preferences editor.

Syntax

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

Parameters

filespec
The fully qualified path and file name in which to store error log information. If any part of the path you specify does not exist, Tivoli Storage Manager attempts to create it.

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.

The dsmerror.log file cannot be a symbolic link.

Examples

Options file:
errorlogname /tmp/tsmerror.log

Command line:
-errorlogname=/tmp/tsmerror.log

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

Errorlogretention

Authorized User

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

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the General category, Select Error Log button of the Preferences editor.

Syntax

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

Parameters

N  or  days
Specifies how long to wait before pruning the error log.
N
Do not prune the error log. This permits the error log to grow indefinitely. This is the default.
days
The number of days to keep log file entries before pruning the log. The range of values is zero through 9999.
D  or  S
Specifies whether to save the pruned entries. Enter a space or comma to separate this parameter from the previous one.
D
Discard the error log entries when you prune the log. This is the default.
S
Save the error log entries when you prune the log.

The pruned entries are copied from the error log to the dsmerlog.pru file located in the same directory as the error log.

Examples

Options file:
errorlogretention 400 S

Command line:
-errorlogr=400,S

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

Exclude options

Authorized User

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.

You can exclude specific files from encryption processing during a backup.

Notes:

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

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

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

Attention: See "Excluding system files" for a list of files that you should always exclude.

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

To exclude an entire directory called /any/test, enter the following:

  exclude.dir /any/test

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

  exclude.dir /any/test*

|Controlling symbolic link processing
|

|Tivoli Storage Manager treats symbolic links as actual files and backs them |up. However, the file referenced by the symbolic link is not backed |up. In some cases symbolic links can be easily recreated and need not |be backed up. In addition, backing up these symbolic links can increase |backup processing time and occupy a substantial amount of space on the Tivoli |Storage Manager server. You can use the |exclude.attribute.symlink option to exclude a file or |a group of files that are symbolic links from backup processing. If |necessary, you can use the include.attribute.symlink |option to include symbolic links within broad group of excluded files for |backup processing. For example, to exclude all symbolic links from |backup processing, except those that exist under the /home/spike directory, |enter these statements in your client system options file |(dsm.sys):

|  exclude.attribute.symlink  /.../*
|  include.attribute.symlink /home/spike/.../*

|See Include options for more information about the |include.attribute.symlink option.

Controlling compression processing

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

Processing NAS file systems

Use the exclude.fs.nas option to exclude file systems from 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

This option is valid for all UNIX clients.

Options File

Place these options in the client system options file (dsm.sys). You can set these options on the Include-Exclude category, Define Include-Exclude Options section of the Preferences editor.

Syntax

>>-options pattern---------------------------------------------><
 
 

exclude, exclude.backup, exclude.file, exclude.file.backup
These options are equivalent. Use these options to exclude a file or group of files from backup services and space management services (if the HSM client is installed). The exclude.backup option only excludes files from normal backup, but not from HSM.
exclude.archive
Excludes a file or a group of files that match the pattern from archive services only.|
|exclude.attribute.symlink
|Excludes a file or a group of files that are symbolic links from backup |processing only.
exclude.compression
Excludes files from compression processing if the compression option is set to yes. This option applies to backups and archives.
exclude.dir
Excludes a directory, its files, and all its subdirectories and their files from backup processing. For example, the statement exclude.dir /test/dan/data1 excludes the /test/dan/data1 directory, its files, and all its subdirectories and their files.
exclude.encrypt
Excludes the specified files from encryption processing. This option does not affect whether files are excluded from backup or archive processing, only whether they are excluded from encryption processing.
exclude.fs
Excludes file spaces matching the pattern. The client does not consider the specified file space for processing and the usual deleted-file expiration process cannot occur. If you exclude a file space that was previously included, existing backup versions remain on the server subject to retention rules specified in the associated management class definition.
exclude.fs.nas
Excludes file systems on the NAS file server from an image backup when used with the backup nas command. If you do not specify a NAS node name, the file system identified applies to all NAS file servers. The backup nas command ignores all other exclude statements including exclude.fs and exclude.dir statements. This option is for AIX and Solaris clients only.
exclude.image
Excludes mounted file systems and raw logical volumes that match the pattern from image processing. This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, Solaris only.

Parameters

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

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

For the exclude.image option, the pattern is the name of a mounted file system or raw logical volume.

Examples

Options file:
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.attribute.symlink /.../*

Command line:
Does not apply.

Filelist

Use the filelist option with the following commands to process a list of files:

The Tivoli Storage Manager client opens the file you specify with this option and processes the list of files within according to the specific command. With the exception of the restore and retrieve commands, when you use the filelist option, Tivoli Storage Manager ignores all other file specifications on the command line.

The files (entries) listed in the filelist must adhere to the following rules:

The following is an example of a list of files within a filelist:

   /home/dir/file1
   /usr/tivoli/file2
   /usr/avi/dir1
   /fs1/dir2/file3
   "/fs2/Ha Ha Ha/file.txt"
   "/fs3/file.txt"

If an entry in the filelist indicates a directory, only that directory will process and not the files within the directory.

If the file name (the filelistspec) you specify with the filelist option does not exist, the command fails. Tivoli Storage Manager skips any entries in the filelist that are not valid files or directories. Tivoli Storage Manager logs errors and processing continues to the next entry.

Use file specifications with the restore and retrieve commands to denote the destination for the restored filelist entries. For example, in the restore command:

restore -filelist=/home/dir/file3 /usr/record/

the file specification /usr/record/ represents the restore destination for all entries in the filelist. However, in the selective command:

selective -filelist=/home/dir/file3 /usr/record/

the file specification /usr/record/ is ignored.

If you specify a directory in a filelist for the delete archive command, the directory is not deleted. Filelists that you use with the delete archive command should not include directories.

The entries in the list are processed in the order they appear in the filelist. For optimal processing performance, pre-sort the filelist by file space name and path.

Note:
Tivoli Storage Manager may back up a directory twice if the following conditions exist: For example, your filelist includes the entries /home/dir/file1 and /home/dir. If the /dir directory does not exist on the server, the /home/dir directory is sent to the server a second time.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-FILEList =- filelistspec------------------------------------><
 
 

Parameters

filelistspec
Specifies the location and name of the file that contains the list of files to process with the command.
Note:
When you specify the filelist option on the command line, the subdir option is ignored.

Examples

Command line:
sel -filelist=/home/avi/filelist.txt

Filename

Use the filename option with the query systeminfo command to specify a file name in which to store information gathered from one or more of the following items:

Note:
The query systeminfo command is intended primarily as an aid for IBM support to assist in diagnosing problems, although users who are familiar with the concepts addressed by this information may also find it useful. If you use the console option, no special formatting of the output is performed to accommodate screen height or width. Therefore, the console output may be difficult to read due to length and line-wrapping. In this case, it is recommended that you use the filename option with the query systeminfo command to allow the output to be written to a file that can subsequently be submitted to IBM support. See Console for more information.

Supported Clients

This option is valid for all UNIX clients.

Syntax

>>-FILEName =- outputfilename----------------------------------><
 
 

Parameters

outputfilename
Specifies a file name in which to store the information. If you do not specify a file name, by default the information is stored in the dsminfo.txt file.

Examples

Command line:
query systeminfo dsmoptfile errorlog -filename=tsminfo.txt

Filesonly

The filesonly option restricts back up, restore, retrieve, or query processing to files only. You cannot restore or retrieve directories from the Tivoli Storage Manager server when using the filesonly option with the restore or retrieve commands. However, directories with default attributes are created, if required, as placeholders for files that you restore or retrieve.

You can also use the filesonly option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-FILESOnly---------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc incremental -filesonly

Followsymbolic

The followsymbolic option specifies whether you want to restore files to symbolic links or use a symbolic link as a virtual mount point. Use this option with the restore and retrieve commands, or in the client user options file (dsm.opt).

The followsymbolic option does not determine whether Tivoli Storage Manager follows symbolic links during backup or archive operations. During a backup operation, symbolic links are never followed. During an archive operation, you can use the archsymlinkasfile option to specify whether Tivoli Storage Manager follows a symbolic link and archives the file or directory it points to, or archives the symbolic link only. See Archsymlinkasfile for more information about the archsymlinkasfile option. See Understanding how symbolic links are handled for more information about how Tivoli Storage Manager handles symbolic links.

Supported Clients

This option is valid for all UNIX clients.

Options File

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

Syntax

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

Parameters

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

Examples

Options file:
followsymbolic Yes

Command line:
-fol=Yes

Fromdate

Use the fromdate option with the fromtime option to specify a date and time from which you want to search for backups or archives during a restore, retrieve, or query operation. Files that were backed up or archived before this date and time are not included, although older directories might be included, if necessary, to restore or retrieve the files.

Use the fromdate option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-FROMDate =- date--------------------------------------------><
 
 

Parameters

date
Specifies the date from which you want to search for backup copies or archived files. Enter the date in the format you selected with the dateformat option.

When you include dateformat with a command, it must precede the fromdate, pitdate, and todate options.

Examples

Command line:
dsmc query backup -fromdate=12/11/2003 /home/dilbert/*

Fromnode

The fromnode option permits one node to perform commands for another node. A user on another node must use the set access command to permit you to query, restore, or retrieve files or images for the other node.

Use the fromnode option with the following commands:

Supported Clients

This option is valid for all UNIX clients.

Syntax

>>-FROMNode =- node--------------------------------------------><
 
 

Parameters

node
Specifies the node name on a workstation or a file server whose backup copies or archived files you want to access.

Examples

Command line:
dsmc query archive -fromnode=bob -subdir=yes "/home/jones/*"

Fromowner

The fromowner option specifies an alternate owner from which to restore backup versions or archived files or images. The owner must give access to another to use the files or images. For example, to restore files from the /home/devel/proja directory belonging to usermike on system puma, and place the restored files in a directory you own named /home/id/proja, enter:

   dsmc restore -fromowner=usermike -fromnode=puma /home/devel/proja/
   /home/id/proja/

Non-root users can specify -fromowner=root to access files owned by the root user if the root user has granted them access.

Note: If you specify the fromowner option without the fromnode option, the active user must be on the same node as the fromowner user.

Use the fromowner option with the following commands:

Supported Clients

This option is valid for all UNIX clients.

Syntax

>>-FROMOwner =- owner------------------------------------------><
 
 

Parameters

owner
Name of an alternate owner.

Examples

Command line:
dsmc query archive "/home/id/proja/*" -fromowner=mark

Fromtime

Use the fromtime option with the fromdate option to specify a beginning time from which you want to search for backups or archives during a restore, retrieve, or query operation. Tivoli Storage Manager ignores this option if you do not specify the fromdate option.

Use the fromtime option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-FROMTime =- time--------------------------------------------><
 
 

Parameters

time
Specifies a beginning time on a specific date from which you want to search for backed up or archived files. If you do not specify a time, the time defaults to 00:00:00. Specify the time in the format you selected with the timeformat option.

When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.

Examples

Command line:
dsmc q b -timeformat=4 -fromt=11:59AM -fromd=06/30/2003 -tot=11:59PM -tod=06/30/2003 /home/*

Groupname

Use the groupname option with the backup group command to specify the name for a group. You can only perform operations on new groups or the current active version of the group.

Supported Clients

This option is valid for all UNIX clients.

Syntax

>>-GROUPName =- name-------------------------------------------><
 
 

Parameters

name
Specifies the name of the group which will contain the files backed up using the filelist option. Directory delimiters are not allowed in the group name since the group name is not a file specification, but a name field.

Examples

Command line:
backup group -filelist=/home/dir1/filelist1 -groupname=group1
-virtualfsname=/virtfs -mode=full

Groups

Authorized User

The groups option specifies UNIX system 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 valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza.

Syntax

   .- ---------------------.
   |        .- ----------. |
   V        V            | |
>>---GRoups--- groupname-+-+-----------------------------------><
 
 

Parameters

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

Examples

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

Command line:
Does not apply.

Guitreeviewafterbackup

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

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client user options file (dsm.opt) or the client system options file (dsm.sys). You can set this option on the General category, Return to tree window after function completed check box of the Preferences editor.

Syntax

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

Parameters

No
Returns you to the Tivoli Storage Manager main window after a successful operation completes. This is the default.
Yes
Returns you to the Backup, Restore, Archive, or Retrieve window after a successful operation completes.

Examples

Options file:
guitreeviewafterbackup yes

Command line:
Does not apply.

Httpport

Authorized User

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

Notes:

  1. See Configuring Tivoli Storage Manager client/server communication across a firewall for information about using the httpport option to allow the Web client to communicate with remote workstations across a firewall.

  2. The Tivoli Storage Manager client API does not support this option.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Web Client category -> HTTP Port field of the Preferences editor.

Syntax

>>-HTTPport- port_address--------------------------------------><
 
 

Parameters

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

Examples

Options file:
httpport 1502

Command line:
Does not apply.

Ifnewer

The ifnewer option replaces an existing file with the latest backup version only if the backup version is newer than the existing file. Only active backups are considered unless you also use the inactive or latest options.

Use the ifnewer option with the following commands:

Note:
This option is ignored if the replace option is set to No.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-IFNewer-----------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc restore "/home/grover/*" -sub=y -rep=y -ifnewer

Imagetofile

Use the imagetofile option with the restore image command to specify that you want to restore the source image to a file. You may need to restore the image to a file if bad sectors are present on the target volume, or if you want to manipulate the image data. Later, you can use a 'dd' utility (available on Unix) or its equivalent to copy data from this file to a logical volume.

Supported Clients

This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-IMAGETOfile-------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc restore image /usr /home/usr.img -imagetofile

Imagetype

Authorized User

Use the imagetype option with the backup image command or the include.image option to specify the type of image backup you want to perform.

Place the include.image statement containing the imagetype value in your client system options file dsm.sys.

Supported Clients

This option is valid for AIX, Solaris, HP-UX, Linux86, Linux IA64, Linux pSeries, and Linux iSeries clients only. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Include-Exclude category of the Preferences editor.

Syntax

>>-IMAGETYpe-=value--------------------------------------------><
 
 

Parameters

value
Specifies one of the following values:
snapshot
Specifies that you want to perform an snapshot image backup during which the volume is available to other system applications. This is the default for file systems residing on a logical volume created by the Linux Logical Volume Manager. Valid for Linux86 and Linux IA64 clients only.
dynamic
Replaces the dependency on the copy serialization value in the management class to perform an image backup without unmounting and remounting the file system read-only. Use this option only if the volume cannot be unmounted and remounted read-only. Tivoli Storage Manager backs up the volume as is without remounting it read-only. Corruption of the backup may occur if applications write to the volume while the backup is in progress. In this case, run fsck after a restore. This option is valid for AIX, Solaris, HP-UX, Linux86, Linux IA64, Linux pSeries, and Linux iSeries.
static
Replaces the dependency on the copy serialization value in the management class. Specifies that you want to perform an image backup during which the volume is unmounted and remounted read-only. This is the default for AIX, HP-UX, and Solaris. This option is valid for AIX, Solaris, HP-UX, Linux86, Linux IA64, Linux pSeries, and Linux iSeries.

Examples

Options file:
include.image /home MYMC imagetype=static

Command line:
-imagetype=static

Inactive

Use the inactive option and the pick option with the following commands to display both active and inactive objects:

You can also use the pick option to display backup versions, archive copies, and images that match the file specification you enter.

Only active backups are considered unless you also use either the inactive or the latest option.

When using the inactive option during a restore operation, it is recommended that you also use the pick or some other filtering option such as pitdate because, unlike the -latest option, it is indeterminate which version of the file will actually be restored.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-INActive----------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc restore "/home/zoe/*" -inactive -pick

Inclexcl

Authorized User

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

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

Ensure that you store your include-exclude options file in a directory to which all users have read access, 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, in the same order, 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 more information about creating an include-exclude options file, see Creating an include-exclude list (optional root user or authorized user task).

Supported Clients

This option is valid for all all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Include-Exclude category of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
inclexcl /usr/dsm/backup.excl
inclexcl /etc/inclexcl.def

Command line:
Does not apply.

Include options

Authorized User

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. Use the query mgmtclass command to display information about the management classes available in your active policy set.

Notes:

  1. The exclude.fs and exclude.dir statements override all include statements that match the pattern.
  2. The server can also define these options with the inclexcl option.

|Controlling symbolic link processing
|

|Tivoli Storage Manager treats symbolic links as actual files and backs them |up. However, the file referenced by the symbolic link is not backed |up. In some cases symbolic links can be easily recreated and need not |be backed up. In addition, backing up these symbolic links can increase |backup processing time and occupy a substantial amount of space on the Tivoli |Storage Manager server. You can use the |exclude.attribute.symlink option to exclude a file or |a group of files that are symbolic links from backup processing. If |necessary, you can use the include.attribute.symlink |option to include symbolic links within broad group of excluded files for |backup processing. For example, to exclude all symbolic links from |backup processing, except those that exist under the /home/spike directory, |enter these statements in your client system options file |(dsm.sys):

|  exclude.attribute.symlink  /.../*
|  include.attribute.symlink /home/spike/.../*

|See Exclude options for more information about the |exclude.attribute.symlink option.

Compression and encryption processing

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

Processing NAS file systems

Use the include.fs.nas option to bind a management class to NAS file systems and to control if Table of Contents information is saved for the file system backup.

A NAS file system specification uses the following conventions:

Use the following syntax:

>>-patternmgmtclassnametoc=value---------------------------><
 
 

Parameters

pattern
Specifies the objects to include for backup services, to assign a specific management class, or to control TOC creation. You can use wildcards in the pattern.
mgmtclassname
Specifies the name of the management class to assign to the objects. If a management class is not specified, the default management class is used.
toc=value
See Toc for more information.

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 toc=yes

Processing WebSphere Application Server (WAS) file systems

You can use the include option in your client system options file (dsm.sys) to assign a management class to a WAS group backup. For example:

See "Creating an include-exclude list (optional root user or authorized user task)" for more information.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place these options in the client system options file (dsm.sys). You can set these options on the Include-Exclude category, Define Include-Exclude Options section of the Preferences editor.

Syntax

>>-options pattern -+----------------+-------------------------><
                    '- mgmtclassname-'
 
 

include, include.backup, include.file
These options are equivalent. Use these options to include files or assign management classes for backup processing.
include.archive
Includes files or assigns management classes for archive processing.|
|include.attribute.symlink
|Includes a file or a group of files that are symbolic links within broad |group of excluded files for backup processing only.
include.compression
Includes files for compression processing if you set the compression option to yes. This option applies to backups and archives.
include.encrypt
Includes the specified files for encryption processing. By default, Tivoli Storage Manager does not perform encryption processing.
include.fs.nas
Use the include.fs.nas option to bind a management class to Network Attached Storage (NAS) file systems. You can also specify whether Tivoli Storage Manager saves Table of Contents (TOC) information during a NAS file system image backup, using the toc option with the include.fs.nas option in your client system options file (dsm.sys). See Toc for more information. This option is valid for AIX and Solaris clients only.
include.image
Includes a file space or logical volume, or assigns a management class when used with the backup image command. The backup image command ignores all other include options.

You can use the imagetype option with the backup image command or the include.image option to specify whether to perform a static, dynamic, or snapshot (Linux86 and Linux IA64 only) image backup.

For Linux86 and Linux IA64 clients: Use the snapshotcachesize option with the backup image command, in the dsm.opt file, or with the include.image option to specify an appropriate snapshot size so that all old data blocks can be stored while the image backup occurs. A snapshot size of 100 percent will ensure a valid snapshot. See Snapshotcachesize for more information.

This option is valid for AIX, HP-UX, Solaris, Linux86, Linux IA64, Linux pSeries, and Linux iSeries.

Parameters

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

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

For the include.image option, the pattern is the name of a mounted file system or raw logical volume.

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

Examples

Options file:
include /home/proj/text/devel.*
include /home/proj/text/* textfiles
include * managall
include /WAS_ND_NDNODE mgmtclass
include /WAS_APPNODE mgmtclass
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.image /home MGMTCLASSNAME type=snapshot snapshotcachesize=40
include.image /home imagetype=static
include.image /home imagetype=snapshot
include.image /home MGMTCLASSNAME imagetype=static
include.attribute.symlink /home/spike/.../*

Command line:
Does not apply.

Incrbydate

Use the incrbydate option with the incremental command to back up new and changed files with a modification date later than the last incremental backup stored at the server, unless you exclude the file from backup. Files added at the client after the last incremental backup, but with a modification date earlier than the last incremental, are not backed up.

An incremental-by-date updates the date and time of the last incremental at the server. If you perform an incremental-by-date on only part of a file system, the date of the last full incremental is not updated and the next incremental-by-date will back up these files again.

Both full incrementals and incrementals-by-date back up new and changed files. An incremental-by-date takes less time to process than a full incremental and requires less memory. However, unlike a full incremental, an incremental-by-date does not maintain current server storage of all your workstation files because:

Note: If you have limited time during the week to perform backups, but extra time on weekends, you can maintain current server storage of your workstation files by performing an incremental backup with the incrbydate option on weekdays and a full incremental backup on weekends.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-INCRbydate--------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc incremental -incrbydate

Incremental

Use the incremental option with the restore image command to ensure that any changes that were made to the base image are also applied to the restored image.

If you also use the deletefiles option, changes include the deletion of files and directories that were in the original image but later deleted from the workstation.

Supported Clients

This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-INCREmental-------------------------------------------------><
 
 

Examples

Command line:
res i "/home/devel/projecta/*" -incremental

Lanfreecommmethod

Authorized User

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 and HP-UX: Use the lanfreeshmport to specify the Shared Memory port number where the Storage Agent is listening. See Lanfreeshmport for more information

Supported Clients

This option is valid for AIX, HP-UX, Linux86, Linux pSeries, Linux iSeries, and Solaris clients only.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza.

Syntax

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

Parameters

commmethod
Specifies the supported protocol for your Tivoli Storage Manager client:
TCPip
The Transmission Control Protocol/Internet Protocol (TCP/IP) communication method.

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

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

Examples

Options file:
lanfreec tcp

Command line:
-lanfreec=tcp

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

Lanfreeshmport

Authorized User

The lanfreeshmport option specifies the Shared Memory port number where the Tivoli Storage Manager Storage Agent is listening. This option is valid for AIX and Solaris clients only.

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 and HP-UX clients only.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza.

Syntax

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

Parameters

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

Examples

Options file:
lanfrees 1520

Command line:
-lanfrees=1520

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

Lanfreetcpport

Authorized User

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. Do not specify the lanfreetcpport option if you want to use the NAMedpipes communication method for LAN-free communication. See Lanfreecommmethod for more information about the lanfreecommmethod option.

Supported Clients

This option is valid for AIX, HP-UX, Linux86, Linux pSeries, Linux iSeries, and Solaris clients only.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza.

Syntax

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

Parameters

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

Note: The client lanfreetcport value must match Storage Agent tcpport value for communications with the Storage Agent (virtual server). The client tcpport value must match the server tcpport value for communications with the actual server.

Examples

Options file:
lanfreetcp 1520

Command line:
-lanfreetcp=1520

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

Largecommbuffers

Authorized User

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

This option is valid for all UNIX clients.

Options File

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

Syntax

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

Parameters

No
Specifies that increased buffers are not used to transfer large amounts of data to the server. This is the default. For AIX, the default is Yes.
Yes
Specifies that increased buffers are used to transfer large amounts of data to the server. On AIX the buffer is increased to 256KB which matches the server buffer, allowing increased performance. This is the default for AIX only.

Examples

Options file:
largecommbuffers yes

Command line:
-largecommbuffers=yes

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

Latest

Use the latest option with the following commands to restore the most recent backup version of a file, even if the backup is inactive:

Only active versions are considered for a restore unless you use either the inactive or the latest option.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-LATest------------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc restore "/home/devel/projecta/*" -latest

Localbackupset

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

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

If you set the localbackupset option to 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
Note:
The restore backupset command supports restore of local backup sets on a standalone workstation without using the localbackupset option. See Restore Backupset for more information.

Supported Clients

This option is valid for all UNIX clients.

Options File

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

Syntax

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

Parameters

No
Specifies that the GUI attempts initial logon with the server and enables all functions. This is the default.
Yes
Specifies that the GUI does not attempt initial logon with the server and enables only the restore functionality.

Examples

Options file:
localbackupset yes

Command line:
dsm -localbackupset=yes

This option is not valid with the dsmc command line client.

Location

The location option specifies where Tivoli Storage Manager searches for a backup set during a query or restore operation. You can use this option to locate backup sets on the server or local files. Tapes that are generated on the server can be used locally by specifying the location option and either the file name or the tape device.

Use the location option with the query backupset and restore backupset commands.

Notes:

  1. If you use the restore backupset command on the initial command line and you set the location option to tape or file, no attempt is made to contact the server.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

              .-server-.
>>-LOCation =-+--------+---------------------------------------><
              +-file---+
              '-tape---'
 
 

Parameters

server
Specifies that Tivoli Storage Manager searches for the backup set on the server. This is the default.
file
Specifies that Tivoli Storage Manager searches for the backup set on a local file.
tape
Specifies that Tivoli Storage Manager searches for the backup set on a local tape device. It is no longer necessary to specify a specific tape device type name. Specifying location=tape covers all tape device types. This parameter is valid for Solaris, AIX, and HP-UX clients.
Note:
For Solaris, AIX, HP-UX, and Solaris If you want to restore a backup set from a 3570 or 3590 tape device, but you do not have the 3570 or 3590 generic device driver on your client workstation, you can download these device drivers from the following Web site:
   ftp://ftp.software.ibm.com/storage/devdrvr/

For Solaris: Use tapes that are fully compliant with Sun standards.

Examples

Command line:
restore backupset "/dev/rmt0" -loc=tape
restore backupset mybackupsetname -loc=server
restore backupset /home/budget/backupsetfile.name -loc=file
 

Makesparsefile

Use the makesparsefile option with the restore or retrieve commands to specify how sparse files are recreated. Sparse files do not have disk space allocated for every block in the whole address space, leading to holes within the file. The Tivoli Storage Manager client detects sparse files during a backup operation and marks them as sparse on the Tivoli Storage Manager server. Holes are detected by their content, which is always zeros.

If you set the makesparsefile option to yes (default), holes within the file are not written to disk so no additional disk space is allocated during a restore.

If you set the makesparsefile option to no, holes are not recreated, leading to disk blocks allocated for the whole address space. This might result in a larger amount of used disk space. Ensure that you have enough disk space to restore all data.

On some UNIX systems, it may be necessary to back up system specific files as non-sparse files. Use the makesparsefile option for files where the existence of physical disk blocks is required, such as ufsboot on Solaris, which is executed during boot time. The boot file loader of the operating system accesses physical disk blocks directly and does not support sparse files.

Supported Clients

This option is valid for all UNIX clients.

Options File

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

Syntax

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

Parameters

Yes
Specifies that holes within the file are not written so that no additional disk space is allocated during a restore. This is the default.
No
Specifies that holes are not recreated leading to disk blocks allocated for the whole address space.

Examples

Options file:
makesparsefile no

Command line:
-makesparsefile=no

Mailprog

Authorized User

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 set the passwordaccess option to generate.

Supported Clients

This option is for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza.

Syntax

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

Parameters

filespec
Specifies the path and file name of the program to which you want to send a newly-generated password. The program you specify must accept standard output.
userid
Specifies the user ID of the user to whom you want to send a newly-generated password. For OS/390 UNIX System Services, enter the user ID in uppercase letters.

Examples

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

Command line:
Does not apply.

Managedservices

Authorized User

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

See Configuring the client scheduler for instructions to set up the CAD to manage the scheduler.

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

Notes:

  1. If you set the schedmode option to prompt, the server prompts the CAD when it is time to run the schedule. The scheduler will connect and disconnect to the server when the CAD is first started.

  2. Set the passwordaccess option to generate in your client system options (dsm.sys) and generate a password, so Tivoli Storage Manager can manage your password automatically. See Passwordaccess for more information.

Using the CAD to manage the scheduler service can provide the following benefits:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Web Client of the Preferences editor.

Syntax

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

Parameters

mode
Specifies whether the CAD manages the scheduler, the Web client, or both.
webclient
Specifies that the CAD manages the Web client. This is the default.
schedule
Specifies that the CAD manages the scheduler.

Examples

Options file:
The following are examples of how you might specify the managedservices option in your client system options file (dsm.sys).

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

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

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

Command line:
Does not apply.

Maxcmdretries

Authorized User

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

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

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Scheduler category, Maximum command retries field of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
maxcmdr 4

Command line:
-maxcmdretries=4

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

Memoryefficientbackup

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

Supported Clients

This option is valid for all UNIX clients. The server can also define this option.

Options File

Place this option in the client user options file (dsm.opt). You can set this option on the Backup category, Use memory-saving algorithm checkbox of the Preferences editor.

Syntax

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

Parameters

No
Your client node uses the faster, more memory-intensive method when processing incremental backups. This is the default.
Yes
Your client node uses the method that requires less memory when processing incremental backups.

Examples

Options file:
memoryefficientbackup yes

Command line:
-memoryef=no

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

Mode

Use the mode option with these commands, as follows:

backup image
To specify whether to perform a selective or incremental image backup of client file systems.

backup nas
To specify whether to perform a full or differential image backup of NAS file systems.

backup was
To specify whether to perform a full or differential backup of the WebSphere Application Server (WAS) Network Deployment Manager (contains setup, application files, and configuration information) or the Application Server (also contains setup, application files, and configuration information) to the Tivoli Storage Manager server.

backup group
To specify whether to perform a full or differential group backup containing a list of files from one or more file space origins.

The mode option has no effect on a raw logical device backup.

Supported Clients

This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. The Tivoli Storage Manager client API does not support this option.

Syntax

For image backup of client file systems (AIX, Solaris, HP-UX, Linux86, Linux IA64, Linux pSeries, and Linux iSeries)

          .-Selective---.
>>-MODE =-+-------------+--------------------------------------><
          '-Incremental-'
 
 

For image backup of NAS file systems (AIX and Solaris)

          .-differential-.
>>-MODE =-+--------------+-------------------------------------><
          '-full---------'
 
 

For group and WAS backups (AIX, Solaris, Linux86)

          .-full---------.
>>-MODE =-+--------------+-------------------------------------><
          '-differential-'
 
 

Parameters

selective
Specifies that you want to perform a full (selective) image backup. This is the default for image backup of client file systems.
incremental
Specifies that you want to back up only new and changed files after the last full image backup. Deleted files are not inactivated on the server.
full
Specifies that you want to perform a full backup of NAS, WAS, or group objects. This is the default for WAS and group backups.
differential
Specifies that you want to perform a NAS, WAS, or group backup of files that changed since the last full backup. If an eligible full backup does not exist, a full backup occurs. This is the default for NAS objects.

Examples

Task
Perform the NAS image backup of the entire file system.

Command: dsmc backup nas -mode=full -nasnodename=nas1 /vol/vol0 /vol/vol1

Task
Back up the /home/test file space using an image incremental backup that backs up only new and changed files after the last full image backup.

Command: dsmc backup image /home/test -mode=incremental

Task
Perform a full backup of all the files in filelist /home/dir1/filelist1 to the virtual file space name /virtfs containing the group leader /home/group1 file.

Command:

backup group -filelist=/home/dir1/filelist1 -groupname=group1
-virtualfsname=/virtfs -mode=full

Monitor

The monitor option specifies whether to monitor an image backup or restore of file systems belonging to a Network Attached Storage (NAS) file server.

If you specify monitor=yes, Tivoli Storage Manager monitors the current NAS image backup or restore operation and displays processing information on your screen. This is the default.

If you specify monitor=no, Tivoli Storage Manager does not monitor the current NAS image backup or restore operation and is available to process the next command.

Use this option with the backup nas or restore nas commands.

Supported Clients

This option is valid for AIX and Solaris clients only.

Syntax

             .-Yes-.
>>-MONitor =-+-----+-------------------------------------------><
             '-No--'
 
 

Parameters

Yes
Specifies that you want to monitor the current NAS image backup or restore operation and display processing information on your screen. This is the default.
No
Specifies that you do not want to monitor the current NAS image backup or restore operation.

Examples

Command line:
backup nas -mode=full -nasnodename=nas1 -monitor=yes
/vol/vol0 /vol/vol1

Nasnodename

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

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

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

You can use the nasnodename option with the following commands:

Supported Clients

This option is valid for the AIX and Solaris clients only. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the General category of the Preferences editor.

Syntax

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

Parameters

nodename
Specifies the node name for the NAS file server.

Examples

Options file:
nasnodename nas2

Command line:
-nasnodename=nas2

Nfstimeout

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

You can use this option to mitigate the default behavior of status calls on 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 thread is created by a caller thread to issue the status system call. The new thread is timed out by the caller thread and the operation can continue.

Note:
On Solaris and HP-UX, the nfstimeout option can fail if the NFS mount is hard. If a hang occurs, deactivate the nfstimeout option and mount the NFS file system soft mounted, as follows:
mount -o soft,timeo=5,retry=5 machine:/filesystem /mountpoint
The parameters are defined as follows:

soft
Generates a soft mount of the NFS file system. If an error occurs, the stat() function returns with an error if the option hard is used, stat() never returns until the file system is available.

timeo=n
Sets the time out for a soft mount error to n seconds

retry=n
Set the internal retries and the mount retries to 5, the default is 10000.
See Understanding how NFS hard and soft mounts are handled, GC32-0789 for a discussion of how NFS hard and soft mounts are handled.

Supported Clients

This option is for all UNIX clients. The server can also define this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza or the client options file (dsm.opt).

Syntax

>>-NFSTIMEout number-------------------------------------------><
 
 

Parameters

number
Specifies the number of seconds the server waits for a status system call on a file system before timing out. The range of values is 0 through 120; the default is 0 seconds.

Examples

Options file:
nfstimeout 10

Command line:
-nfstimeout=10

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

Nodename

Authorized User

Use the nodename option in your client system options file dsm.sys to identify 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.

When connecting to a server, the client must identity itself to the server. This login identification is determined in the following manner:

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the General category, Node Name field of the Preferences editor.

Syntax

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

Parameters

nodename
Specifies a 1 to 64 character node name for which you want to request Tivoli Storage Manager services. The default is the name of the workstation. If you set the clusternode option to yes, the default is the cluster name.

Examples

Options file:
nodename cougar

Command line:
Does not apply.

Noprompt

The noprompt option suppresses the confirmation prompt that normally appears before you delete an archived file after using the deletefiles option with the archive command, or when performing an image restore operation. Using this option can speed up the delete procedure. However, it also increases the danger of accidentally deleting an archived file that you want to save. Use this option with caution.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-NOPrompt----------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc delete archive -noprompt "/home/project/*"

Numberformat

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

The AIX, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. See for supported locales. The default directories for system-supplied locales are as follows:

The backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. Consult the documentation on your local system for details about setting up your locale definition.

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

You can use the numberformat option with the following commands:

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client user options file (dsm.opt). . You can set this option on the Regional Settings category, Number Format field of the Preferences editor.

Syntax

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

Parameters

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

This is the default for the following supported languages:

  • US English
  • Japanese
  • Chinese (Traditional)
  • Chinese (Simplified)
  • Korean
2
1,000,00
3
1 000,00

This is the default for the following supported languages:

  • French
  • Czech
  • Hungarian
  • Polish
  • Russian
4
1 000.00
5
1.000,00

This is the default for the following supported languages:

  • Brazilian Portuguese
  • German
  • Italian
  • Spanish
6
1'000,00

For AIX, HP-UX, and Solaris: To define number formats, modify the following lines in the source file of your locale. Whatever format you select applies both to output and to input.

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

Examples

Options file:
num 4

Command line:
-numberformat=4

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

Optfile

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

Supported Clients

This option is valid for all UNIX clients.

Syntax

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

Parameters

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

Examples

Command line:
   dsmc query session -optfile=myopts.opt

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

Password

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

Notes:

  1. If the server prompts for a password, the password does not display as you enter it. However, if you use the password option on the command line, your password will display as you enter it.

  2. If the Tivoli Storage Manager server name changes or Tivoli Storage Manager clients are directed to a different Tivoli Storage Manager server, all clients must re-authenticate with the server because the stored encrypted password must be regenerated.

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

Supported Clients

This option is valid for all UNIX clients.

Options File

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

Syntax

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

Parameters

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

Examples

Options file:
password secretword

Command line:
-password=secretword

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

Passwordaccess

Authorized User

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:

Use the passworddir option in your client system options file (dsm.sys) to specify the directory location in which to store the encrypted password file. The default directory location depends on how the client was installed. Regardless of where it is stored, the password file created by Tivoli Storage Manager is always named TSM.PWD.

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

Setting the passwordaccess option to generate is required in the following situations:

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Authorization category, Password Access section of the Preferences editor.

Syntax

                  .-prompt---.
>>-PASSWORDAccess-+----------+---------------------------------><
                  '-generate-'
 
 

Parameters

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

To keep your client node password secure, enter commands without the password and wait for Tivoli Storage Manager to prompt you for the password.

Each user must know the Tivoli Storage Manager password for your client node. Any user who knows the password for your client node can gain access to all backups and archives that originate from your client node. For example:

API applications must supply the password when a session is initiated. The application is responsible for obtaining the password.

generate
Encrypts and stores your password locally and generates a new password when the old password expires.

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

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.

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 you specify the same node name 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.

Examples

Options file:
passwordaccess generate

Command line:
Does not apply

Passworddir

Authorized User

The passworddir option specifies the directory location in which to store an encrypted password file. The default directory location depends on where the client was installed. Regardless of where it is stored, the password file created by Tivoli Storage Manager is always named TSM.PWD.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Authorization category, Location section of the Preferences editor.

Syntax

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

Parameters

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

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

Examples

Options file:
passworddir /etc/security/tsm 

Command line:
Does not apply.

Pick

The pick option creates a list of backup versions, images, or archive copies that match the file specification you enter. From the list, you can select the versions to process. Include the inactive option to view both active and inactive objects.

For images, if you do not specify a source file space and destination file space, the pick list contains all backed up images. In this case, the images selected from the pick list are restored to their original location. If you specify the source file space and the destination file space, you may select only one entry from the pick list.

Use the pick option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-PIck--------------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc restore "/home/project/*" -pick -inactive

Pitdate

Use the pitdate option with the pittime option to establish a point in time for which you want to display or restore the latest version of your backups. Files or images that were backed up on or before the date and time you specified, and which were not deleted before the date and time you specified, are processed. Backup versions that you create after this date and time are ignored.

Use the pitdate option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-PITDate =- date---------------------------------------------><
 
 

Parameters

date
Specifies the appropriate date. Enter the date in the format you selected with the dateformat option.

When you include dateformat with a command, it must precede the fromdate, pitdate, and todate options.

Examples

Command line:
dsmc restore "/fs1/*" -sub=y -pitdate=08/01/2003 -pittime=06:00:00

Pittime

Use the pittime option with the pitdate option to establish a point in time for which you want to display or restore the latest version of your backups. Files or images that were backed up on or before the date and time you specify, and which were not deleted before the date and time you specify, are processed. Backup versions that you create after this date and time are ignored. This option is ignored if you do not specify pitdate option.

Use the pittime option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-PITTime =- time---------------------------------------------><
 
 

Parameters

time
Specifies a time on a specified date. If you do not specify a time, the time defaults to 23:59:59. Specify the time in the format you selected with the timeformat option.

When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.

Examples

Command line:
dsmc q b "/fs1/*" -pitt=06:00:00 -pitd=08/01/2003

Postschedulecmd/Postnschedulecmd

Authorized User

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.

Notes:

  1. If the postschedulecmd command does not complete with return code 0, the client will report that the scheduled event completed with return code 8 (unless the scheduled operation encounters a more severe error yielding a higher return code). If you do not want the postschedulecmd command to be governed by this rule, you can create a script or batch file that invokes the command and exits with return code 0. Then configure postschedulecmd to invoke the script or batch file. The return code for the postnschedulecmd command is not tracked, and does not influence the return code of the scheduled event.

  2. The server can also define the postschedulecmd option (and the postnschedulecmd option).

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Scheduler category, Schedule Command button of the Preferences editor.

Syntax

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

Parameters

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

If the command string contains blanks, enclose the command string in double quotes. If you placed double quotes within the command string, then enclose the entire command string in single quotes.

Use a blank, or null, string for cmdstring if you want to prevent any commands from running that the Tivoli Storage Manager server 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.

Examples

Options file:
postschedulecmd "restart database"

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

Command line:
-postschedulecmd="restart database"

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

Preschedulecmd/Prenschedulecmd

Authorized User

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.

Notes:

  1. Successful completion of the preschedulecmd command is considered to be a prerequisite to running the scheduled operation. If the preschedulecmd command does not complete with return code 0, the scheduled operation and any postschedulecmd and postnschedulecmd commands will not run. The client will report that the scheduled event failed, and the return code will be 12. If you do not want the preschedulecmd command to be governed by this rule, you can create a script or batch file that invokes the command and exits with return code 0. Then configure preschedulecmd to invoke the script or batch file. The return code for the prenschedulecmd command is not tracked, and does not influence the return code of the scheduled event.

  2. The server can also define the preschedulecmd option (and the prenschedulecmd option).

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Scheduler category, Schedule Command button of the Preferences editor.

Syntax

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

Parameters

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

If the command string contains blanks, enclose the command string in double quotes. If you placed double quotes within the command string, then enclose the entire command string in single quotes.

Use a blank or null string for cmdstring if you want to prevent any commands from running that the Tivoli Storage Manager server 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.

Examples

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

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

Command line:
-preschedulecmd="quiesce database"

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

Preservelastaccessdate

Any application that touches a file may implicitly cause that file's last access date to change to the time that the application touches it. This is a function of the file system, not the application. Because of this, when the client backs up or archives a file, it may trigger an update to the file's last access date. This can cause problems for other applications such as Storage Resource Management (SRM) or Hierarchical Storage Management, whose processing relies on accurate last access dates.

Use the preservelastaccessdate option during a backup or archive operation to specify whether to reset the last access date of any specified files to their original value following the backup or archive operation. By default, the Tivoli Storage Manager client will not reset the last access date of any backed up or archived files to their original value following the backup or archive operation.

Use this option with the incremental, selective, or archive commands.

Notes:

  1. This option only applies to files; it does not apply to directories.

  2. Resetting the last access date incurs additional overhead that may impact backup and archive performance. The last access date should be reset only if you are using another application, such as a Storage Resource Management (SRM) or Hierarchical Storage Management that relies on accurate last access dates.

  3. You cannot reset the last access date of read-only files. The preservelastaccessdate option ignores read-only files and does not change their date.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client user options file (dsm.opt). You can set this option on the Backup category of the Preferences editor.

Syntax

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

Parameters

No
Specifies that the Tivoli Storage Manager client will not reset the last access date of any backed up or archived files to their original value following the backup or archive operation. This is the default.
Yes
Specifies that the Tivoli Storage Manager will reset the last access date of any backed up or archived files to their original value following the backup or archive operation.

Examples

Options file:
preservelastaccessdate yes

Command line:
Incremental /proj/test/test_file -preservelastaccessdate=yes

Preservepath

The preservepath option specifies how much of the source path to reproduce as part of the target directory path when you restore or retrieve files to a new location. Use the -subdir=yes option to include the entire subtree of the source directory (directories and files below the lowest-level source directory) as source to be restored. If a required target directory does not exist, it is created. If a target file has the same name as a source file, it is overwritten. Use the -replace=prompt option to have Tivoli Storage Manager prompt you before files are overwritten.

Use the preservepath option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

                  .-subtree--.
>>-PRESERvepath =-+----------+---------------------------------><
                  +-complete-+
                  +-nobase---+
                  '-none-----'
 
 

Parameters

subtree
Creates the lowest-level source directory as a subdirectory of the target directory. Files from the source directory are stored in the new subdirectory. This is the default.
complete
Restores the entire path, starting from the root, into the specified directory. The entire path includes all the directories except the file space name.
nobase
Restores the contents of the source directory without the lowest level, or base directory, into the specified destination directory.
none
Restores all selected source files to the target directory. No part of the source path at or above the source directory is reproduced at the target.

If you specify subdir=yes, Tivoli Storage Manager restores all files in the source directories to the single target directory.

Examples

Command line:
For the examples below, assume that the server file space contains the following backup copies:
/fs/h1/m1/file.a
/fs/h1/m1/file.b
/fs/h1/m1/l1/file.x
/fs/h1/m1/l1/file.y

This command:
dsmc res /fs/h1/m1/ /u/ann/ -preser=complete

Restores these directories and files:

/u/ann/h1/m1/file.a
/u/ann/h1/m1/file.b

This command:
dsmc res /fs/h1/m1/ /u/ann/ -preser=nobase

Restores these directories and files:

/u/ann/file.a
/u/ann/file.b

This command:
dsmc res backupset /fs/h1/m1/ /u/ann/ -su=yes 
-preser=nobase -loc=file

Restores these directories and files:

/u/ann/file.a
/u/ann/file.b
/u/ann/file.x
/u/ann/file.y

This command:
dsmc res /fs/h1/m1/ /u/ann/ -preser=subtree

Restores these directories and files:

/u/ann/m1/file.a
/u/ann/m1/file.b

This command:
dsmc res /fs/h1/m1/ /u/ann/ -preser=none

Restores these directories and files:

/u/ann/file.a
/u/ann/file.b

This command:
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=complete

Restores these directories and files:

/u/ann/h1/m1/file.a
/u/ann/h1/m1/file.b
/u/ann/h1/m1/l1/file.x
/u/ann/h1/m1/l1/file.y

This command:
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=nobase

Restores these directories and files:

/u/ann/file.a
/u/ann/file.b
/u/ann/l1/file.x
/u/ann/l1/file.y

This command:
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=subtree

Restores these directories and files:

/u/ann/m1/file.a
/u/ann/m1/file.b
/u/ann/m1/l1/file.x
/u/ann/m1/l1/file.y

This command:
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=none

Restores these directories and files:

/u/ann/file.a
/u/ann/file.b
/u/ann/file.x
/u/ann/file.y

Queryschedperiod

Authorized User

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

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

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option. The server can also define this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Scheduler category, Query Schedule Interval field of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
querysch 6

Command line:
-queryschedperiod=8

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

Quiet

The quiet option limits the number of messages that display on your screen during processing. For 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.

Supported Clients

This option is valid for all UNIX clients. The server can also define the quiet option, overriding the client setting. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client user options file (dsm.opt). You can set this option on the Command Line category, Do not display process information on screen checkbox of the Preferences editor.

Syntax

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

Parameters

There are no parameters for this option.

Examples

Options file:
quiet

Command line:
-quiet

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

|Removeoperandlimit

| | | |

|The removeoperandlimit option specifies that Tivoli Storage |Manager removes the 20-operand limit for Unix-family platforms. If you |specify the removeoperandlimit option with the |incremental, selective, or archive commands, |the 20-operand limit is not enforced and is restricted only by available |resources or other operating system limits.

|The removeoperandlimit option can be useful if you generate |scripts which may invoke the command line client with a large number of |operands. For example, you may prescan a directory tree looking for |files to back up. As each eligible file is discovered, it is |added to the operand list of a selective command. Later, |this selective command is submitted by a controlling script. |In this case, specifying the removeoperandlimit option removes the |20-operand limit for Unix-family platforms.

|Notes:

  1. |The removeoperandlimit option must be placed |immediately after the incremental, selective, or |archive command before any file specifications.

  2. |This option does not accept a value. If this option is specified on |a command, the 20-operand limit for Unix-family platforms is removed.

  3. |Because it adversely affects performance to allow the shell to expand wild |cards, it is recommended that you use the removeoperandlimit option |in backup or archive operations in which wild cards are not used.

  4. |The removeoperandlimit option is valid only on the |incremental, selective, or archive commands |in batch mode. It is not valid in the client options file |(dsm.opt) or client system options file (dsm.sys). |

|Supported Clients

|This option is valid for all UNIX clients.

|Syntax

|>>-REMOVEOPerandlimit------------------------------------------><
| 
| 

|Parameters

|There are no parameters for this option.

|Examples |

|Command line:
|-removeoperandlimit |

Replace

The replace option specifies whether to overwrite existing files on your workstation, or to prompt you for your selection when you restore or retrieve files. You can use this option with the following commands:

Note:
Replace prompting does not occur during a scheduled operation. If you set the replace option to prompt, Tivoli Storage Manager skips files without prompting during a scheduled operation.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client user options file (dsm.opt). You can set this option on the Restore category, Action for files that already exist section of the Preferences editor.

Syntax

           .-Prompt-.
>>-REPlace-+--------+------------------------------------------><
           +-All----+
           +-Yes----+
           '-No-----'
 
 

Parameters

Prompt
You are prompted whether to overwrite a file that already exists on your workstation. If the existing file is read-only, you are prompted whether to overwrite it. This is the default.
All
All existing files are overwritten, including read-only files. If access to a file is denied, you are prompted to skip or overwrite the file. No action is taken on the file until there is a response to the prompt.
Yes
Any existing files are overwritten, except read-only files. If a file is read-only, you are prompted to overwrite the file or skip it. No action is taken on the file until there is a response to the prompt. If access to a file is denied, the file is skipped.
No
Existing files are not overwritten. No prompts will display.

Examples

Options file:
replace all

Command line:
-replace=no

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

Resourceutilization

Authorized User

Use the resourceutilization option in your client system options file dsm.sys to regulate the level of resources the Tivoli Storage Manager server and client can use during processing.

Regulating backup and archive sessions

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. The client is also restricted to a single session if a user who is not an authorized user 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 you specify multiple file specifications with a backup or archive command. For example, if you enter:

inc filespaceA filespaceB

and you specify 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.

|Note: During a backup operation, if you enter |multiple file specifications, the result may be that files from one file |specification are stored on multiple tapes and interspersed with files from |different file specifications. This can decrease restore |performance. Setting the collocatebyfilespec option to |yes eliminates interspersing of files from different file |specifications, by limiting the client to one server session per file |specification. Therefore, if you store the data to tape, files for each |file specification are stored together on one tape (unless another tape is |required for more capacity). See Collocatebyfilespec for more information.

Regulating restore sessions

When you request a restore, the default is to use a maximum of one session, based on how many tapes the requested data is stored on, how many tape drives are available, and the maximum number of mount points allowed for the node.

Notes:

  1. If all of the files are on disk, only one session is used. There is no multi-session for a pure disk storage pool restore. However, if you are performing a restore in which the files reside on 4 tapes and some on disk, you could use up to 5 sessions during the restore.

  2. The Tivoli Storage Manager server can set the maximum number of mount points a node can use on the server using the MAXNUMMP parameter. If the resourceutilization option value exceeds the value of the MAXNUMMP on the server for a node, the backup can fail with an Unknown System Error message.

For example, if the data you want to restore is on 5 different tape volumes, the maximum number of mount points is 5 for your node, and resourceutilization is set to 3, then 3 sessions will be used for the restore. If you increase the resourceutilization setting to 5, then 5 sessions will be used for the restore. There is a 1 to 1 relationship to the number of restore sessions allowed for the resourceutilization setting. Multiple restore sessions are only allowed for no query restore operations.

Considerations

The following factors can affect the throughput of multiple sessions:

Potentially undesirable aspects of running multiple sessions include:

Supported Clients

This option is valid for all UNIX clients. The server can also define this option. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the General category, Resource Utilization field of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
resourceutilization 7

Command line:
-resourceutilization=7

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

Retryperiod

Authorized User

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 system options file after your client node successfully contacts the server.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Scheduler category, Retry period field of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
retryp 10

Command line:
-retryperiod=10

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

Revokeremoteaccess

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

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client user options file (dsm.opt) or the client system options file (dsm.sys). You can set this option on the Web Client category of the Preferences editor.

Syntax

                      .-None---.
>>-REVOKEremoteaccess-+--------+-------------------------------><
                      '-Access-'
 
 

Parameters

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

Examples

Options file:
revokeremoteaccess none

Command line:
Does not apply

Schedcmddisabled

Authorized User

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.

You can disable the scheduling of commands defined by your Tivoli Storage Manager administrator by setting the schedcmddisabled option to yes.

Use the query schedule command to query the schedules defined by your administrator. See Query Schedule for more information.

Supported Clients

This option is valid for all UNIX clients. The server can also define this option. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza.

Syntax

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

Parameters

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

Examples

Options file:
schedcmddisabled no

Command line:
Does not apply.

Schedlogname

Authorized User

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

When you run the schedule command, output from scheduled commands appears on your screen. Output is also sent to the file you specify with this option. If any part of the path you specify does not exist, Tivoli Storage Manager attempts to create it

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Scheduler category, Schedule Log button of the Preferences editor.

Syntax

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

Parameters

filespec
Specifies the path and file name where you want to store schedule log information when processing scheduled work. If any part of the path you specify does not exist, Tivoli Storage Manager attempts to create it.

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. The dsmsched.log file cannot be a symbolic link.

Examples

Options file:
schedlogname /home/mydir/schedlog.jan

Command line:
-schedlogname=/home/mydir/schedlog.jan

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

Schedlogretention

Authorized User

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

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Scheduler category, Schedule Log button of the Preferences editor.

Syntax

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

Parameters

N  or  days
Specifies how long to wait before pruning the schedule log.
N
Do not prune the log. This permits the log to grow indefinitely. This is the default.
days
Specifies the number of days to keep log file entries before pruning. The range of values is zero through 9999.
D  or  S
Specifies whether to save the pruned entries. Use a space or comma to separate this parameter from the previous one.
D
Discards the log entries when pruning the log. This is the default.
S
Saves the log entries when pruning the log.

Pruned entries are copied to the dsmsched.pru file that is stored in the same directory as the schedule log.

Examples

Options file:
schedlogretention 30 S

Command line:
-schedlogretention=30,S

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

Schedmode

Authorized User

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.

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

Your administrator can specify that the server support both modes or just one mode. If your administrator specifies that both modes are supported, you can select either schedule mode. If your administrator specifies only one mode, you must specify that mode in your dsm.sys file or scheduled work will not process.

If you specify the prompted mode, you must supply values for the tcpclientaddress and tcpclientport options in your dsm.sys file or on the schedule command. You can then be contacted at an address or port other than the one that made first contact with the server.

Notes:

  1. When changing the setting of this option in the client system options file (dsm.sys) you must stop and restart the scheduler service for the setting to take effect.

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

  3. The server can also define this option.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Scheduler category, Schedule Mode section of the Preferences editor.

Syntax

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

Parameters

POlling
The client scheduler queries the server for scheduled work at prescribed time intervals. This is the default. You can set the time intervals using the queryschedperiod option.
PRompted
The client scheduler waits for the server to contact your client node when scheduled work needs to be done.

Examples

Options file:
schedmode prompted

Command line:
-schedmod=po

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

Scrolllines

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

You can use the scrolllines option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The server can also define this option. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client user options file (dsm.opt). You can set this option on the Command Line category, Number of lines to display on screen field of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
scrolllines 25

Command line:
-scrolll=25

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

Scrollprompt

The scrollprompt option specifies whether you want Tivoli Storage Manager to stop and wait after displaying the number of lines of information you specified with the scrolllines option, or scroll through and stop at the end of the information list.

You can use the scrollprompt option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The server can also define this option. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client user options file (dsm.opt). You can set this option on the Command Line category, Pause after displaying the following number of lines field of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
scrollprompt yes

Command line:
-scrollp=yes

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

Servername

In your client system options file (dsm.sys), the servername option specifies the name you want to use to identify a server and to begin a stanza containing options for that server. You can name and specify options for more than one server.

The following example demonstrates how to specify options for two different servers:

+--------------------------------------------------------------------------------+
|   SErvername     server_a                                                      |
|     COMMMethod                TCPip                                            |
|     TCPPort                   1500                                             |
|     TCPServeraddress          almvmd.almaden.ibm.com                           |
|     PASSWORDAccess            prompt                                           |
|     GRoups                    tsm                                              |
|     USERs                     sullivan  mushock  tallan                        |
|     INCLExcl                  /adm/tsm/backup.excl                             |
|                                                                                |
|   SErvername     server_b                                                      |
|     COMMMethod                SHAREdmem                                        |
|     shmport                   1520                                             |
|     PASSWORDAccess            generate                                         |
|     MAILprog                  /usr/bin/xsend root                              |
|     GRoups                    system tsm                                       |
|     INCLExcl                  /adm/tsm/archive.excl                            |
+--------------------------------------------------------------------------------+

In your client user options file (dsm.opt), the servername option specifies which server, of those named in your client system options file (dsm.sys), to contact for backup-archive services. When specified in a client user options file (dsm.opt) or on the command line, the servername option overrides the default server specified in your client system options file.

Notes:

  1. You cannot use the servername option to override the server that is specified for migration in your client system options file.

  2. If the Tivoli Storage Manager server name changes or Tivoli Storage Manager clients are directed to a different Tivoli Storage Manager server, all clients will need to have a new password initialized for the new server name.

Supported Clients

This option is for all UNIX clients.

Options File

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

Syntax

>>-SErvername servername---------------------------------------><
 
 

Parameters

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

Examples

Options file:
servername server_a

Command line:
-se=server_b

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

Sessioninitiation

Authorized User

Use the sessioninitiation option to control whether the server or client initiates sessions through a firewall. The default is that the client initiates sessions. You can use this option with the schedule command.

For the client scheduler, it is unnecessary to open any ports on the firewall. If you set the sessioninitiation option to serveronly, the client will not attempt to contact the server. All sessions must be initiated by server prompted scheduling on the port defined on the client with the tcpclientport option. The sessioninitiation option only affects the behavior of the client scheduler running in the prompted mode. If you set the sessioninitiation option to serveronly, with the exception of CAD-managed schedulers, the command line client, native GUI, and Web client GUI will still attempt to initiate sessions.

Note: If you set the sessioninitiation option to serveronly, the client setup wizard and scheduler service may be unable to authenticate to the Tivoli Storage Manager server. In this case, you can execute the scheduler from the command line (dsmc schedule) and enter the password for your node when prompted.

A similar problem can occur if an encryption key is required for backup operations. In this case, you can execute the scheduler from the command line (dsmc schedule) and enter the encryption key when prompted. After the password and encryption key are updated, you must restart the scheduler.

If you set the sessioninitiation option to client, the client will initiate sessions with the server by communicating on the TCP/IP port defined with the server option tcpport. This is the default. Server prompted scheduling may be used to prompt the client to connect to the server.

Notes:

  1. See Configuring Tivoli Storage Manager client/server communication across a firewall for more information about Tivoli Storage Manager firewall support.

  2. The Tivoli Storage Manager server can specify SESSIONINITiation=clientorserver or SESSIONINITiation=serveronly on the QUERY NODE, REGISTER NODE, and UPDATE NODE commands. If the server specifies SESSIONINITiation=clientorserver, the client can decide which method to use. If the server specifies SESSIONINITiation=serveronly, all sessions are initiated by the server.

  3. The Tivoli Storage Manager client API does not support this option.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Scheduler category, Session Initiation field of the Preferences editor.

Syntax

                     .-Client-----.
>>-SESSIONINITiation-+------------+----------------------------><
                     '-SERVEROnly-'
 
 

Parameters

Client
Specifies that the client will initiate sessions with the server by communicating on the TCP/IP port defined with the server option tcpport. This is the default. Server prompted scheduling may be used to prompt the client to connect to the server.
SERVEROnly
Specifies that the server will not accept client requests for sessions. All sessions must be initiated by server prompted scheduling on the port defined on the client with the tcpclientport option (see Tcpclientport. Except for CAD-managed schedulers, the command line client, native GUI, and Web client GUI will still attempt to initiate sessions.

Examples

Options file:
sessioninitiation serveronly

Command line:
schedule -sessioninitiation=serveronly

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

Shmport

Authorized User

The shmport option specifies the TCP/IP port address on which the Tivoli Storage Manager server listens to establish a Shared Memory connection. To use Shared Memory, TCP/IP must be installed on your workstation.

Note:
The value specified for the shmport option in the client system options file must match the value specified for shmport in the server options file.

Supported Clients

This option is valid for AIX, HP-UX, and Solaris clients only.

Options File

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

Syntax

>>-SHMPort port_address----------------------------------------><
 
 

Parameters

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

Examples

Options file:
shmport 1520

Command line:
Does not apply.

Showmembers

Use the showmembers option with the following commands to display all members of a group:

The showmembers option is not valid with the inactive option. If you want to display members of a group that are not currently active, use the pitdate and pittime options.

Supported Clients

This option is valid for all UNIX clients.

Syntax

>>-SHOWMembers-------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
restore group /virtfs/* -pick -showmembers

Snapshotcachesize

Authorized User

Use the snapshotcachesize option during a snapshot image backup to specify an appropriate snapshot size so that all old data blocks can be stored. A snapshot size of 100 percent will ensure a valid snapshot.

For online image backups, use the snapshotcachesize option with the backup image command, the include.image option, or in your dsm.sys file.

Supported Clients

This option is valid for Linux86 and Linux IA64 clients only. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Image-Snapshot category of the Preferences editor.

Syntax

>>-SNAPSHOTCACHESize- snapshotcachesize------------------------><
 
 

Parameters

snapshotcachesize
Specifies an appropriate snapshot size so that all old data blocks can be stored during a snapshot image backup. The value is a percent of the total size of the volume being backed up. The range of values is one through 100 percent; the default is 100 percent.

Examples

Options file:
snapshotcachesize 40

Command line:
-snapshotcachesize=40

Snapshotroot

Use the snapshotroot option with the incremental, selective, or archive commands in conjunction with a third-party application that provides a snapshot of a logical volume, to associate the data on the local snapshot with the real file space data that is stored on the Tivoli Storage Manager server. The snapshotroot option does not provide any facilities to take a volume snapshot, only to manage data created by a volume snapshot.

For example, consider an application that takes a snapshot of the /usr file system and mounts it as /snapshot/day1. If you back up this data using the following command:

   dsmc incremental /snapshot/day1

a unique file space called /snapshot/day1 is created on the server. However, you may want to associate the snapshot data with the data already processed for the /usr file system. Using the snapshotroot option, you can associate the data with the file space corresponding to the /usr file system on the Tivoli Storage Manager server:

   dsmc incremental /usr -snapshotroot=/snapshot/day1

On a subsequent day, you can back up a snapshot that was written to an alternate location, but managed under the same file space on the server:

   dsmc incremental /usr -snapshotroot=/snapshot/day2

You can perform incremental backups, selective backups, or archives of a single directory, directory structure, or single file using the snapshotroot option. In all instances, the snapshotroot option must identify the root of the logical volume that was created by the snapshot. For example:

   dsmc incremental /usr/dir1/* -subdir=yes -snapshotroot=/snapshot/day1
   dsmc selective /usr/dir1/sub1/file.txt -snapshotroot=/snapshot/day1
   dsmc archive /usr/dir1/sub1/*.txt -snapshotroot=/snapshot/day1

If you want to include or exclude specific file specifications, the include and exclude statements should contain the name of the file system that was the source of the snapshot (the /usr file system), and not the name of the target of the snapshot (/snapshot/day1). This allows you to preserve a set of include and exclude statements regardless of the name of the logical volume to which the snapshot is written. Examples of include and exclude statements are:

  include /usr/dir1/*.txt 1yrmgmtclass
  exclude /usr/mydocs/*.txt

The following include-exclude statements are not valid because they contain the name of the snapshot:

  include /snapshot/day1/dir1/*.txt 1yrmgmtclass
  exclude /snapshot/day1/mydocs/*.txt

You must use the snapshotroot option in conjunction with a single file specification for a incremental, selective, or archive operation. You cannot specify multiple file specifications or no file specifications. For example, these commands are valid:

  dsmc incremental /usr -snapshotroot=/snapshot/day1
  dsmc incremental /usr/dir1/* -snapshotroot=/snapshot/day1

The following command is invalid because it contains two file specifications:

  dsmc incremental /usr/dir1/* /home/dir2/* -snapshotroot=/snapshot/day1

The following command is invalid because it contains no file specification:

  dsmc incremental -snapshotroot=/snapshot/day1

|Processing SAN File System FlashCopy images
| |

|SAN File System provides snapshot support called FlashCopy. |FlashCopy images can only be created using the SAN File System administrative |interface. FlashCopy images are created on a per fileset (container) |basis and are accessible in the .flashcopy directory of each |fileset's root directory. For example, there are two filesets, |root fileset (the default one) and another fileset called tivoli1. An |administrator creates one FlashCopy image for each fileset, called RootImage-1 |and tivoli1Image-1 respectively. A SAN File System is mounted in the |/tank directory on AIX. In this case, the FlashCopy images are |accessible in the following directories:

|  /tank/TIVOLI/.flashcopy/RootImage-1/
|  /tank/TIVOLI/tivoli1/.flashcopy/tivoli1Image-1/

|You can specify these directories with the snapshotroot option |when backing up each fileset as a separate file space as follows: |

  1. |Define a virtual mount point for the fileset, using the |virtualmountpoint option in your dsm.sys file:
    |virtualmountpoint /tank/TIVOLI
    |virtualmountpoint /tank/TIVOLI/tivoli1
  2. |Define virtual mount points for the FlashCopy image locations:
    |virtualmountpoint /tank/TIVOLI/.flashcopy/RootImage-1
    |virtualmountpoint /tank/TIVOLI/tivoli1/.flashcopy/tivoli1Image-1
  3. |Exclude the .flashcopy directory itself, so the data is not backed |up twice:
    |exclude.dir /.../.flashcopy
  4. |On the command line, enter the following backup command:
    |dsmc incremental /tank/TIVOLI -snapshotroot=/tank/TIVOLI/.flashcopy/RootImage-1
    |dsmc incremental /tank/TIVOLI/tivoli1 -snapshotroot=/tank/TIVOLI/tivoli1/
    |.flashcopy/tivoli1Image-1 
    |

Notes:

  1. Ensure that the snapshotroot references a snapshot of the correct volume. Ensure that snapshotroot refers to the root of the snapshot. If these rules are not followed, unintended results such as files expiring incorrectly may result.

  2. You cannot use the snapshotroot option in conjunction with the filelist option.

  3. You can use the snapshotroot option in conjunction with the preschedulecmd and postschedulecmd options, or in a automated script that you execute with the Tivoli Storage Manager client scheduler.

Supported Clients

This option is valid for all UNIX clients.

Syntax

>>-SNAPSHOTRoot =- snapshot_volume_name------------------------><
 
 

Parameters

snapshot_volume_name
Specifies the root of the logical volume created by the third-party snapshot application.

Examples

Command line:
dsmc incremental /usr -snapshotroot=/snapshot/day1

Subdir

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

For example, if you set the subdir option to yes when backing up a specific path and file, Tivoli Storage Manager recursively backs up all subdirectories under that path, and any instances of the specified file that exist under any of those subdirectories.

Supported Clients

This option is valid for all UNIX clients. The server can also define this option. The Tivoli Storage Manager client API does not support this option.

Options File

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

Syntax

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

Parameters

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

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

Examples

Options file:
subdir no

Command line:

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 

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

Tapeprompt

The tapeprompt option specifies whether you want Tivoli Storage Manager 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.

In the Tivoli Storage Manager GUI, the Media Mount dialog can display the Information Not Available value in the Device and Volume Label fields if you perform a standard (also known as classic) restore or retrieve operation. This value means that this information is only available for no query restore or retrieve operations; not a standard restore or retrieve operation. The Device field displays the name of the device on which to mount the media needed to process an object. The Volume Label field displays the name of the volume needed to process an object. See No query restore for a discussion of standard and no query restore operations.

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:

Note:
The server can also define this option.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client user options file (dsm.opt). You can set this option on the General category, Prompt before mounting tapes checkbox of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
tapeprompt yes

Command line:
-tapep=yes

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

Tcpadminport

Authorized User

Use the tcpadminport option to specify a separate TCP/IP port number on which the server is waiting for requests for administrative client sessions, allowing secure administrative sessions within a private network.

Supported Clients

This option is valid for all UNIX clients. The server can also define this option. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Communication category, Admin Port field of the Preferences editor.

Syntax

>>-TCPADMINPort-+- ------------------+-------------------------><
                '-admin_port_address-'
 
 

Parameters

admin_port_address
Specifies the port number of the server. The default value is the value of the tcpport option.

Examples

Options file:
tcpadminport 1502

Command line:
-tcpadminport=1502

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

Tcpbuffsize

Authorized User

The tcpbuffsize option specifies the size of the internal TCP/IP communication buffer used to transfer data between the client node and server. Although it uses more memory, a larger buffer can improve communication performance.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Communication category, Buffer Size field of the Preferences editor.

Syntax

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

Parameters

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

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

Examples

Options file:
tcpb 2

Command line:
-tcpbuffsize=31    

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

Tcpclientaddress

Authorized User

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 all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Scheduler category, Your TCP/IP address field of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
tcpclienta dsmclnt.sanjose.ibm.com

Command line:
-tcpclientaddress=128.33.10.249
or
-tcplcientaddress=khoyt.mycompany.mydomain.com      

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

Tcpclientport

Authorized User

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 all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Scheduler category, Your TCP/IP port field of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
tcpclientp 1502

Command line:
-tcpclientport=1492     

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

Tcpnodelay

Authorized User

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. Setting the tcpnodelay option to yes might improve performance in higher-speed networks.

Note:
This option is for AIX clients only. All other UNIX clients buffer small transactions before sending them to the server.

Supported Clients

This option is valid for AIX clients.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Communication category of the Preferences editor.

Syntax

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

Parameters

No
Do not send small transactions without buffering them first. This is the default.
Yes
Send small transactions without buffering them first. When you set the tcpnodelay option to yes, data packets less than the maximum transmission unit (MTU) size are sent immediately. Setting the tcpnodelay option to yes might improve performance in higher-speed networks.

Examples

Options file:
tcpnodelay yes

Command line:
Does not apply.

Tcpport

Authorized User

The tcpport option specifies a TCP/IP port address for a Tivoli Storage Manager server. You can obtain this address from your administrator.

See Configuring Tivoli Storage Manager client/server communication across a firewall for information about using the tcpport option to enable the backup-archive client, command line admin client, and the scheduler to run outside a firewall.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Communication category, Server Port field of the Preferences editor.

Syntax

>>-TCPPort- port_address---------------------------------------><
 
 

Parameters

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

Examples

Options file:
tcpp 1501

Command line:
-tcpport=1501

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

Tcpserveraddress

Authorized User

The tcpserveraddress option specifies the TCP/IP address for a Tivoli Storage Manager server. You can obtain this server address from your administrator.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Communication category, Server Address field of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
tcps dsmchost.endicott.ibm.com

Command line:
-tcpserveraddress=129.33.24.99

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

Tcpwindowsize

Authorized User

Use the tcpwindowsize option to specify, in kilobytes, the size you want to use for the TCP/IP sliding window for your client node. The sending host cannot send more data until it receives an acknowledgment and a TCP receive window update. Each TCP packet contains the advertised TCP receive window on the connection. A larger window allows the sender to continue sending data and may improve communication performance, especially on fast networks with high latency.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the Communication category, Window Size field of the Preferences editor.

Syntax

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

Parameters

window_size
Specifies the size, in kilobytes, to use for your client node TCP/IP sliding window. The range of values is 0 through 2048. A value of 0 allows Tivoli Storage Manager to use the operating system default TCP window size. Values from 1 to 2048 indicate that the window size is in the range of 1KB to 2MB. The default is 32.

Notes:

  1. The TCP window acts as a buffer on the network. It is not related to the tcpbuffsize option, or to the send and receive buffers allocated in client or server memory.

  2. A window size larger than the buffer space on the network adapter might degrade throughput due to resending packets that were lost on the adapter.

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

  4. For AIX the default is 63.

  5. For Solaris the maximum value is 1024.

Examples

Options file:
tcpwindowsize 1

Command line:
-tcpw=24

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

Timeformat

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

The AIX, Solaris, and HP-UX clients support locales other than English that describe every user interface that varies with location or language. See for supported locales. The default directories for system-supplied locales are as follows:

The backup-archive and administrative clients obtain format information from the locale definition in effect at the time the client is called. Consult the documentation on your local system for details about setting up your locale definition.

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

You can use the timeformat option with the following commands:

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client user options file (dsm.opt). . You can set this option on the Regional Settings category, Time Format field of the Preferences editor.

Syntax

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

Parameters

format_number
Displays time in one of the formats listed below. Select the format number that corresponds to the format you want to use. When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.

0
Use the locale-defined time format.

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

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

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

2
23,00,00
3
23.00.00
4
12:00:00 A/P

For AIX, HP-UX, and Solaris: To set a particular time format, edit the source file for your locale and modify the t_fmt line to support your needs. Whatever time format you select applies both to output and to input.

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

Examples

Options file:
timeformat 4

Command line:
-time=3

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

Toc

Use the toc option with the backup nas command or the include.fs.nas option to specify whether Tivoli Storage Manager saves Table of Contents (TOC) information for each file system backup. You should consider the following when deciding whether you want to save TOC information:

Supported Clients

This option is valid for AIX and Solaris clients only. The Tivoli Storage Manager client API does not support this option.

Options File

Place the include.fs.nas statement containing the toc value in the client system options file (dsm.sys).

Syntax

       .-Preferred-.
>>-TOC-+-----------+-------------------------------------------><
       +-Yes-------+
       '-No--------'
 
 

Parameters

Yes
Specifies that Tivoli Storage Manager saves TOC information during a NAS file system image backup. However, the backup will fail if an error occurs during creation of the TOC.
No
Specifies that Tivoli Storage Manager does not save TOC information during a NAS file system image backup.
Preferred
Specifies that Tivoli Storage Manager saves TOC information during a NAS file system image backup. The backup does not fail if an error occurs during creation of the TOC. This is the default.

Note: If the mode option is set to differential and you set the toc option to preferred or yes, but the last full image does not have a TOC, Tivoli Storage Manager performs a full image backup and creates a TOC.

Examples

Options file:
include.fs.nas netappsj/vol/vol0 homemgmtclass toc=yes

Command line:
backup nas -nasnodename=netappsj /vol/vol0 -toc=yes

Todate

Use the todate option with the totime option to specify an ending date and time to which you want to search for backups or archives during a restore, retrieve, or query operation. For example, you might request a list of files that were backed up before 11:59 PM on June 30, 2002.

Use the todate and totime options with the fromtime and fromdate options to request a list of backed up or archived files within a period of time. For example, you might request a list of files that were backed up between 6:00 AM on July 1, 2002 and 11:59 PM on July 30, 2002.

Use the todate option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-TODate =- date----------------------------------------------><
 
 

Parameters

date
Specifies an ending date. Enter the date in the format you selected with the dateformat option.

When you include dateformat with a command, it must precede the fromdate, pitdate, and todate options.

Examples

Command line:
dsmc restore "/home/user1/*" -todate=12/11/2003

Totime

Use the totime option with the todate option to specify an ending date and time to which you want to search for backups or archives during a restore, retrieve, or query operation. For example, you might request a list of files that were backed up before 11:59 PM on June 30, 2003. Tivoli Storage Manager ignores this option if you do not specify the todate option.

Use the totime and todate options with the fromtime and fromdate options to request a list of files that were backed up within a period of time. For example, you might request a list of files that were backed up between 6:00 AM on July 1, 2003 and 11:59 PM on July 30, 2003.

Use the totime option with the following commands:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-TOTime =- time----------------------------------------------><
 
 

Parameters

time
Specifies an ending time. If you do not specify a time, the time defaults to 00:00:00. Specify the time in the format you selected with the timeformat option.

When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.

Examples

Command line:
dsmc restore "/home/user1/*" -todate=09/17/2003 -totime=23:00:00

Txnbytelimit

Authorized User

The txnbytelimit option specifies the number of kilobytes the client program buffers before it sends a transaction to the server. A transaction is the unit of work exchanged between the client and server. Because the client program can transfer more than one file or directory between the client and server before it commits the data to server storage, a transaction can contain more than one file or directory. This is called a transaction group.

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

The server administrator can limit the number of files or directories contained within a transaction group using the txngroupmax option; the actual size of a transaction can be less than your limit. Once this number is reached, the client sends the files to the server even if the transaction byte limit is not reached.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys). You can set this option on the General category Transaction Buffer Size field of the Preferences editor.

Syntax

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

Parameters

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

Examples

Options file:
txnb 2048

Command line:
-txnb=2048

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

Type

Use the type option with the query node command to specify the type of node to query.

Supported Clients

This option is valid for AIX and Solaris clients only. The Tivoli Storage Manager client API does not support this option.

Syntax

          .-any----.
>>-TYpe =-+--------+-------------------------------------------><
          +-nas----+
          +-server-+
          '-client-'
 
 

Parameters

any
Specifies all nodes registered at the server. This is the default.
nas
Specifies all NAS nodes registered at the server.
server
Specifies client nodes that are other Tivoli Storage Manager servers.
client
Specifies client nodes that are backup-archive clients.

Examples

Command line:
query node -type=nas

Users

Authorized User

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 all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza.

Syntax

   .- -------------------.
   |       .- ---------. |
   V       V           | |
>>---USERs--- username-+-+-------------------------------------><
 
 

Parameters

username
Names a user that you want to authorize to request Tivoli Storage Manager services.

Examples

Options file:
users  carol  larry  davecd  kathyba  michelle
users  amyb  tkaspar  kbsmith  egray  srjames

Command line:
Does not apply.

V2archive

Use the v2archive option with the archive command to archive only files to the server. Tivoli Storage Manager will not process directories that exist in the path of the source file specification.

This option differs from the filesonly option in that the filesonly option archives the directories that exist in the path of the source file specification.

The v2archive and dirsonly options are mutually exclusive and an error message displays if you use both options in the same archive command.

This option is not persistent; you must explicitly specify this option in each archive command.

If you use this option, you may want to consider the following:

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-V2archive---------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

This command:
dsmc archive "/home/relx/dir1/*" -v2archive -su=y.

Archives these files:

/home/relx/dir1/file1
/home/relx/dir1/file2
/home/relx/dir1/file3
/home/relx/dir1/dir2/file4
/home/relx/dir1/dir2/file5
 

Note: Tivoli Storage Manager does not archive /home/relx/dir1 and /home/relx/dir1/dir2.

Verbose

The verbose option specifies that you want processing information to display on your screen. This is the default. When you run the incremental, selective, or archive commands, information displays about each file that is backed up. Use the quiet option if you do not want to display this information.

The following behavior applies when using the verbose and quiet options

Supported Clients

This option is valid for all UNIX clients. The server can also define this option. The Tivoli Storage Manager client API does not support this option.

Options File

Place this option in the client user options file (dsm.opt). You can set this option on the Command Line category, Do not display process information on screen checkbox of the Preferences editor.

Syntax

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

Parameters

There are no parameters for this option.

Examples

Options file:
verbose

Command line:
-verbose

This option is valid on the initial command line and in interactive mode. If you use this option in interactive mode, it affects only the command with which it is specified. When that command completes, the value reverts to the value at the beginning of the interactive session. This will be the value from the dsm.opt file unless overridden by the initial command line or by an option forced by the server.

Verifyimage

Use the verifyimage option with the restore image command to specify that you want to enable detection of bad sectors on the destination target volume. If bad sectors are detected on the target volume, Tivoli Storage Manager issues a warning message on the console and in the error log.

Supported Clients

This option is valid for AIX, HP-UX, Linux86, Linux IA64, Linux pSeries, Linux iSeries, and Solaris only. The Tivoli Storage Manager client API does not support this option.

Syntax

>>-VERIFYImage-------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc restore image /usr -verifyimage

Virtualfsname

Use the virtualfsname option with the backup group command to specify the name of the virtual file space for the group on which you want to perform the operation.

Supported Clients

This option is valid for all UNIX clients.

Syntax

>>-VIRTUALFSname =- fsname-------------------------------------><
 
 

Parameters

fsname
Specifies the name of the container for the group on which you want to perform the operation.

Examples

Command line:
backup group -filelist=/home/dir1/filelist1 -groupname=group1
-virtualfsname=/virtfs -mode=full

Virtualmountpoint

Authorized User

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.

Note:
If the directory that you want to specify as a virtual mount point is a symbolic link, set the followsymbolic option to Yes. If that option is set to no (the default), you are not permitted to use a symbolic link as a virtual mount point.

After you define a virtual mount point, you can specify the path and directory name with the domain option in either the default client options file or on the incremental command to include it for incremental backup services. You can also specify the path and directory name of the virtual mount point with the domain option in your client options files and on the incremental command. When you perform a backup or archive using the virtualmountpoint option, the query filespace command will list the virtual mount point in its response along with other file systems. Generally, directories that you define as virtual mount points are treated as actual file systems and requires that the virtualmountpoint option is specified in the dsm.sys file to restore or retrieve the data.

Supported Clients

This option is valid for all UNIX clients. The Tivoli Storage Manager client API does not support this option.

Options File

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

Syntax

   .- ---------------------------.
   V                             |
>>---VIRTUALMountpoint directory-+-----------------------------><
 
 

Parameters

directory
Specifies the path and directory name for the directory you want to use as the virtual mount point for a file system. You cannot use wildcard characters in either the path or directory names.

Define only one virtual mount point with each virtualmountpoint option that you include in your client system options file. Use the virtualmountpoint option as many times as necessary to define all of the virtual mount points that you want to use.

Examples

Options file:
virtualmountpoint /afs/xyzcorp.com/home/ellen
virtualmountpoint /afs/xyzcorp.com/home/ellen/test/data

Command line:
Does not apply.

Virtualnodename

The virtualnodename option specifies the node name of your workstation when you want to restore or retrieve files to a different workstation.

When you use the virtualnodename option in your client user options file, or with a command:

When connecting to a server, the client must identity itself to the server. This login identification is determined in the following ways:

When the virtual node name is accepted by the server, a password is required (assuming authentication is on), even if the passwordaccess option is generate. Once a connection to the server is established, then access is permitted to any file backed up using this login ID.

Supported Clients

This option is valid for all UNIX clients.

Options File

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

Syntax

>>-VIRTUALNodename- nodename-----------------------------------><
 
 

Parameters

nodename
Specifies a 1- to 64-character name that identifies the node for which you want to request Tivoli Storage Manager services. There is no default.

Examples

Options file:
virtualnodename cougar

Command line:
-virtualn=banshee

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

Wasexphome

To back up the WebSphere Application Server-Express, use the wasexphome option to specify the fully qualified installation path of the WebSphere Application Server-Express. Ensure that the washome option is not set.

Supported Clients

This option is valid for AIX, Solaris, and Linux86.

Options File

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

Syntax

>>-WASExpHome-- --pathvalue------------------------------------><
 
 

Parameters

pathvalue
Specifies the fully qualified path of the home directory of the WebSphere Application Server - Express. If the path contains spaces, enclose the path in double quotes.

Examples

Options file:
wasexphome /usr/mywas/Express

Washome

Use the washome option in your client user options file (dsm.opt) to specify an override base install path for the Application Server. You can use this option if your entire WebSphere installation is corrupted and must be reinstalled, or you are installing WAS on a new machine. See WAS instance restore procedures for more information.

If you do not specify a value for this option, Tivoli Storage Manager uses the default installation path. If there are multiple installations of the Application Server on the same machine, use a different options file for each installation with the proper path to the installation directory.

Supported Clients

This option is valid for AIX, Solaris, and Linux86 clients.

Options File

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

Syntax

>>-WASHOMe-- --pathvalue---------------------------------------><
 
 

Parameters

pathvalue
Specifies the fully qualified path of the home directory of the WebSphere Application Server installation. This value is the path of the directory where the configuration information and properties reside. If the path contains spaces, enclose the path in double quotes.

Examples

Options file:
washome /usr/mywas/appserver

Wasndhome

Use the wasndhome option in your client user options file (dsm.opt) to specify an override base install path for the Network Deployment Manager. You can use this option if your entire WebSphere installation is corrupted and must be reinstalled, or you are installing WAS on a new machine. See WAS instance restore procedures for more information.

If you do not specify a value for this option, Tivoli Storage Manager uses the default installation path. If there are multiple installations of the Network Deployment Manager on the same machine, use a different options file for each installation with the proper path to the installation directory.

Supported Clients

This option is valid for AIX, Solaris, and Linux86 clients.

Options File

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

Syntax

>>-WASNDHome-- --pathvalue-------------------------------------><
 
 

Parameters

pathvalue
Specifies the fully qualified path of the home directory of the Network Deployment Manager installation. This value is the path of the directory where the configuration information and properties reside. If the path contains spaces, enclose the path in double quotes.

Examples

Options file:
wasndhome /usr/mywas/DeploymentManager

|Wasnode

| | | | | | | | | |

|Use the wasnode option with the set waspassword |command to specify the WAS node name when performing the operation on the WAS |Network Deployment Manager or Application Server.

|Supported Clients

|This option is valid for AIX, Solaris, and Linux86 clients.

|Syntax

|>>-WASNode =-- nodename----------------------------------------><
| 
| 

|Parameters |

|nodename
|Specifies the WAS node name when performing the operation on the WAS |Network Deployment Manager or Application Server. |

|Examples |

|Command line:

|backup was -wasnode=ednode -wastype=app
|

Wastype

Use the wastype option with the backup was, query was, or restore was, or set waspassword commands to perform the operation on the WebSphere Application Server (WAS) Network Deployment Manager (contains setup, application files, and configuration information), the Application Server, or both.

Supported Clients

This option is valid for AIX, Solaris, and Linux86 clients.

Syntax

              .-ND----.
>>-WASType =--+-------+----------------------------------------><
              +-APP---+
              +-ANY---+
              '-LOCAL-'
 
 

Parameters

ND
Specifies that you want to perform the operation on the Network Deployment Manager (ND) associated with the node name that you specify. This is the default for the backup was and restore was commands.
APP
Specifies that you want to perform the operation on the Application Server (APP) associated with the node name that you specify.
ANY
Specifies that you want to query all backups of Network Deployment Manager and Application Server associated with the node name that you specify, including instances of ND and APP. This parameter is valid for the query was command only, and is the default.
LOCAL
Specifies that you want to query all the of the Application Servers, Network Deployment Manager, and their instances on your local machine. This parameter displays the instance name, hostname, soap port information, installed path, the type of the WAS (ND or APP), and whether security is enabled. This parameter is valid for the query was command only.

Examples

Command line:
dsmc query was -wastype=local

|Wasuser

| | |

|If WAS security is enabled, use the wasuser option with the |set waspassword command to set the WAS user name for each |installation of WAS on your machine.

|Supported Clients

|This option is valid for AIX, Solaris, and Linux86 clients.

|Syntax

|>>-WASuser =-- username----------------------------------------><
| 
| 

|Parameters |

|username
|Specifies the WAS user name when performing the operation on the WAS |Network Deployment Manager or Application Server. |

|Examples |

|Command line:

|dsmc set waspassword -wasnode=wasnode -wastype=app -wasuser=ed
|

Webports

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

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.

For further considerations regarding Tivoli Storage Manager firewall support, see Configuring Tivoli Storage Manager client/server communication across a firewall.

Note:
The Tivoli Storage Manager client API does not support this option.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system options file (dsm.sys) within a server stanza. You can set this option on the Web Client category, WEB Ports fields of the Preferences editor.

Syntax

>>-WEBPorts- cadportagentport--------------------------------><
 
 

Parameters

cadport
Specifies the required Tivoli Storage Manager Client Acceptor daemon port number. The range of values is 1000 through 32767. If a value is not specified, the default, zero (0), causes TCP/IP to randomly assign a free port number.
agentport
Specifies the required Tivoli Storage Manager Web client agent service port number. The range of values is 1000 through 32767. If a value is not specified, the default, zero (0), causes TCP/IP to randomly assign a free port number.

Examples

Options file:
webports 2123 2124

Command line:
Does not apply.


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