Tivoli Storage Manager for Windows Administrator's Guide


Managing Client Options from the Server Using Client Option Sets

An administrator can create a set of client options to be used by a client node at TSM Version 3 or later. The client options specified in the set are used in conjunction with the client options file described in Connecting Nodes with the Server.

Client options sets allow the administrator to specify additional options that may not be included in the client's option file (dsm.opt). Specify the option set with the REGISTER NODE or UPDATE NODE commands. The client can use these defined options during a backup, archive, restore, or retrieve process. See Tivoli Storage Manager Installing the Clients for detailed information about individual client options.

To create a client option set and have the clients use the option set, do the following:

  1. Create the client option set with the DEFINE CLOPSET command.
  2. Add client options to the option set with the DEFINE CLIENTOPT command.
  3. Specify which clients should use the option set with the REGISTER NODE or UPDATE NODE command.

Creating a Client Option Set

When you create a client option set, you define a name for the option set, and can optionally provide a description of the option set. For example:

define cloptset engbackup description='Backup options for eng. dept.'
Note:The option set is empty when it is first defined.

Adding Client Options in an Option Set

You can add client options in a defined client option set.

The following example shows how to add a client option in the ENGBACKUP option set.

define clientopt engbackup schedlogretention 5

For a list of valid client options you can specify, refer to Administrator's Reference.

The server automatically assigns sequence numbers to the specified options, or you can choose to specify the sequence number for order of processing. This is helpful if you have defined more than one of the same option as in the following example.

define clientopt engbackup include d:\admin
define clientopt engbackup include d:\payroll

A sequence number of 0 is assigned to the option include d:\admin. A sequence number of 1 is assigned to the option include d:\payroll. If you want to specifically process one option before another, include the sequence parameter as follows:

define clientopt engbackup include d:\admin sequence=2
define clientopt engbackup include d:\payroll sequence=1

The FORCE parameter allows an administrator to specify whether a client node can override an option value. The default value is NO. If FORCE=YES, the client cannot override the value.

Registering Client Nodes and Assigning Them to an Option Set

You can register or update a client node and specify an option set for the client to use as follows:

register node mike pass2eng cloptset=engbackup

The client node MIKE is registered with the password pass2eng. When the client node MIKE performs a scheduling operation, his schedule log entries are kept for 5 days.

Updating the Sequence Number for a Client Option

You can update the sequence number for a client option to change its processing order. This is helpful if you have more than one of the same option, for example several INCLUDE options.

The following example shows how to change the sequence number for the DATEFORMAT option from 0 to 9:

update clientopt engbackup dateformat 0 9

Deleting an Option from a Client Option Set

You can remove an option that is defined in a client option set. The following example shows how to remove the SCHEDMODE polling option from the financeschd option set:

delete clientopt financeschd schedmode

Copying a Client Option Set

You can copy an existing client option to another option set. The following example shows how to copy the engbackup option set to financeschd option set:

copy cloptset engbackup financeschd

Requesting Information about a Client Option Set

To display information about the contents of a client option set, issue the following command:

query cloptset financeschd

Updating the Description for a Client Option Set

You can update the description for a client option set. The following example shows how to update the description for the engbackup option set:

update clopset engbackup description='Scheduling information'

Deleting a Client Option Set

When you delete a client option set, client node references to the option set are null. The clients continue to use their existing client options file. The following example shows how to delete the engbackup client option set:

delete cloptset engbackup


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