Administrator's Reference
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 sets the
priority parameter to 1, sets the PERUNITS to onetime, and the DURATION and
DURUNITS parameters according to the value set in the SET CLIENTACTION
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 | |
'----node_name---+-'
>-----+-------------------------+---ACTion--=--+-Incremental--+->
'-DOmain--=--domain_name--' +-Selective----+
+-Archive------+
+-REStore------+
+-RETrieve-----+
+-IMAGEBACkup--+
+-IMAGEREStore-+
+-Command------+
'-Macro--------'
>-----+----------------------------+---------------------------->
'-OPTions--=--option_string--'
>-----+----------------------------+---------------------------><
'-OBJects--=--object_string--'
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. 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 command 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 (file spaces, directories, or logical volumes) for
which the specified action is performed. To select all file spaces or
directories, explicitly list them in the object-string. Entering an
asterisk will cause the backup to only occur for the directory where the
scheduler was started. This parameter is required except when
ACTION=INCREMENTAL.
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 your client's option file.
You can specify more than one object by separating the objects with blank
spaces and quotation marks. Enclose the file string in quotation marks if it contains blank
characters. If the file string contains multiple file names, each must
be surrounded by its own pair of double quotes, with one pair of single quotes
surrounding the file string. For example, to specify the following file
strings:
- C:\FILE 2, D:\A B C, E:\MY TEST FILE,
enter:
- OBJECTS='"C:\FILE 2" "D:\A B
C" "E:\MY TEST FILE"'
- D:\TEST FILE, enter:
- OBJECTS="D:\TEST FILE"
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 the client scheduler is running).
- Command:
- define clientaction tom domain=employee_records
action=incremental
Related Commands
Table 38. Commands Related to DEFINE CLIENTACTION
Command
| Description
|
DELETE SCHEDULE
| Deletes a schedule from the database.
|
QUERY ASSOCIATION
| Displays the clients associated with one or more schedules.
|
QUERY EVENT
| Displays information about scheduled and completed events for selected
clients.
|
QUERY SCHEDULE
| Displays information about schedules.
|
SET CLIENTACTDURATION
| Specifies the duration of a schedule defined using the DEFINE
CLIENTACTION command.
|
[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]