Administrator's Reference

DEFINE CLIENTACTION (Define a One-Time Client Action)

Use this command to schedule one or more clients to process a command for a one-time action.

The server automatically defines a schedule and associates the client node to the schedule. The server assigns the schedule priority 1, sets the PERUNITS to onetime, and determines the number of days to keep the schedule active. The number of days is based on the value set with SET CLIENTACTDURATION command.

How quickly the client processes this command depends on whether the scheduling mode for the client is set to server-prompted or client-polling. The client scheduler must be started on the client workstation in order for the server to process the schedule.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, or restricted policy for the policy domain to which the schedule belongs.

Syntax

                        .-*------------------.
>>-DEFine CLIENTAction--+--------------------+------------------>
                        |.-,--------------.  |
                        |V           (1)  |  |
                        '--node_name------+--'
 
   .-DOmain--=--*---------------.
>--+----------------------------+------------------------------->
   |            .-,-----------. |
   |            V             | |
   '-DOmain--=----domain_name-+-'
 
>--ACTion--=--+-Incremental--+--+---------------------------+--->
              +-Selective----+  '-OPTions--=--option_string-'
              +-Archive------+
              +-REStore------+
              +-RETrieve-----+
              +-IMAGEBACkup--+
              +-IMAGEREStore-+
              +-Command------+
              '-Macro--------'
 
                                  .-Wait--=--No------.
>--+---------------------------+--+------------------+---------><
   '-OBJects--=--object_string-'  '-Wait--=--+-No--+-'
                                             '-Yes-'
 
 

Notes:

1. If you explicitly specify a NAS node name, the command will fail. If you provide a pattern-matching expression for the node, any NAS nodes that match the pattern will be ignored.

Parameters

node_name

Specifies the list of client nodes that will process the schedule associated with the action. You can use a wildcard character to specify a client node or a list of client nodes. Separate the client node names with commas and no intervening spaces. If you do not specify a value, all client nodes will be scheduled for the action.

DOmain

Specifies the list of policy domains used to limit the list of client nodes. Only client nodes that are assigned to one of the specified policy domains will be scheduled. All clients assigned to a matching domain will be scheduled. Separate multiple domain names with commas and no intervening spaces. If you do not specify a value, all policy domains will be included in the list.

ACTion

Specifies the action that occurs when this schedule is processed. Possible values are:

Incremental

Specifies that the schedule backs up all files that are new or that have changed since the last incremental backup. Incremental also backs up any file for which all existing backups may have expired.

Selective

Specifies that the schedule backs up only files that are specified with the OBJECTS parameter.

Archive

Specifies that the schedule archives files that are specified with the OBJECTS parameter.

REStore

Specifies that the schedule restores files that are specified with the OBJECTS parameter.

RETrieve

Specifies that the schedule retrieves files that are specified with the OBJECTS parameter.

IMAGEBACkup

Specifies that the schedule backs up logical volumes that are specified with the OBJECTS parameter.

IMAGEREStore

Specifies that the schedule restores logical volumes that are specified with the OBJECTS parameter.

Command

Specifies that the schedule processes a client operating system command or script that is specified with the OBJECTS parameter.

Macro

Specifies that a client processes a macro whose file name is specified with the OBJECTS parameter.

OPTions

Specifies the client options that you specify to the DSMC command at the time the schedule is processed. Only those options that are valid on the DSMC command line may be specified for this parameter. Refer to the appropriate client manual for information on which options are valid from the command line. This parameter is optional.

Do not include the following options because they have no effect when the client processes the scheduled command:

MAXCMDRETRIES

QUERYSCHEDPERIOD

RETRYPERIOD

SCHEDLOGNAME

SCHEDMODE

SERVERNAME

TCPCLIENTADDRESS

TCPCLIENTPORT

OBJects

Specifies the objects for which the specified action is performed. This parameter is required except when ACTION=INCREMENTAL. If the action is a backup, archive, retrieve, or restore operation, the objects are file spaces, directories, or logical volumes. If the action is to run a command or macro, the object is the name of the command or macro to run.

When you specify ACTION=INCREMENTAL without specifying a value for this parameter, the DSMC command is invoked without specified objects and attempts to process the objects as defined in the client's option file. To select all file spaces or directories for an action, explicitly list them in the object string. Entering only an asterisk in the object string causes the backup to occur only for the directory where the scheduler was started.

Enclose the object string in double quotes if it contains blank characters (spaces), and then surround the double quotes with single quotes. If the object string contains multiple file names, enclose each file name with its own pair of double quotes, then surround the entire string with one pair of single quotes. For example, to specify the following file strings:

• /usr/file 2, /usr/gif files, /usr/my test file, enter:

  OBJECTS='"/usr/file 2" "/usr/gif files" "/usr/my test file"'

• /usr/test file, enter:

  OBJECTS='"/usr/test file"'

Wait

Specifies whether to wait for a scheduled client operation to complete before processing the next step in a command script or macro. This parameter is optional. The default is No. Possible values are:

No

Specifies that you do not wait for the scheduled client operation to complete before processing the next step in the command script or macro.

Yes

Specifies that you wait for the scheduled client operation to complete before processing the next step in the command script or macro.

You cannot issue the DEFINE CLIENTACTION command with WAIT=YES from the server console. However, from the server console, you can:

• Specify WAIT=YES with DEFINE CLIENTACTION as the command line of a DEFINE SCRIPT command.
• Specify WAIT=YES with DEFINE CLIENTACTION as the command line of a file whose contents will be read into the script that is defined by a DEFINE SCRIPT command.

Note:

If you specify the DEFINE CLIENTACTION command with WAIT=YES in a macro, the immediate schedules defined by the command will not roll back if the macro does not complete successfully.

Examples

Task

Issue an incremental backup command for client node TOM assigned to policy domain EMPLOYEE_RECORDS. TSM defines a schedule and associates the schedule to client node TOM (assuming that the client scheduler is running).

Command:

define clientaction tom domain=employee_records 
action=incremental

Related Commands

Table 43. Commands Related to DEFINE CLIENTACTION