Tivoli Storage Manager Installing the Clients
The following TSM services can be installed during installation or by using
the TSM Client Service Configuration Utility:
- Backup-Archive Scheduler Service
- Client Acceptor Service (CAD)
- Remote Client Agent Service
- TSM Journal Engine Service
For more information about using the TSM Client Service Configuration
Utility to install the Client Acceptor Service and Remote Client Agent
Service, see "Using the Dsmcutil Command".
To start the TSM Scheduler, use one of the following methods:
- From the TSM GUI click Utilities and then click Setup
Wizard. Select the Help me configure the TSM Client
Scheduler option.
Notes:
- For Windows 98, Me an icon is installed in the startup folder
that can be launched automatically when the system is booted.
- For Windows NT, 2000: Use the scheduler service which is
also easily installed via the Setup Wizard.
- You can also use the TSM Client Service Configuration Utility
on local and remote Windows NT machines from an account that belongs to the
Administrator/Domain Administrator group.
This section provides an example of using the TSM Client Service
Configuration Utility with the TSM backup-archive client for Windows NT or
Windows 2000 to automate backups. This example illustrates the use of
the TSM central scheduler.
When the TSM backup-archive client is registered with a TSM server, the
procedure involves the following steps:
- On the TSM server:
- Define a schedule for the policy domain to which the TSM backup-archive
client is registered.
- Associate the TSM backup-archive client node to the defined
schedule.
- On the TSM backup-archive client:
- Install the TSM scheduler client as a Windows NT or Windows 2000 service
for the TSM backup-archive client.
- Start the scheduler service installed for the TSM backup-archive
client.
The example below uses the following assumptions:
- The TSM backup-archive client is registered to a TSM server with a node
name of mars and a password of marspswd in policy domain
bacliwnt.
- The event to be scheduled is a daily incremental backup of file systems on
client machines. The backup begins between 9:00 and 9:15
pm.
This method is flexible because you can define a command file with any set
of commands you choose.
On the TSM server:
- Enter the following command on the server console or from an
administrative client to define the schedule. The administrative client
does not have to be running on the same system as the TSM server.
def sched bacliwnt wnt_daily_incr desc="Daily Incremental Backup"
priority=2 starttime=21:00 duration=15 durunits=minutes period=1
perunits=days dayofweek=any
TSM displays this message:
ANR2500I Schedule WNT_DAILY_INCR defined in policy domain BACLIWNT.
- To associate the TSM backup-archive client to this schedule, issue the
following command:
define association bacliwnt wnt_daily_incr mars
TSM displays this message:
ANR2510I Node MARS associated with schedule WNT_DAILY_INCR in
policy domain BACLIWNT.
At this point, a schedule that performs an incremental backup is defined on
the TSM server. The schedule starts around 9:00 pm. The
schedule is re-executed once a day and can start on any day of the
week.
- Note:
- If you want to confirm that the schedule and association are set correctly,
you can use the Query Schedule command. For additional
information, see TSM for Windows Using the Backup-Archive Clients,
SH26-4117.
On the TSM backup-archive client:
This example assumes that you installed the TSM backup-archive client in
the c:\program files\tivoli\tsm directory. It is also
assumes that the options files in each of these directories are updated so
that the communication parameters point to the TSM server.
- Login using a Windows NT or Windows 2000 account with administrative
privileges.
- Open an Windows NT or windows 2000 command prompt window and issue the
following command:
cd /d c:\"program files"\tivoli\tsm
If the path contains a space, for example c:\program
files\tivoli\tsm\baclient, enclose the name in double
quotes.
- In the window, issue the following command:
dsmcutil inst /name:"TSM Client Scheduler" /node:mars
/password:marspswd /autostart:yes /clientdir:"c:\program files\
tivoli\tsm" /optfile:"c:\program files\tivoli\tsm\
baclient\dsm.opt"
For additional information see Using the Dsmcutil Command.
- The options file that is defined for the TSM backup-archive client is used
by the scheduler when validating the node and password. The options
file is also used when contacting the TSM server for schedule
information. This example assumes that the dsm.opt file is
updated so that the communication parameters point to the TSM server.
If you see the following message:
A communications error occurred connecting to the TSM server
You should ensure that the options file contains entries that point to the
correct TSM server. You should also ensure that the TSM server is
running. If you have to correct one of these, issue the following
command:
dsmcutil remove /name:"TSM Client Scheduler"
Then reissue the dsmcutil inst command.
- At this point the Central Scheduler Service is installed and configured,
but is not started.
To start the service, issue the following command in the Windows NT or
Windows 2000 command prompt:
net start "TSM Client Scheduler"
The following output is displayed:
The TSM Client Scheduler service is starting.
The TSM Client Scheduler service was started successfully.
Note that because the /autostart:yes option is used, the
TSM scheduling service automatically starts each time the Windows NT or
Windows 2000 system is rebooted.
Your system is now ready to run automatic daily incremental backups.
Notes:
- If any changes that affect the scheduler service are made to the TSM
backup-archive client options file, the scheduler service has to be restarted
in order to pick up the changes. An example of this is the TSM server
address or the schedule mode. This can be done by issuing the following
commands:
net stop "TSM Client Scheduler"
net start "TSM Client Scheduler"
- The dsmsched.log file contains status information for the TSM
central scheduler service. In this example, the file is located in this
path:
c:\program files\tivoli\tsm\baclient\dsmsched.log
You can override this file name by specifying the schedlogname
option in the options file, dsm.opt.
- Output from scheduled commands is sent to the log file. After
scheduled work is performed, check the log to ensure the work completed
successfully.
When a scheduled command is processed the schedule log may contain the
following entry:
Scheduled event eventname completed successfully
This is merely an indication that TSM successfully issued the scheduled
command associated with the eventname. No attempt is made to
determine the success or failure of the command. You should assess the
success or failure of the command by evaluating the return code from the
scheduled command in the schedule log. The schedule log entry for the
command's return code is prefaced with the following text:
Finished command. Return code is:
The TSM Client Service Configuration Utility,
dsmcutil, allows TSM Client Services installation and configuration
on local and remote Windows NT or Windows 2000 machines. The TSM
Client Service Configuration Utility runs on Windows NT or Windows 2000
only and must be run from an account that belongs to the Administrator/Domain
Administrator group. The syntax of the utility is:
>>-dsmcutil-- --command--+---------+---------------------------><
'-options-'
- Note:
- Options that are specified with dsmcutil commands override those specified in
your options file (dsm.opt). See "Understanding Processing Options" for more information.
The account running the utility must have the appropriate user rights for
installing services and updating the registry on the target machine.
If a remote machine is specified, the account must be authorized to connect
to the specified machine's registry.
- Note:
- The minimum abbreviation for the commands and options documented are in upper
case.
INSTall
Installs and configures a TSM Scheduler Service. Required options
are:
- /name:servicename
- /password:password
- /clusternode:Yes|No (required if running the
Microsoft Cluster Server (MSCS)).
- /clustername:clustername (required if running
the Microsoft Cluster Server (MSCS)).
The /clientdir:clientdir option can also be
used, the default is the current directory. For more information about
these options, see "Dsmcutil Options".
The following files must exist in the directory specified for
/clientdir:clientdir:
- dsmcsvc.exe
- dscameng.txt
- dsm.opt
- dsmntapi.dll
- tsmutil1.dll
- Note:
- If the service is being installed on a remote machine, the fully qualified
client directory path should be relative to the target machine. UNC
names are not allowed. Multiple services may be installed on the same
machine.
- Task
- Install a scheduler service named TSM Central Scheduler Service
on the local machine. Start the service automatically at system boot
time. All required files must reside in the current directory and the
client options file must point to the TSM server where node ALPHA1 is defined
with password nodepw. The TSM server is contacted to verify that the
specified node and password are valid. When the password is validated
it is generated (encrypted) into the registry:
Command:
dsmcutil install/name:"TSM Central Scheduler Service"
/node:ALPHA1 /password:nodepw /autostart:yes
- Task
- Install a scheduler service named TSM Central Scheduler Service
on remote machine PDC. Start the service automatically at system boot
time. The required scheduler service files and the specified options
file must reside on the remote machine in the c:\tsm
directory. The password is encrypted into the registry. The TSM
server is not contacted to validate the password.
Command:
dsmcutil install/name:"TSM Central Scheduler Service"
/machine:PDC /clientdir:c:\tsm /optfile:c:\tsm\dsm.opt
/node:PDC /validate:no /autostart:yes
/password:nodepassword
- Task
- Install a scheduler service named TSM Central Scheduler Service
on remote machine PDC. Start the service automatically at system boot
time. The required scheduler service files and the specified options
file must reside on the remote machine in the c:\tsm
directory. The password is encrypted into the registry. The TSM
server residing at the specified TCP/IP host and port is contacted to validate
the password.
Command:
dsmcutil install/name:"TSM Central Scheduler Service"
/machine:PDC /clientdir:c:\tsm /optfile:c:\tsm\dsm.opt
/node:PDC /autostart:yes /password:nodepassword
/commmethod:tcpip /commserver:alpha1.sanjose.com
/commport:1521
- Task
- Install the TSM Central Scheduler Service for
group-a from machine node-1, ensure that
node-1 currently owns group-a and then issue the TSM
command.
Command:
dsmcutil install SCHEDuler/name:"TSM scheduler service:
group-a" /clientdir:c:\tsm\baclient /optfile:q:\tsm\
dsm.opt /node:mscs-cluster-group-a /password:n
/validate:no /autostart:yes /startnow:yes
/clusternode:yes /clustername:mscs-cluster
INSTall CAD
Installs and configures the Client Acceptor Service (CAD). Required
options are:
- /name:servicename
- /node:nodename
- /password:password
Other valid options are:
- /optfile:optionsfile
- /httpport:httpport
- /httpsport:httpsport
- /webports:webports
For more information about these options, see "Dsmcutil Options".
- Task
- Install a Client Acceptor Service called TSM CAD. TSM CAD uses a
node called test to connect to the TSM server. Use the
options file c:\tsm\dsm.opt to connect to TSM.
Command:
dsmcutil install cad /name:"TSM CAD" /node:test
/password:test /optfile:c:\tsm\dsm.opt
INSTall Journal
Installs a journaling engine service on a Windows NT or Windows
2000 client. A journal database is created that stores
information the client uses to determine which files are eligible for backup
before an operation starts.
After the journaling engine service is installed, by default, the
incremental command performs a journal-based incremental backup on
any journaled file systems. TSM does not use the journaling facility
inherent in Windows NTFS 5 file systems nor or any other journaled file
system.
If necessary, you can use the nojournal option with the
incremental command to specify that you want to perform a
traditional full incremental backup, instead of the default journal-based
backup. See TSM for Windows Using the Backup-Archive
Clients, SH26-4117 for more information about the incremental
command and the nojournal option.
The journaling engine service is named TSM Journal Service and
uses the configuration file tsmjbbd.ini from the TSM
installation directory. See Appendix D, "Journal Service Configuration" for more information.
- Note:
- The TSM Journal Service is not supported in a Microsoft Cluster Server
environment. Only one TSM Journal Service may be installed on a machine
and the TSM Journal Service cannot dynamically start or stop monitoring of
shared disks.
There are no valid options for this command.
- Task
- Install the journaling engine service TSM Journal
Service.
Command:
dsmcutil install journal
INSTall REMOTEAgent
Installs and configures a Remote Client Agent Service. Required
options are:
- /name:servicename
- /node:nodename
- /password:password
- /partnername:partner service name
Other valid options are:
- /optfile:optionsfile
For more information about these options, see "Dsmcutil Options".
- Task
- Install a Remote Client Agent Service called TSM AGENT. TSM AGENT
uses a node called test to connect to the TSM server. The
options file c:\tsm\dsm.opt is used to connect to
TSM. The partner CAD service is TSM CAD.
Command:
dsmcutil install remoteagent /name:"TSM AGENT" /node:test
/password:test /optfile:c:\tsm\dsm.opt /partnername:
"TSM CAD"
- Note:
- Both the Remote Client Agent Service and the Client Acceptor Service
must be installed to run the Web client. The Client Acceptor
Service must be installed before the Remote Client Agent
Service. Use the /partnername: option to specify the
name of the partner Client Acceptor Service.
REMove
Remove an installed Client Service. The required option is
/name:servicename. For more information about
this option, see "Dsmcutil Options".
- Task
- Remove the specified scheduler service from the local machine.
Command:
dsmcutil remove /name:"TSM Central Scheduler Service"
- Task
- Remove the journaling engine service TSM Journal Service from
the local machine.
Command:
dsmcutil remove /name:"TSM Journal Service"
UPDate
Updates Scheduler Service registry values. The required option for
this command is /name:servicename, and the registry
values to update. Other valid options are:
- /clientdir:clientdir
- /optfile:optionsfile
- /eventlogging:[Yes|No]
- /node:nodename
- /autostart:[Yes|No]
- /clusternode:Yes|No (required if running the
Microsoft Cluster Server (MSCS).
- /clustername:clustername (required if running
the Microsoft Cluster Server (MSCS).
For more information about these options, see "Dsmcutil Options".
- Task
- Update the client directory and options file for the specified scheduler
service. All required client service files must reside in the specified
directory.
Command:
dsmcutil update /name:"TSM Central Scheduler Service"
/clientdir:c:\tsmptf3 /optfile:c:\tsmptf3\dsm.opt
- Task
- Update the specified scheduler service to use the TCP/IP protocol to
connect to a TSM server at the specified host name on the specified
port.
Command:
dsmcutil update /name:"TSM Central Scheduler Service"
/commserver:nt1.sanjose.com /commport:1521 /commmethod:
tcpip
UPDate CAD
Updates Client Acceptor Service registry values. The required option
for this command is /name:servicename, and the
registry values to update. Other valid options are:
- /node:nodename
- /password:password
- /optfile:optionsfile
- /httpport:httpport
- /httpsport:httpsport
- /webports:webports
For more information about these options, see "Dsmcutil Options".
- Task
- Update the client password and options file for the specified Client
Acceptor Service. All required client service files must reside in the
specified directory.
Command:
dsmcutil update cad /name:"TSM CAD" /password:test
/optfile:c:\tsm\dsm.opt
UPDate REMOTEAgent
Updates Remote Client Agent Service registry values. The required
option for this command is /name:servicename, and
the registry values to update. Other valid options are:
- /node:nodename
- /password:password
- /optfile:optionsfile
- /partnername:partner service name
For more information about these options, see "Dsmcutil Options".
- Task
- Update a Remote Client Agent Service called TSM AGENT. TSM AGENT
uses a node called test to connect to the TSM server. The
options file c:\tsm\dsm.opt is used to connect to
TSM. The partner CAD service is TSM CAD.
Command:
dsmcutil update remoteagent /name:"TSM AGENT" /node:test
/password:test /optfile:c:\tsm\dsm.opt /partnername:
"TSM CAD"
Query
Query Scheduler Service registry values. Required options are:
/name:servicename. Other valid options
are:
- /machine:machinename
- /clientdir
- /optfile
- /eventlogging
- /node
- /autostart
- /commmethod
- /commport
- /commserver
- /errorlog
- /schedlog
- Note:
- Do not specify a value for these options. TSM returns option registry
values for the specified Scheduler Service.
For more information about these options, see "Dsmcutil Options".
- Task
- Query registry settings for the specified scheduler service.
Command:
dsmcutil query /name:"TSM Central Scheduler Service"
- Task
- Query the client directory registry setting for the specified scheduler
service.
Command:
dsmcutil query /name:"TSM Central Scheduler Service"
Query CAD
Queries Client Acceptor Service registry values. The required option
for this command is /name:servicename. Other
valid options are:
- /machine:machinename
- /node
- /optfile
- /httpport
- /httpsport
- /webports
- /clientdir
- /partnername
- Note:
- Do not specify a value for these options.
For more information about these options, see "Dsmcutil Options".
- Task
- Query registry settings for the specified Client Acceptor Service.
Command:
dsmcutil query cad /name:"TSM CAD"
Query Journal
Query the journaling engine service, TSM Journal Service, on a
Windows NT or Windows 2000 client. There are no valid options for this
command.
- Task
- Query the journaling engine service, TSM Journal
Service.
Command:
dsmcutil query journal
Query REMOTEAgent
Queries Remote Client Agent Service registry values. The required
option for this command is /name:servicename.
Other valid options are:
- /machine:machinename
- /node
- /optfile
- /partnername
- /clientdir
- Note:
- Do not specify a value for these options.
For more information about these options, see "Dsmcutil Options".
- Task
- Query registry settings for the specified Remote Client Agent
Service.
Command:
dsmcutil query remoteagent /name:"TSM AGENT"
List
Lists installed Client Services. There are no required
options.
- Task
- Locate and list the installed TSM client services on the local
machine.
Command:
dsmcutil list
- Task
- List the installed TSM client services on remote machine PDC.
Command:
dsmcutil list /MACHINE:PDC
- Note:
- The SHOWPW dsmcutil command is not supported beginning with TSM
Version 4.2, due to enhanced authentication.
Start
Use the Start command to start a client service. The
required option for this command is
/name:servicename.
- Task
- Start the journaling engine service, TSM Journal Service, on a
Windows NT or Windows 2000 client.
Command:
dsmcutil start /name:"TSM Journal Service"
Stop
Use the Stop command to stop a client service. The
required option for this command is
/name:servicename.
- Task
- Stop the journaling engine service, TSM Journal Service, on a
Windows NT or Windows 2000 client.
Command:
dsmcutil stop /name:"TSM Journal Service"
UPDATEPW
Generate encrypted TSM registry password. Required options are
/node:nodename and
/password:password. Optionally, you can use
the following options:
- /validate:[Yes|No]
- /clusternode:Yes|No (required if running the
Microsoft Cluster Server (MSCS)).
- /clustername:clustername (required if running
the Microsoft Cluster Server (MSCS)).
- /force:[Yes|No]
The password is validated with the TSM server if the
/validate:Yes option is specified. The
password is updated on the TSM server if the
/updateonserver:Yes option is specified. If
this option is specified, the current TSM password must be specified with the
/oldpassword option. For more information about these
options, see "Dsmcutil Options".
- Task
- Update the encrypted registry password for the specified node.
Validate and update the password on the specified TSM server which resides on
the specified TCP/IP hostname and port:
Command:
dsmcutil updatepw /node:alpha1 /commMethod:tcpip
/commServer:alpha1.sanjose.ibm.com /commPort:1500
/password:newpw /oldpassword:oldpw /updateonserver:yes
The following options are valid:
- /autostart:[Yes|No]
- Specifies whether the Scheduler Service starts automatically at system
boot time. The default is No.
- /clientdir:clientdir
- The fully qualified directory path where the Client Service files
reside. This directory should be relative to the target machine where
the service is installed. UNC names are not allowed. The default
is the current directory.
- /clustername:clustername
- This option replaces the /group option.
The/clustername option specifies the cluster name to which the
system belongs. The cluster name is determined by running the MSCS
command, CLUSTER /LIST, from the command line. You can also use the
Cluster Administrator utility to determine the cluster name. When the
utility starts, it will display a tree-like structure with the cluster name at
the top.
This option must be used with the
/clusternode:Yes option. This option must be
specified when using the INSTALL command in a cluster environment. It
must also be specified when using the UPDATE command to modify the cluster
settings (/clusternode and /clustername).
This option may also be specified when using the UPDATEPW command in a
cluster environment. Normally this is not required. However, if
more than one scheduler service with different cluster settings are defined
for a particular node, the utility cannot determine which settings are
correct. In this case, the recommended action is to correct the
discrepancies between the services.
Alternatively, you can specify this option with
/clusternode:Yes and
/force:Yes, to force the utility to show or update
the password with the specified cluster settings.
This option is not required if /clusternode:No is
specified.
- /clusternode:Yes|No
- Specifies whether to enable support for cluster resources. The
default value is No. You must be running the Microsoft
Cluster Server (MSCS) to specify
/clusternode:Yes. This option must be
specified when using the INSTALL command in a cluster environment. This
option must also be specified when using the UPDATE command to modify the
cluster settings (/clusternode, /clustername).
This option may also be specified when using the UPDATEPW command in a
cluster environment. Normally this is not required. However, if
more than one scheduler service with different cluster settings are defined
for a particular node, the utility cannot determine which settings are
correct. In this case, the recommended action is to correct the
discrepancies between the services.
Alternatively, you can specify this option with /clustername and
/force:Yes, to force the utility to show or update
the password with the specified cluster settings. If
/clusternode:No is specified,
/clustername is not required.
- /commmethod:protocol
- Specifies client communications protocol to communicate with a TSM
server. Valid protocols are: TCP/IP and Named Pipes. If a
value is not specified it is obtained from the client options file or set to
the default client value. This option can also be used with the
UPDATEPW command to specify a communication protocol to connect to a TSM
server when updating passwords.
- /commport:serverport
- Specifies the protocol specific TSM server port. For TCP/IP, this
is the port on the specified hostname. If this option is not specified,
the value is obtained from the client options file or set to the default
client value. This option is also used with the UPDATEPW command to
specify a protocol specific server port to connect to for updating
passwords.
- /commserver:servername
- Specifies the protocol specific TSM server name. Depending on the
protocol used, this can be a TCP/IP hostname or a Named Pipes name. If
not specified the value is obtained from the client options file or set to the
default client value.
This option can also be used with the UPDATEPW command to specify a
protocol specific server name to connect to for updating passwords.
- /copyfiles
- Specifies that the service installation is copied to another location
prior to installing the service. Use the /srcdir option to
specify the fully qualified source path.
- /errorlog:errorlog
- Specifies the fully qualified name of the client error log.
- /eventlogging:[Yes|No]
- Turns detailed event logging on or off for the specified scheduler
service. The default is Yes.
- /force:[Yes|No]
- This option may also be specified when using the UPDATEPW command in a
cluster environment. Normally this is not required. However, if
more than one scheduler service with different cluster settings are defined
for a particular node, the utility cannot determine which settings are
correct. In this case, the recommended action is to correct the
discrepancies between the services.
Alternatively, you can specify this option with /clusternode and
/clustername (if /clusternode:Yes is
specified), to force the utility to show or update the password with the
specified cluster settings.
- /httpport:httpport
- Specifies a TCP/IP port address for the Web client.
- /httpsport:httpsport
- Specifies a TCP/IP port address for the HTTPS secure socket layer (SSL)
interface to the Web client.
- /machine:machinename
- Specifies the name of a remote NT machine to connect to.
- /name:servicename
- Specifies the name of the Client service. The name must be quote
delimited if it contains embedded spaces.
- /node:nodename
- Specifies the TSM node name the Client Service uses when connecting to the
TSM server. Also used when displaying or updating the TSM registry
password. The default is the NT machine name.
- /ntaccount:ntaccount
- Specifies the NT account which the service logs in as.
- /ntdomain:ntdomain
- Specifies the NT domain which the service logs in as.
- /ntpassword:ntpassword
- Specifies the NT password for the account which the service logs in
as.
- /oldpassword:oldpw
- Current TSM server password. Used in conjunction with the
/updateonserver option when updating a password on the TSM
server.
- /optfile:optionsfile
- The fully qualified path of the TSM options file. This is the
options file the specified Client Service uses to connect to TSM. The
utility also uses the file to connect to TSM to validate and update
passwords. Note that although this option overrides the default option
file in the current directory (dsm.opt), the TSM API requires that a
default option file exists in the current directory. The default is
dsm.opt in the /clientdir directory.
- /partnername:partner service name
- This option is used when installing a Remote Client Agent Service to
specify the partner Client Acceptor Service.
- /password:password
- The TSM password which is generated (encrypted) into the registry.
- /schedlog:schedlog
- Specifies the fully qualified name of the client schedule log.
- /srcdir:pathname
- Use this option in conjunction with the /copyfiles option to
specify the fully qualified source path to copy the service installation to
another location prior to installing the service.
- /startnow:[Yes|No]
- Specifies whether dsmcutil starts the specified service after executing
the command. If you specify No, you must start the service
manually using the services control panel applet on NT, or the NET START
name of the TSM service.
- /updateonserver:[Yes|No]
- Specifies whether the specified password is updated on the TSM
server. Requires using the /oldpassword option.
- /validate:[Yes|No]
- Specifies whether to perform validation when displaying or updating the
encrypted registry password. The default is Yes.
- /webports: webports
- Specifies the TCP/IP port number used by the TSM Client Acceptor service
and the TSM Web client agent service for communications with the Web
GUI.
[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]