CAF Scheduled Jobs › CAF Standard Jobs and Parameters

CAF Standard Jobs and Parameters

CAF is installed with a collection of standard jobs (see CAF Policy Group in the Configuration Policy section of the DSM Explorer Help for details).

A job is described by a set of parameters stored in the configuration store (comstore) under the key:

itrm/common/caf/scheduler/name_of_job

The scheduler itself can be enabled or disabled by setting the “enabled” parameter in the above key.

The parameters of a job are as follows:

desc

Defines the job description; this appears in trace logs.

enabled

Indicates whether a job is enabled. Valid values are: 1=job is enabled, 0=job is not enabled and will not run.

type

Specifies the type of job. This determines the time frame in which the job repeats and can be one of these values:

day

Runs the job every few days at a given hour and minute.

hour

Runs the job every few hours at a given minute of the hour.

minute

Runs the job every few minutes.

You can also specify these additional keywords:

now

Executes the job now and at the scheduled intervals thereafter. The word “now” in this context means “when caf starts up”.

If the randomnowtime parameter is set, the job executes within a random number of seconds up to the value of randomnowtime. This is used to ensure that computers that start up together do not all fire their jobs at the same time.

random

Executes the job at the specified time plus a random number of minutes up to the value of the randomminutes parameter. This is used in jobs which involve contacting servers. This helps to spread the load on servers by partially randomizing the time at which agents make contact.

random_hour

Specifies running the job at a random hour within the day. Used with daily schedules.

random_minute

Specifies running the job at a random minute within the hour (which may also be random). Used with daily and hourly schedules.

excludeDays

Specifies the names of the days to be excluded from the schedule: monday, tuesday, and so on. Separate each day by spaces. For example, the setting “monday wednesday” prevents the job from running on Monday and Wednesday.

excludeHours

Specifies the numbers of the hours to be excluded from schedule using a 24-hour clock. Separate each hour by spaces. For example, the setting “1 15” prevents the job from running at 1:00 a.m. and 3:00 p.m.

hour

Specifies the hour at which the job starts using the 24-hour clock. This is used with daily schedules only.

minute

Specifies the minute in the hour at which the job starts. This is used with daily and hourly schedules.

repeat

Repeats every time unit defined by the “type” property. For example, if type is “hour” then “repeat” specifies the number of hours between jobs.

randomnowtime

Specifies a number of seconds. When CAF starts up, a job marked as “now” will run at a random time within this number of seconds.

randomminutes

Specifies a number of minutes. The job runs at the specified time plus a random time up to the value of this parameter.

cmd

Specifies the caf command for executing this job. This is the same as the command line with the exception that the host, user, and password options cannot be used.