To view the list of tasks that are scheduled, from the Analytics screen, navigate to Scheduler > Tasks. The viewer role user or a user with the viewer role can only view logs and history related to the Scheduler. You need admin rights to create or modify schedules.
The following tasks are available by default:
Task | Description |
---|---|
Export Troubleshooting Indices | Scheduled task for exporting logs from the troubleshooting index. |
Export Policy Log Indices | Scheduled task for exporting logs from the policy index. |
Export Protectors Status Indices | Scheduled task for exporting logs from the protector status index. |
Delete Miscellaneous Indices | Scheduled task for deleting old versions of the miscellaneous index that are rolled over. |
Delete DSG Error Indices | Scheduled task for deleting old versions of the DSG error index that are rolled over. |
Delete DSG Usage Indices | Scheduled task for deleting old versions of the DSG usage matrix index that are rolled over. |
Delete DSG Transaction Indices | Scheduled task for deleting old versions of the DSG transaction matrix index that are rolled over. |
Signature Verification | Scheduled task for performing signature verification of log entries. |
Export Audit Indices | Scheduled task for exporting logs from the audit index. |
Rollover Index | Scheduled task for performing an index rollover. |
Ensure that the scheduled tasks are disabled on all the nodes before upgrading the ESA.
The scheduled task values on a new installation and an upgraded machine might differ. This is done to preserve any custom settings and modifications for the scheduled task. After upgrading the ESA, revisit the scheduled task parameters and modify them if required.
The list of scheduled tasks are displayed. You can create tasks, view, edit, enable or disable, and modify scheduled task properties from this screen. The following columns are available on this screen.
Column | Description |
---|---|
Name | A unique name for the scheduled task. |
Schedule | The frequency set for executing the task. |
Task Template | The task template for creating the schedule. |
Priority IPs | A list of IP addresses of the machines on which the task must be run. |
Params | The parameters for the task that must be executed. |
Enabled | Use this toggle switch to enable or disable the task from running as per the schedule. |
Action | The actions that can be performed on the scheduled task. |
The available action options are:
Use the repository scheduler to create scheduled tasks. You can set a scheduled task to run after a fixed interval, every day at a particular time, a fixed day every week, or a fixed day of the month.
Complete the following steps to create a scheduled task.
From the Analytics screen, navigate to Scheduler > Tasks.
Click Add New Task.
The New Task screen appears.
Complete the fields for creating a scheduled task.
The following fields are available:
Select Template: Select a template from the list. The following templates are available:
If a template is selcted and the date and time settings are modified, then the Custom template is used.
The scheduler runs only one instance of a particular task. If the task is already running, then the scheduler skips running the task again. For example, if a task is set to run every 1 minute, and the earlier instance is not complete, then the scheduler skips running the task. The scheduled task will be run again at the scheduled time after the current task is complete.
- Date and time: Specify the date and the time when the command must be executed. The following fields are available:
- **Min**: Specify the time settings in minutes for executing the command.
- **Hrs**: Specify the time settings in hours for executing the command.
- **DOM**: Specify the day of the month for executing the command.
- **Mon**: Specify the month for executing the command.
- **DOW**: Specify the day of the week for executing the command.
Some of the fields also accept the special syntax. For the special syntax, refer [here](#special-syntax).
- **Task Template**: Select a task template to view and specify the parameters for the scheduled task. The following task templates are available:
- **ILM Multi Delete**
- **ILM Multi Export**
- **Audit index Rollover**
- **Signature Verification**
- **Priority IPs**: Specify a list of the ESA IP addresses in the order of priority for execution. The task is executed on the first IP address that is specified in this list. If the IP is not available to execute the task, then the job is executed on the next prioritized IP address in the list.
- **Use Only Priority IPs**: Enable this toggle switch to only execute the task on any one node from the list of the ESA IP addresses specified in the priority field. If this toggle switch is disabled, then the task execution is first attempted on the list of IPs specified in the **Priority IPs** field. If a machine is not available, then the task is run on any machine that is available on the Audit Store cluster which might not be mentioned in the **Priority IPs** field.
- **Multi node Execution**: If disabled, then the task is run on a single machine. Enable this toggle switch to run the task on all available machines.
- **Enabled**: Use this toggle switch to enable or disable the task from running as per the schedule.
The scheduled task is created and enabled. The job executes on the date and time set.
This task is used for automatically deleting indexes when the criteria specified is fulfilled. It displays the required fields for specifying the criteria parameters for deleting indexes. You can use a regex expression for the index pattern.
Specify one or multiple options for the parameters.
The fields for ILM entries is shown in the following figure.
This task is used for automatically exporting logs when the criteria specified is fulfilled. It displays the required fields for specifying the criteria parameters for exporting indexes. This task is disabled by default after it is created. Enable the Use Only Priority IPs and specify specific ESA machines in the Priority IPs field this task is created to improve performance. Any indexes imported into ILM are not exported using this scheduled task.
This task is available for processing the audit, troubleshooting, policy log, and protector status indexes.
You can specify one or multiple options for the Max Days, Max Docs, and Max MB(size) parameters.
The fields for the entries is shown in the following figure.
This task performs an index rollover on the index referred by the alias when any of the specified conditions are fulfilled. The conditions are index age, number of documents in the index, or the index size crosses the specified value.
This task is available for processing the audit, troubleshooting, policy log, protector status, and DSG-related indexes.
The fields for the Audit Index Rollover entries is shown in the following figure.
This task runs the signature verification tasks after the time interval that is set. It runs the default signature-related job and the ad-hoc jobs created on the Signature Verification tab.
The fields for the Manage Signature Verification Jobs entries is shown in the following figure.
After creating a scheduled task, specify whether the task must be enabled or disabled for running. You can edit the task to modify the commands or the task schedule.
Complete the following steps to modify a task.
From the Analytics screen, navigate to Scheduler > Tasks.
The list of scheduled tasks appears.
Use the search field to search for a specific task from the list.
Click the Enabled toggle switch to enable or disable the task for running as per the schedule.
Alternatively, clear the Enabled toggle switch to prevent the task from running as per the schedule.
Click the Edit icon () to update the task.
The Edit Task page is displayed.
Update the task as required and click Save.
The task is saved and run as per the defined schedule.
The Monitor screen shows a list of all the scheduled tasks. It also displays whether the task is running or was executed successfully. You can also stop a running task or restart a stopped task from this screen.
Complete the following steps to monitor the tasks.
From the Analytics screen, navigate to Scheduler > Monitor.
The list of scheduled tasks appears.
The Tail option can be set from the upper-right corner of the screen. Setting the Tail option to ON updates the scheduler history list with the latest scheduled tasks that are run.
You can use the search field to search for specific tasks from the list.
Scroll to view the list of scheduled tasks executed. The following information appears:
: Running. The task is running. You can click Stop from Actions to stop the task.
: Queued to stop. The task processing will stop soon.
: Stopped. The task has been stopped. The job might take about 20 seconds to stop the process.
If an ILM Multi Export job is stopped, then the next ILM Multi Export job cannot be started within 2 minutes of stopping a previous running job.
If a signature verification scheduler job is stopped from the Scheduler > Monitor page, then the status might be updated on this page after about 5 minutes.
: Completed. The task is complete.
Use the scheduler and the Analytics ILM for managing indexes. The Index State Management can be used to manage indexes not supported by the scheduler or ILM. However, it is not recommended to use the Index State Management for managing indexes. The Index State Management provides configurations and settings for rotating the index.
Perform the following steps to configure the index:
The special syntax for specifying the schedule is provided in the following table.
Character | Definition | Fields | Example |
---|---|---|---|
, | Specifies a list of values. | All | 1, 2, 5, 6. |
- | Specifies a range of values. | All | 3-5 specifies 3, 4, 5. |
/ | Specifies the values to skip. | All | */4 specifies 0, 4, 8, and so on. |
* | Specifies all values. | All | * specifies all the values in the field where it is used. |
? | Specifies no specific value. | DOM, DOW | 4 in the day-of-month field and ? in the day-of-week field specifies to run on the 4th day of the month. |
# | Specifies the nth day of the month. | DOW | 2#4 specifies 2 for Monday and 4 for 4th week in the month. |
L | Specifies the last day in the week or month. | DOM, DOW | 7L specifies the last Saturday in the month. |
W | Specifies the weekday closest to the specified day. | DOM | 12W specifies to run on the 12th of the month. If 12 is a Saturday, then run on Friday the 11th. If 12th is a Sunday, then run on Monday the 13th. |