Configuring Job Scheduler in Gaia Clish

Description

Use these commands to configure Gaia to schedule jobs. The jobs run on the dates and times you specify.

You can define an email address, to which Gaia sends the output of the scheduled job.

Important:

  • On Scalable Platforms (ElasticXL, Maestro, and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group.

  • After you add, configure, or delete features, run the "save config" command to save the settings permanently. Scalable Platforms save the changes automatically.

Syntax

add cron job <Job Name> command "<Command>" recurrence
      daily time <HH:MM>
      hourly hours {all | <0-23> | <HH1>,<HH2>,...,<HHn>} at <1-59>
      interval <1-59>
      monthly month <1-12> days <1-31> time <HH:MM>
      weekly days <0-6> time <HH:MM>
      system-startup
 
set cron job <Job Name>
      command "<Command>"
      recurrence
            daily time <HH:MM>
            hourly hours {all | <0-23> | <HH1>,<HH2>,...,<HHn>} at <1-59>
            interval <1-59>
            monthly month <1-12> days <1-31> time <HH:MM>
            weekly days <0-6> time <HH:MM>
            system-startup

set cron mailto <Email Address> 

show cron
      job <Job Name>
            command
            recurrence
      jobs
      mailto
 
delete cron
      all
      job <Job Name>
      mailto

Note - Only the show commands provide an output.

Parameters

Parameter

Description

<Job Name>

The name of the job to schedule.

"<Command>"

The command to run.

Important:

  • The command must be a Linux command.

  • You must enclose the syntax in quotes:

    • If the command contains variables ($NameOfVariable), then use double quotes.

    • If the command does not contain variables, you can use single quotes.

  • If you wish to run a Check Point command or use a Check Point environment variable, then use this syntax (see Running Check Point Commands in Shell Scripts):

    • On a Security Management Server / Log Server / SmartEvent Server:

      source /etc/profile.d/CP.sh ; <Applicable Check Point Command>

    • On a Multi-Domain Server / Multi-Domain Log Server:

      source /etc/profile.d/CP.sh ; source $MDSDIR/scripts/MDSprofile.sh ; source $MDS_SYSTEM/shared/mds_environment_utils.sh ; source $MDS_SYSTEM/shared/sh_utilities.sh ; <Applicable Check Point Command>

    • On a Security Gateway / Cluster Members (non-VSX):

      source /etc/profile.d/CP.sh ; <Applicable Check Point Command>

    • On a VSX Gateway / VSX Cluster Members:

      source /etc/profile.d/CP.sh ; source /etc/profile.d/vsenv.sh ; <Applicable Check Point Command>

recurrence daily time <HH:MM>

Specifies that the job should run once a day - every day, at specified time.

Enter the time of day in the 24-hour clock format - <Hours>:<Minutes>.

Example: 14:35

recurrence hourly hours {all | <0-23> | <HH1>,<HH2>,...,<HHn>} at <1-59>

Specifies that the job should run every day at a specified hour and minute:

  • all at <1-59>

    Run each hour at the specified minute

    Example (run every day at <HH>:15): all at 15

  • <0-23> at <1-59>

    Run at a specific hour and at the specified minute

    Example (run every day at 14:15): 14 at 15

  • <HH1>,<HH2>,...,<HHn> at <1-59>

    Run at specific hours and at the specified minute

    Example (run every day at 10:15, 12:15, and 14:15): 10,12,14 at 15

recurrence interval <1-59>

Specifies that the job should run every number of minutes.

Example (run every 15 minutes): 15

recurrence monthly month <1-12> days <1-31> time <HH:MM>

Specifies that the job should run once a month - on specified months, on specified dates, and at specified time.

Months are specified by numbers from 1 to 12:

  • January = 1

  • February = 2

  • ...

  • December = 12

Dates of month are specified by numbers from 1 to 31.

To specify several consequent months, enter their numbers separate by commas.

Example: For January, February, and March, enter 1,2,3

To specify several consequent dates, enter their numbers separate by commas.

Example: For 1st, 2nd and 3rd day of the month, enter 1,2,3

recurrence weekly days <0-6> time <HH:MM>

Specifies that the job should run once a week - on specified days of week, and at specified time.

Days of week are specified by numbers from 0 to 6:

  • Sunday = 0

  • Monday = 1

  • Tuesday = 2

  • Wednesday = 3

  • Thursday = 4

  • Friday = 5

  • Saturday = 6

To specify several consequent days of a week, enter their numbers separate by commas.

Example: For Sunday, Monday, and Tuesday, enter 0,1,2

recurrence system-startup

Specifies that the job should at every system startup.

mailto <Email Address>

Specifies the email address, to which Gaia sends the jobs' results.

Enter one email address for each command. You must also configure a mail server (see Mail Notification).