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
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 main window, select the Utilities menu>
Setup Wizard item, and select the Help me configure the TSM
Client Scheduler option.
Notes:
- For Windows 95 and 98 an icon is installed in the startup
folder that can be launched or automatically when the system is booted.
- For Windows NT: Use the scheduler service which is also
easily installed via the Setup Wizard.
- You can also use the Scheduler 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 on how to use 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.
Once 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 both the
database and transaction logs. The backups 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 duru=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 is defined on the TSM server that performs an
incremental backup. 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-4101.
|
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
assumed 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 d:\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:d:\"program files"\
tivoli\tsm /optfile:d:\"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 console window:
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 bached.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\basched.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 Scheduler Service Configuration Utility,
dsmcutil, allows TSM Scheduler Services installation and
configuration on local and remote Windows NT or Windows 2000 machines.
The Scheduler 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 machines 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
- /clientdir:clientdir
- /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".
The following files must exist in the directory specified for
/clientdir:clientdir:
- dsmcsvc.exe
- dscameng.txt
- dsm.opt
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.
|
Examples:
- 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. Once the password is validated
it is generated (encrypted) into the registry:
dsmcutil install/name:"TSM Central Scheduler Service"
/node:ALPHA1 /password:nodepw /autostart:yes
- 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:
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
- 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:
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
- Install the TSM Central Scheduler Service for GROUP-1A from
machine NODE-1, make sure that NODE-1 currently owns GROUP-A and then issue
the TSM 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
INSTall CAD
Installs and configures the Client Acceptor Service (CAD). Required
options are:
- /name:servicename
- /node:nodename
- /password:password
- /partnername:partner service name
For more information about these options, see "Dsmcutil Options".
Example:
- Install a Client Acceptor Service called TSM CAD. TSM CAD will use
a node called test to connect to the TSM server. The options
file c:\tsm\dsm.opt will be used to connect to
TSM. The partner Remote Client Agent Service is called TSM AGENT
dsmcutil install cad /name:"TSM CAD" /node:test /password:test
/optfile:c:\tsm\dsm.opt /partnername:"TSM AGENT"
Note: | The Client Acceptor Service and Remote Client Agent Service must be
installed together. Use the /partnername: option
to specify the name of the partner Remote Client Agent Service.
|
INSTall REMOTEAgent
Installs and configures a Remote Client Agent Service. Required
options are:
- /name:servicename
- /node:nodename
- /password:password
- /partnername:partner service name
For more information about these options, see "Dsmcutil Options".
Example:
- 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.
dsmcutil install remoteagent /name"TSM AGENT" /node:test
/password:test /optfile:c:\tsm\dsm.opt /autostart:no
/partnername:"TSM CAD"
Note: | The Remote Client Agent Service and the Client Acceptor Service must be
installed together. Use the /partnername: option
to specify the name of the partner Client Acceptor Service.
|
REMove
Remove an installed Scheduler Service. The required option is
/name:servicename. For more information about
this option, see "Dsmcutil Options".
Example:
- Remove the specified scheduler service from the local machine:
dsmcutil remove /name:"TSM Central Scheduler 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".
Examples:
- Update the client directory and options file for the specified scheduler
service. All required client service files must reside in the specified
directory:
dsmcutil update /name:"TSM Central Scheduler Service"
/clientdir:c:\tsmptf3 /optfile:c:\tsmptf3\dsm.opt
- 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:
dsmcutil update /name:"TSM Central Scheduler Service"
/commserver:nt1.sanjose.com /commport:1521 /commmethod:
tcpip
Query
Query Scheduler Service registry values. Required options are:
/name:servicename, and the registry values to
display. Other valid options are:
- /clientdir:clientdir
- /optfile:optionsfile
- /eventlogging:[Yes|No]
- /node:nodename
- /autostart:[Yes|No
For more information about these options, see "Dsmcutil Options".
Examples:
List
Lists installed Scheduler Services. There are no required
options.
Examples:
SHOWPW
Displays TSM registry password in clear text. Required options
are:
- /node:nodename
- /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. For more
information about these options, see "Dsmcutil Options".
Examples:
- Decrypt the specified registry password on the local machine and display
it in clear text. The utility will attempt to authenticate the
decrypted node password specified in the default client options file:
dsmcutil showpw /node:alpha1
- Decrypt the specified registry password on the local machine and display
it in clear text. The utility will not validate the decrypted
password:
dsmcutil showpw /node:alpha1 /validate:no
- Decrypt the specified registry password on the local machine and display
it in clear text. The utility will attempt to validate the decrypted
password by connecting to a TSM server via TCP/IP running on the specified
hostname on the specified port:
dsmcutil showpw /node:alpha1 /commMethod:tcpip /commServer:
alpha1.sanjose.ibm.com /commPort:1500
UPDATEPW
Generate encrypted TSM registry password. 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)).
- /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".
Example:
- Update the encrypted registry password for the specified node. The
password will be validated and updated on the specified TSM server which
resides on the specified TCP/IP hostname and port:
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 Scheduler 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
- Specifies the cluster name to which the system belongs. The cluster
name can be determined by running the MSCS command CLUSTER /LIST from the
command line. You can also find the cluster name by starting the
Cluster Administrator utility. 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,
/clustername).
This option may also be specified when using the SHOWPW or UPDATEPW
commands 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 SHOWPW or UPDATEPW
commands 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, IPXSPX, NETBIOS, 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 SHOWPW and UPDATEPW commands to specify a communication
protocol to connect to a TSM server when validating and/or updating
passwords.
- /commport:serverport
- Specifies the protocol specific TSM server port. For TCP/IP, this
is the port on the specified hostname. On IPX/SPX it is the ipx socket
on the specified server address. 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 SHOWPW and UPDATEPW commands
to specify a protocol specific server port to connect to for validating and/or
updating passwords.
- /commserver:servername
- Specifies the protocol specific TSM server name. Depending on the
protocol used, this can be a TCP/IP hostname, a NETBIOS server name, an
IPX/SPX server address, 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 SHOWPW and UPDATEPW commands to
specify a protocol specific server name to connect to for validating and/or
updating passwords.
- /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 SHOWPW or UPDATEPW
commands 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.
- /machine:machinename
- The name of a remote NT machine to connect to.
- /name:servicename
- The name of the scheduler service. The name should be quote
delimited if it contains embedded spaces.
- /node:nodename
- The TSM node name the Scheduler 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.
- /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 Scheduler 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.
- /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.
[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]