Tivoli Header
Administrator's Reference
Use this command to update a client or administrative command
schedule.
The UPDATE SCHEDULE command takes two forms, depending on whether the
schedule applies to client operations or administrative commands. The
syntax and parameters for each form are defined separately.
Use the UPDATE SCHEDULE to update selected parameters for a client
schedule.
This command does not change the client associations that have been made to
this schedule. Any clients that are associated with the original
schedule process the modified schedule.
- Note:
- Not all clients can run all scheduled operations, even though Tivoli Storage
Manager allows you to define the schedule on the server and associate it with
the client. For example, a Macintosh client cannot run a schedule when
the action is to restore or retrieve files, or run an executable
script. An executable script is also known as a command file, a batch
file, or a script on different client operating systems.
Privilege Class
To update a client schedule, you must have system privilege, unrestricted
policy privilege, or restricted policy privilege for the policy domain to
which the schedule belongs.
Syntax
(1)
>>-UPDate SCHedule---------domain_name--schedule_name----------->
.-Type--=--Client-.
>--+-----------------+--+-----------------------------+--------->
'-DESCription--=--description-'
>--+-----------------------------+------------------------------>
'-ACTion--=--+-Incremental--+-'
+-Selective----+
+-Archive------+
+-REStore------+
+-RETrieve-----+
+-IMAGEBACkup--+
+-IMAGEREStore-+
+-Command------+
'-Macro--------'
>--+---------------------------+-------------------------------->
'-OPTions--=--option_string-'
>--+---------------------------+--+---------------------+------->
'-OBJects--=--object_string-' '-PRIority--=--number-'
>--+--------------------+--+--------------------+--------------->
'-STARTDate--=--date-' '-STARTTime--=--time-'
>--+---------------------+--+-----------------------------+----->
'-DURation--=--number-' '-DURUnits--=--+-Minutes----+-'
+-Hours------+
+-Days-------+
'-INDefinite-'
>--+-------------------+--+--------------------------+---------->
'-PERiod--=--number-' '-PERUnits--=--+-Hours---+-'
+-Days----+
+-Weeks---+
+-Months--+
+-Years---+
'-Onetime-'
>--+-----------------------------+------------------------------>
'-DAYofweek--=--+-ANY-------+-'
+-WEEKDay---+
+-WEEKEnd---+
+-SUnday----+
+-Monday----+
+-TUesday---+
+-Wednesday-+
+-THursday--+
+-Friday----+
'-SAturday--'
>--+------------------------+----------------------------------><
'-EXPiration=--+-Never-+-'
'-date--'
Notes:
- You must specify at least one optional parameter on this command.
Parameters
- domain_name (Required)
- Specifies the name of the policy domain to which this schedule
belongs.
- schedule_name (Required)
- Specifies the name of the schedule to be updated.
- Type=Client
- Specifies that a client schedule is updated. This parameter is
optional. The default is CLIENT.
- DESCription
- Specifies a description of the schedule. This parameter is
optional. You can specify up to 255 characters for the
description. Enclose the description in quotation marks if it contains
blank characters. To remove a previously defined description, specify a
null string ("") for this value.
- 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:
- /home/file 2, /home/gif files,
/home/my test file, enter:
- OBJECTS='"/home/file 2"
"/home/gif files" "/home/my test
file"'
- /home/test file, enter:
- OBJECTS='"/home/test file"'
- PRIority
- Specifies the priority value for a schedule. This parameter is
optional. You can specify an integer from 1 to 10, with 1 being the
highest priority and 10 being the lowest. The default is 5.
If two or more schedules have the same window start time, the value you
specify determines when TSM processes the schedule. The schedule with
the highest priority starts first. For example, a schedule with
PRIORITY=3 starts before a schedule with PRIORITY=5.
- STARTDate
- Specifies the date for the beginning of the window in which the schedule
is first processed. This parameter is optional. The default is
the current date. Use this parameter with the STARTTIME parameter to
specify when the initial startup window of the schedule starts.
You can specify the data using one of the values below:
Value
| Description
| Example
|
MM/DD/YYYY
| A specific date
| 09/15/1998
|
TODAY
| The current date
| TODAY
|
TODAY+days or +days
| The current date plus days specified. The maximum number of days
you can specify is 9999.
| TODAY +3 or +3.
|
- STARTTime
- Specifies the time for the beginning of the window in which the schedule
is first processed. This parameter is optional. The default is
the current time. This parameter is used in conjunction with the
STARTDATE parameter to specify when the initial startup window begins.
You can specify the data using one of the values below:
Value
| Description
| Example
|
HH:MM:SS
| A specific time
| 10:30:08
|
NOW
| The current time
| NOW
|
NOW+HH:MM or +HH:MM
| The current time plus hours and minutes specified
| NOW+02:00 or +02:00.
If you issue this command at 5:00 with STARTTIME=NOW+02:00 or
STARTTIME=+02:00, the beginning of the startup window is at
7:00.
|
NOW-HH:MM or -HH:MM
| The current time minus hours and minutes specified
| NOW-02:00 or -02:00.
If you issue this command at 5:00 with
STARTTIME=NOW-02:00 or STARTTIME=-02:00, the beginning of
the startup window is at 3:00.
|
- DURation
- Specifies the number of units that define the length of the startup window
of the scheduled operation. This parameter is optional. This
value must be from 1 to 999. The default is 1.
Use this parameter with the DURUNITS parameter to specify the length of the
startup window. For example, if you specify DURATION=20 and
DURUNITS=MINUTES, the schedule must be started within 20 minutes of the
start date and start time. The default length of the startup window is
1 hour. The duration of the window must be shorter than the period
between windows.
This value is ignored if you specify DURUNITS=INDEFINITE.
- DURUnits
- Specifies the time units used to determine the duration of the window in
which the schedule can start. This parameter is optional. The
default is HOURS.
Use this parameter with the DURATION parameter to specify how long the
startup window remains open to process the schedule. For example, if
DURATION=20 and DURUNITS=MINUTES, the schedule must be started within 20
minutes of the start date and start time. The schedule may not
necessarily complete processing within this window. If the schedule
needs to be retried for any reason, the retry attempts must begin before the
startup window elapses, or the operation does not restart.
The default value for the length of the startup window is 1 hour.
Possible values are:
- Minutes
- Specifies that the duration of the window is defined in minutes.
- Hours
- Specifies that the duration of the window is defined in hours.
- Days
- Specifies that the duration of the window is defined in days.
- INDefinite
- Specifies that the startup window of the scheduled operation has an
indefinite duration. The schedule can run any time after the scheduled
start time, until the schedule expires. You cannot specify
DURUNITS=INDEFINITE, unless you specify PERUNITS=ONETIME.
- PERiod
- Specifies the length of time between startup windows for this
schedule. This parameter is optional. You can specify an integer
from 1 to 999. The default is 1.
Use this parameter with the PERUNITS parameter to specify the period
between startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is scheduled
every five days after the initial start date and start time. The period
between startup windows must exceed the duration of each window. The
default is 1 day.
This value is ignored if you specify PERUNITS=ONETIME.
- PERUnits
- Specifies the time units used to determine the period between startup
windows for this schedule. This parameter is optional. The
default is DAYS.
Use this parameter with the PERIOD parameter to specify the period between
startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is scheduled
every 5 days after the initial start date and start time. The default
is 1 day. Possible values are:
- Hours
- Specifies that the time between startup windows is in hours.
- Days
- Specifies that the time between startup windows is in days.
- Weeks
- Specifies that the time between startup windows is in weeks.
- Months
- Specifies that the time between startup windows is in months.
- Note:
- When you specify PERUNITS=MONTHS, the scheduled operation will be processed
each month on the same date. For example, If the start date for the
scheduled operation is 02/04/1998, the schedule will process on the 4th of
every month thereafter. However, if the date is not valid for the next
month, then the scheduled operation will be processed on the last valid date
in the month. Thereafter, subsequent operations are based on this new
date. For example, if the start date is 03/31/1998, the next
month's operation will be scheduled for 04/30/1998. Thereafter, all
subsequent operations will be on the 30th of the month until February.
Because February has only 28 days, the operation will be scheduled for
02/28/1999. Subsequent operations will be processed on the 28th of the
month.
- Years
- Specifies that the time between startup windows for the schedule is in
years.
- Note:
- When you specify PERUNITS=YEARS, the scheduled operation will be processed on
the same month and date of each year. For example, if the start date
for the scheduled operation is 02/29/2004, the next year's scheduled
operation will be 02/28/2005 because February only has 28 days.
Thereafter, subsequent operations will be scheduled for February 28th.
- Onetime
- Specifies that the schedule processes once. This value overrides
the value you specified for the PERIOD parameter.
- DAYofweek
- Specifies the day of the week on which the startup window for the schedule
begins. This parameter is optional. If the start date and start
time fall on a day that does not correspond to a day you specify, the start
date and start time will be shifted forward in 24-hour increments until the
DAYOFWEEK parameter is satisfied.
If you select a value for DAYOFWEEK other than ANY, and depending on the
values for PERIOD and PERUNITS, schedules may not be processed when you would
expect. The default is ANY. Possible values are:
- ANY
- Specifies that the startup window can begin on any day of the week.
- WEEKDay
- Specifies that the startup window can begin on Monday, Tuesday, Wednesday,
Thursday, or Friday.
- WEEKEnd
- Specifies that the startup window can begin on Saturday or Sunday.
- SUnday
- Specifies that the startup window begins on Sunday.
- Monday
- Specifies that the startup window begins on Monday.
- TUesday
- Specifies that the startup window begins on Tuesday.
- Wednesday
- Specifies that the startup window begins on Wednesday.
- THursday
- Specifies that the startup window begins on Thursday.
- Friday
- Specifies that the startup window begins on Friday.
- SAturday
- Specifies that the startup window begins on Saturday.
- EXPiration
- Specifies the date after which this schedule is no longer used.
This parameter is optional. The default is NEVER. Possible
values are:
- Never
- Specifes that the schedule never expires.
- expirationdate
- Specifies the date on which this schedule expires, in MM/DD/YYYY
format. If you specify an expiration date, the schedule expires at
23:59:59 on the date you specify.
Examples
Task 1
Update the MONTHLY_BACKUP schedule that belongs to the STANDARD policy
domain by setting its priority value to 1.
- Command:
- update schedule standard monthly_backup priority=1
Task 2
Update the WEEKLY_BACKUP schedule that belongs to the EMPLOYEE_RECORDS
policy domain to expire on March 29, 1999 (03/29/1999).
- Command:
- update schedule employee_records weekly_backup
expiration=03/29/1999
Use this command to update selected parameters for an administrative
command schedule.
- Note:
- You cannot schedule MACRO or QUERY ACTLOG commands.
Privilege Class
To update an administrative schedule, you must have system
privilege.
Syntax
(1)
>>-UPDate SCHedule---------------------------------------------->
>--schedule_name--Type--=--Administrative----------------------->
>--+-----------------+--+--------------------+------------------>
'-CMD--=--command-' '-ACTIVE--=--+-Yes-+-'
'-No--'
>--+-----------------------------+--+---------------------+----->
'-DESCription--=--description-' '-PRIority--=--number-'
>--+--------------------+--+--------------------+--------------->
'-STARTDate--=--date-' '-STARTTime--=--time-'
>--+---------------------+--+-----------------------------+----->
'-DURation--=--number-' '-DURUnits--=--+-Minutes----+-'
+-Hours------+
+-Days-------+
'-INDefinite-'
>--+-------------------+--+--------------------------+---------->
'-PERiod--=--number-' '-PERUnits--=--+-Hours---+-'
+-Days----+
+-Weeks---+
+-Months--+
+-Years---+
'-Onetime-'
>--+-----------------------------+------------------------------>
'-DAYofweek--=--+-ANY-------+-'
+-WEEKDay---+
+-WEEKEnd---+
+-SUnday----+
+-Monday----+
+-TUesday---+
+-Wednesday-+
+-THursday--+
+-Friday----+
'-SAturday--'
>--+------------------------+----------------------------------><
'-EXPiration=--+-Never-+-'
'-date--'
Notes:
- You must specify at least one optional parameter on this command.
Parameters
- schedule_name (Required)
- Specifies the name of the schedule to be updated.
- Type=Administrative (Required)
- Specifies that an administrative command schedule is updated.
- CMD
- Specifies the administrative command to be scheduled for
processing. This parameter is optional. The command you specify
can contain up to 512 characters. Enclose the command in quotation
marks if it contains blanks.
- Note:
- You cannot specify redirection characters with this parameter.
- ACTIVE
- Specifies whether the administrative command is eligible for
processing. This parameter is optional. An administrative
command schedule will not be processed unless it is set to the active
state. Possible values are:
- YES
- Specifies that the administrative command is eligible for
processing.
- NO
- Specifies that the administrative command is not eligible for
processing.
- DESCription
- Specifies a description of the schedule. This parameter is
optional. You can specify up to 255 characters for the
description. Enclose the description in quotation marks if it contains
blanks. To remove a previously defined description, specify a null
string ("") for this value.
- PRIority
- Specifies the priority value for a schedule. This parameter is
optional. You can specify an integer from 1 to 10, with 1 being the
highest priority and 10 being the lowest. The default is 5.
If two or more schedules have the same window start time, the value you
specify determines when TSM processes the schedule. The schedule with
the highest priority starts first. For example, a schedule with
PRIORITY=3 starts before a schedule with PRIORITY=5.
- STARTDate
- Specifies the date for the beginning of the window in which the schedule
is first processed. This parameter is optional. The default is
the current date. Use this parameter with the STARTTIME parameter to
specify when the initial startup window of the schedule starts.
You can specify the data using one of the values below:
Value
| Description
| Example
|
MM/DD/YYYY
| A specific date
| 09/15/1998
|
TODAY
| The current date
| TODAY
|
TODAY+days or +days
| The current date plus days specified. The maximum number of days
you can specify is 9999.
| TODAY +3 or +3.
|
- STARTTime
- Specifies the time for the beginning of the window in which the schedule
is first processed. This parameter is optional. The default is
the current time. This parameter is used in conjunction with the
STARTDATE parameter to specify when the initial startup window begins.
You can specify the data using one of the values below:
Value
| Description
| Example
|
HH:MM:SS
| A specific time
| 10:30:08
|
NOW
| The current time
| NOW
|
NOW+HH:MM or +HH:MM
| The current time plus hours and minutes specified
| NOW+02:00 or +02:00.
If you issue this command at 5:00 with STARTTIME=NOW+02:00 or
STARTTIME=+02:00, the beginning of the startup window is at
7:00.
|
NOW-HH:MM or -HH:MM
| The current time minus hours and minutes specified
| NOW-02:00 or -02:00.
If you issue this command at 5:00 with
STARTTIME=NOW-02:00 or STARTTIME=-02:00, the beginning of
the startup window is at 3:00.
|
- DURation
- Specifies the number of units that define the length of the startup window
of the scheduled operation. This parameter is optional. This
value must be from 1 to 999. The default is 1.
Use this parameter with the DURUNITS parameter to specify the length of the
startup window. For example, if you specify DURATION=20 and
DURUNITS=MINUTES, the schedule must be started within 20 minutes of the
start date and start time. The default length of the startup window is
1 hour. The duration of the window must be shorter than the period
between windows.
This value is ignored if you specify DURUNITS=INDEFINITE.
- DURUnits
- Specifies the time units used to determine the duration of the window in
which the schedule can start. This parameter is optional. The
default is HOURS.
Use this parameter with the DURATION parameter to specify how long the
startup window remains open to process the schedule. For example, if
DURATION=20 and DURUNITS=MINUTES, the schedule must be started within 20
minutes of the start date and start time. The schedule may not
necessarily complete processing within this window. If the schedule
needs to be retried for any reason, the retry attempts must begin before the
startup window elapses, or the operation does not restart.
The default value for the length of the startup window is 1 hour.
Possible values are:
- Minutes
- Specifies that the duration of the window is defined in minutes.
- Hours
- Specifies that the duration of the window is defined in hours.
- Days
- Specifies that the duration of the window is defined in days.
- INDefinite
- Specifies that the startup window of the scheduled operation has an
indefinite duration. The schedule can run any time after the scheduled
start time, until the schedule expires. You cannot specify
DURUNITS=INDEFINITE, unless you specify PERUNITS=ONETIME.
- PERiod
- Specifies the length of time between startup windows for this
schedule. This parameter is optional. You can specify an integer
from 1 to 999. The default is 1.
Use this parameter with the PERUNITS parameter to specify the period
between startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is scheduled
every five days after the initial start date and start time. The period
between startup windows must exceed the duration of each window. The
default is 1 day.
This value is ignored if you specify PERUNITS=ONETIME.
- PERUnits
- Specifies the time units used to determine the period between startup
windows for this schedule. This parameter is optional. The
default is DAYS.
Use this parameter with the PERIOD parameter to specify the period between
startup windows. For example, if you specify PERIOD=5 and
PERUNITS=DAYS (assuming that DAYOFWEEK=ANY), the operation is scheduled
every 5 days after the initial start date and start time. The default
is 1 day. Possible values are:
- Hours
- Specifies that the time between startup windows is in hours.
- Days
- Specifies that the time between startup windows is in days.
- Weeks
- Specifies that the time between startup windows is in weeks.
- Months
- Specifies that the time between startup windows is in months.
- Note:
- When you specify PERUNITS=MONTHS, the scheduled operation will be processed
each month on the same date. For example, If the start date for the
scheduled operation is 02/04/1998, the schedule will process on the 4th of
every month thereafter. However, if the date is not valid for the next
month, then the scheduled operation will be processed on the last valid date
in the month. Thereafter, subsequent operations are based on this new
date. For example, if the start date is 03/31/1998, the next
month's operation will be scheduled for 04/30/1998. Thereafter, all
subsequent operations will be on the 30th of the month until February.
Because February has only 28 days, the operation will be scheduled for
02/28/1999. Subsequent operations will be processed on the 28th of the
month.
- Years
- Specifies that the time between startup windows for the schedule is in
years.
- Note:
- When you specify PERUNITS=YEARS, the scheduled operation will be processed on
the same month and date of each year. For example, if the start date
for the scheduled operation is 02/29/2004, the next year's scheduled
operation will be 02/28/2005 because February only has 28 days.
Thereafter, subsequent operations will be scheduled for February 28th.
- Onetime
- Specifies that the schedule processes once. This value overrides
the value you specified for the PERIOD parameter.
- DAYofweek
- Specifies the day of the week on which the startup window for the schedule
begins. This parameter is optional. If the start date and start
time fall on a day that does not correspond to a day you specify, the start
date and start time will be shifted forward in 24-hour increments until the
DAYOFWEEK parameter is satisfied.
If you select a value for DAYOFWEEK other than ANY, and depending on the
values for PERIOD and PERUNITS, schedules may not be processed when you would
expect. The default is ANY. Possible values are:
- ANY
- Specifies that the startup window can begin on any day of the week.
- WEEKDay
- Specifies that the startup window can begin on Monday, Tuesday, Wednesday,
Thursday, or Friday.
- WEEKEnd
- Specifies that the startup window can begin on Saturday or Sunday.
- SUnday
- Specifies that the startup window begins on Sunday.
- Monday
- Specifies that the startup window begins on Monday.
- TUesday
- Specifies that the startup window begins on Tuesday.
- Wednesday
- Specifies that the startup window begins on Wednesday.
- THursday
- Specifies that the startup window begins on Thursday.
- Friday
- Specifies that the startup window begins on Friday.
- SAturday
- Specifies that the startup window begins on Saturday.
- EXPiration
- Specifies the date after which this schedule is no longer used.
This parameter is optional. The default is NEVER. Possible
values are:
- Never
- Specifes that the schedule never expires.
- expirationdate
- Specifies the date on which this schedule expires, in MM/DD/YYYY
format. If you specify an expiration date, the schedule expires at
23:59:59 on the date you specify.
Examples
Task
Update existing administrative schedule named BACKUP_BACKUPPOOL so that
starting today, the BACKUPPOOL primary storage pool is backed up to the
COPYSTG copy storage pool every three days at 10:00 p.m.
- Command:
- update schedule backup_backuppool type=administrative cmd="backup
stgpool backuppool copystg" active=yes starttime=22:00 period=3
Table 329. Commands Related to UPDATE SCHEDULE
Command
| Description
|
COPY SCHEDULE
| Creates a copy of a schedule.
|
DEFINE SCHEDULE
| Defines a schedule for a client operation or an administrative
command.
|
DELETE SCHEDULE
| Deletes a schedule from the database.
|
QUERY EVENT
| Displays information about scheduled and completed events for selected
clients.
|
QUERY SCHEDULE
| Displays information about schedules.
|
SET MAXCMDRETRIES
| Specifies the maximum number of retries after a failed attempt to execute
a scheduled command.
|
SET MAXSCHEDSESSIONS
| Specifies the maximum number of client/server sessions available for
processing scheduled work.
|
SET RETRYPERIOD
| Specifies the time between retry attempts by the client scheduler.
|
[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]