Tivoli Header

Tivoli Storage Manager for Windows Backup-Archive Clients Installation and User's Guide

Dsmcutil Commands

INSTall

Installs and configures a Tivoli Storage Manager Scheduler Service. Required options are:

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:

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 Tivoli Storage Manager server where node ALPHA1 is defined with password nodepw. The Tivoli Storage Manager 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 Tivoli Storage Manager 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 Tivoli Storage Manager 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 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:

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 Tivoli Storage Manager server. Use the options file c:\tsm\dsm.opt to connect to Tivoli Storage Manager.

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, 2000, XP, or Windows.Net 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. Tivoli Storage Manager 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.

The journaling engine service is named TSM Journal Service and uses the configuration file tsmjbbd.ini from the Tivoli Storage Manager installation directory.

Note:
The Journal Service is not supported in a Microsoft Cluster Server environment. Only one Journal Service may be installed on a machine and the 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:

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 Tivoli Storage Manager server. The options file c:\tsm\dsm.opt is used to connect to Tivoli Storage Manager. 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:

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 Tivoli Storage Manager 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:

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:

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 Tivoli Storage Manager server. The options file c:\tsm\dsm.opt is used to connect to Tivoli Storage Manager. 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:

Note:
Do not specify a value for these options. Tivoli Storage Manager returns option registry values for the scheduler service you specify.
For more information about these options, see Dsmcutil Options.

Task
Query registry settings for the scheduler service you specify.

Command:

  dsmcutil query /name:"TSM Central Scheduler Service"

Task
Query the client directory registry setting for the scheduler service you specify.

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:

Note:
Do not specify a value for these options.
For more information about these options, see Dsmcutil Options.

Task
Query registry settings for the Client Acceptor Service you specify.

Command:

  dsmcutil query cad /name:"TSM CAD"

Query Journal

Query the journaling engine service, TSM Journal Service, on a Windows NT, 2000, XP, or Windows.Net 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:

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 Tivoli Storage Manager client services on the local machine.

Command:

  dsmcutil list

Task
List the installed Tivoli Storage Manager client services on remote machine PDC.

Command:

  dsmcutil list /MACHINE:PDC 

Note:
The SHOWPW dsmcutil command is not supported beginning with Tivoli Storage Manager Version 4.2, due to enhanced authentication.

Start

Use the Start command to start a client service. The Start command requires the /name:servicename option.

Task
Start the journaling engine service, TSM Journal Service, on a Windows NT, 2000, XP, or Windows.Net client.

Command:

  dsmcutil start /name:"TSM Journal Service"

Stop

Use the Stop command to stop a client service. The Stop command requires the /name:servicename option.

Task
Stop the journaling engine service, TSM Journal Service, on a Windows NT, 2000, XP, or Windows.Net client.

Command:

  dsmcutil stop /name:"TSM Journal Service"

UPDATEPW

Generate encrypted Tivoli Storage Manager registry password. The UPDATEPW command requires the /node:nodename and /password:password options. Optionally, you can use the following options:

The password is validated with the Tivoli Storage Manager server if the /validate:Yes option is specified. The password is updated on the server if you specify the /updateonserver:Yes option. If you specify this option, you must specify the current password 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 Tivoli Storage Manager 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


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