Viewing the scheduler page

Describes the scheduler page

The following figure illustrates the default scheduled tasks that are available after you install the appliance.

Scheduler page

The Scheduler page displays the list of available tasks.

To edit a task, click Edit. Click Save and then click Apply and enter the root password after performing the required changes.

To delete a task, select the required task and click Remove. Then, click Apply and enter the root password to remove the task.

On the ESA Web UI, navigate to Auditstore > Analytics screen to view the logs of a scheduled task.

For creating a scheduled task, the following parameters are required.

  • Basic properties
  • Customizing frequency
  • Execution
  • Restrictions
  • Logging

The following tasks must be enabled on any one ESA in the Audit Store cluster. Enabling the tasks on multiple nodes will result in a loss of data. If these scheduler task jobs are enabled on an ESA that was removed, then enable these tasks on another ESA in the Audit Store cluster.

  • Update Policy Status Dashboard
  • Update Protector Status Dashboard

Basic properties

In the Basic Properties section, you must specify the basic and mandatory attributes of the new task. The following table lists the basic attributes that you need to specify.

AttributeDescription
NameA unique numeric identifier must be assigned.
DescriptionThe task displayed name, which should also be unique.
FrequencyYou can specify the frequency of the task:
  • Every 10 minutes
  • Every 30 minutes
  • Every hour
  • Every 4 hours
  • Every 12 hours
  • Daily - every midnight
  • Weekly - every Sunday
  • Monthly - first day of the month
  • Custom - specify the custom frequency in the Frequency section
  • Customizing frequency

    In the Frequency section of the new scheduled task, you can customize the frequency of the task execution. The following table lists the frequency parameters which you can additionally define.

    AttributeDescriptionNotes
    MinutesDefines the minutes when the task will be executed:
  • Every minute
  • Every 10 minutes
  • Every 30 minutes
  • From 0 to 59
  • Every minute is the default. You can select several options, or clear the selection. For example, you can select to execute the task on the first, second, and 9th minute of the hour.
    DaysDefines the day of the month when the task will be executed
  • Every day
  • Every two days
  • Every seven days
  • Every 14 days
  • From 1 to 31
  • Every day is the default. You can select several options, or clear the selection.
    Days of the weekDefines the day of the week when the task will be executed:
  • From Sun to Mon
  • Every DOW - day of the week
  • Every 2nd Sun to every 2nd Mon.
  • Every 4 hours
  • Every 12 hours
  • Daily - every midnight
  • Weekly - every Sunday
  • Monthly - first day of the month
  • Custom - specify the custom frequency in the Frequency section
  • Every DOW (day of week) is the default. You can select several options, or clear the selection.
    HoursDefines the hour when the task will be executed
  • Every hour
  • From 0 to 23
  • Every two hours
  • Every four hours
  • Every eight hours
  • */6 (every six hours).
  • Every hour is the default. You can select several options, or clear the selection. If you select *, then the task will be executed each hour.
    If you select */6, then the task will be executed every six hours at 0, 6, 12, and 18.
    MonthDefines the month when the task will be executed
  • Every month
  • From Jan to Dec
  • Every two months
  • Every three months
  • Every four months
  • Every six months
  • Every month is the default. You can select several options, or clear the selection. If you select *, then the task will be executed each month.

    The Description field of Frequency section will be automatically populated with the frequency details that you specified in the fields mentioned in the following table. Task Next Run will hint when the task next run will occur.

    Execution

    In the Command Line section, you need to specify the command which will be executed, and the user who will execute this command. You can optionally specify the command parameters separately.

    Command Line
    In the Command Line edit field, specify a command that will be executed. Each command can include the following items:

    • The task script/executable command.
    • User name to execute the task is optional.
    • Parameters to the script as part of the command is optional, can be specified separately in the Parameters section.

    Parameters
    Using the Parameters section, you can specify the command parameters separately.

    You can add as many parameters as you need using the Add Param button, and remove the unnecessary ones by clicking the Remove button.

    For each new parameter you need to enter Name (any), Type (option), and Text (any).

    Each parameter can be of text (default) and system type. If you specify system, then the parameter will be actually a script that will be executed, and its output will be given as the parameter.

    Username
    In the Username edit field, specify the user who owns the task. If not specified, then tasks run as root.

    Only root, local_admin, and ptycluster users are applicable.

    Restrictions

    In a Trusted Appliance cluster, Restrictions allow you to choose the sites on which the scheduled tasks will be executed. The following table lists the restrictions that you can select.

    AttributeDescription
    On master siteThe scheduled tasks are executed on the Master site
    On non-master siteThe scheduled tasks are executed on the non-Master site

    If you select both the options, On master site and On non-master site, then the scheduled task is executed on both sites.

    Logging

    In the Logging section, you should specify the logging details explained in the table below:

    Logging DetailDescriptionNotes
    Show command line in logs?Select a check-box to show the command line in the logs.It is advisable not to select this option if the command includes sensitive data, such as passwords.
    SysLog
    Log Server
    Define the following details:
  • Success severity
  • Success title
  • Fail severity
  • Fail title
  • You should configure these fields to be able to easily analyze the incoming logs. Specifies whether to send an event to the Log Server (ESA) and the severity: No event, Lowest, Low, Medium, High, Critical for failed/success task execution.
    Log FileSpecify the files names where the success and failed operations are logged.Specifies whether to store the task execution details in local log files. You can specify to use the same file for successful and failed events. These files will be located in /var/log. You can also examine the success and failed logs in the Appliance Logs, in the appliance Web Interface.