Index

(jobs)

o2job_schedule

integer o2job_schedule(string $job_name, string $type, integer $interval, string $date, string $time, string $recurrence, string $week_day, integer $month_day, string $aspid, boolean $all_hosts)

Schedule job with passed name.

A scheduled job is a task.
A task can be of one of 3 types (char(1) passed as $type):
"O": Once Task is run once in day $date at time $time
"I": Interval Task is run once every $interval minutes
"R": Recurrence Task is run with a defined recurrence (see below)

In case of recurrence, $recurrence parameter can take value:
"D": Day Task in run once every day at $time
"W": Week Task in run once every week at $week_day (see below)
"M": Month Task in run once every month, day $month_day (see below)

Parameters $date and $time are passed in Janox format ("yyyymmdd", "hhmmss").

Parameter $week_day (char(3)) can take value:
"Mon|Tue|Wed|Thu|Fri|Sat|Sun": Day of week

Parameter $month_day (integer) can take value:
1-31: Day of month

If task is correctly created new tasl-ID is returned, else FALSE.


Parameters:
  1. $job_name
    2. Name to look for
  2. $type
    3. Task type: [O]nce, [I]nterval, [R]ecurrence
  3. $interval
    4. For type [I]nterval: number of minutes
  4. $date
    5. For type [O]nce & [R]ecurrence: Janox format date
  5. $time
    6. For type [O]nce & [R]ecurrence: Janox format time
  6. $recurrence
    7. Recurrence type: [D]ay, [W]eek, [M]onth
  7. $week_day
    8. Day of week [Mon|Tue|Wed|Thu|Fri|Sat|Sun]
  8. $month_day
    9. Day of month [0-31]
  9. $aspid
    10. ASPI-ID to run job for
  10. $all_hosts
    11. Run job on all active hosts
Related functions:

o2job_create

o2job_get_by_name

o2job_run

o2job_is_running