Tivoli Header

Administrator's Reference

DEFINE CLIENTOPT (Define an Option to an Option Set)

Use this command to add a client option to an option set.

For details about the options and the values you can specify, refer to Backup-Archive Installation and User's Guide.

Privilege Class

To issue this command, you must have system privilege or unrestricted policy privilege.

Syntax

>>-DEFine CLIENTOpt--option_set_name--option_name--option_value-->
 
   .-Force--=--No------.
>--+-------------------+--+----------------------+-------------><
   '-Force--=--+-No--+-'  '-SEQnumber--=--number-'
               '-Yes-'
 
 

Parameters

option_set_name (Required)
Specifies the name of the option set.

option_name (Required)
Specifies a client option to add to the option set.
Note:
To add an INCLUDE or EXCLUDE statement to a client option set, the correct syntax is:
define clientopt option_set_name inclexcl "include c:\proj\text\devel.*".

The following are the valid options:

ARCHSYMLINKASFILE 1

CHANGINGRETRIES

COMPRESSALWAYS

COMPRESSION

DIRMC

DOMAIN

DOMAIN.IMAGE 2

DOMAIN.NAS 6

INCLEXCL (use along with the following options)

EXCLUDE

EXCLUDE.COMPRESSION

EXCLUDE.ENCRYPTION 3

EXCLUDE.FS.NAS 6

EXCLUDE.SUBFILE 4

INCLUDE

INCLUDE.COMPRESSION

INCLUDE.ENCRYPTION 3

INCLUDE.FS.NAS 6

INCLUDE.SUBFILE 4

MAXCMDRETRIES

MEMORYEFFICIENTBACKUP

NFSTIMEOUT 1


POSTNSCHEDULECMD 5

POSTSCHEDULECMD

PRENSCHEDULECMD 5

PRESCHEDULECMD

QUERYSCHEDPERIOD

QUIET

RETRYPERIOD

RESOURCEUTILIZATION

RUNASSERVICE

SCHEDMODE

SCROLLLINES

SCROLLPROMPT

SUBDIR

SUBFILEBACKUP 4

SUBFILECACHEPATH 4

SUBFILECACHESIZE 4

TAPEPROMPT

TXNBYTELIMIT

VERBOSE


Note:
  1. UNIX only
  2. AIX, HP-UX, and Solaris only
  3. Windows, UNIX, and NetWare only
  4. Windows only
  5. Not valid on NetWare
  6. Only applies to backup of NAS file servers using NDMP support

option_value (Required)
Specifies the value for the option. If the option includes more than one value, enclose the value in quotation marks.
Note:
  • For the values you can specify with the option refer to Backup-Archive Installation and User's Guide.
  • The QUIET and VERBOSE options do not have an option value in the client option's file. To specify these values in a server client option set, specify a value of YES or NO.

Force
Specifies whether the client can override an option value. The value is ignored for additive options, such as INCLEXCL and DOMAIN. The default is NO. This parameter is optional. The values are:

Yes
Specifies that the client cannot override the value.

No
Specifies that the client can override the value.

SEQnumber
Specifies a sequence number when an option name is specified more than once. This parameter is optional.

Examples

Task

Add a client option (MAXCMDRETRIES 5) to a client option set named ENG.

Command:
define clientopt eng maxcmdretries 5

Task

Add a client option to the option set ENGBACKUP to exclude the c:\admin\file.txt from backup services.

Command:
define clientopt engbackup inclexcl "exclude c:\admin\file.txt"

Related Commands

Table 44. Commands Related to DEFINE CLIENTOPT

Command Description
COPY CLOPTSET Copies a client option set.
DEFINE CLOPTSET Defines a client option set.
DELETE CLIENTOPT Deletes a client option from a client option set.
DELETE CLOPTSET Deletes a client option set.
REGISTER NODE Defines a client to the server and sets options for that user.
QUERY CLOPTSET Displays information about a client option set.
UPDATE CLIENTOPT Updates the sequence number of a client option.
UPDATE CLOPTSET Updates the description of a client option set.
UPDATE NODE Changes the attributes associated with a client node.


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