This is a
handler to create schedulers.
YAML
preferences:
feature_scheduler: y
objects:
-
type: scheduler
ref: my_scheduler
data:
name: New Scheduler
task: ConsoleCommandTask
params:
console_command: index:rebuild
run_time: "0 6 * * *"
status: active
Scheduler Object
| Name | Mandatory | Value
|
| name | yes | Scheduler name
|
| description | | A brief description of the scheduled task
|
| task | yes | Check task options section bellow
|
| params | | Check task params options bellow
|
| run_time | yes | A CRON time format. Eg. every 5 minutes: "*/5 * * * *"
|
| status | yes | active or inactive
|
| re_run | | A bool flag (true/false) if scheduler should re-run on the next minute if last run failed |
Task Options
| Task Name | Description
|
| ConsoleCommandTask | Execute a Tiki console command
|
| ShellCommandTask | Execute a shell command
|
| HTTPGetCommandTask | Perform a HTTP Get request and save the output
|
| TikiCheckerCommandTask | Check for Tiki updates |
ConsoleCommandTask Params
| Name | Mandatory | Value
|
| console_command | yes | The console command to execute. Eg. index:rebuild |
ShellCommandTask Params
| Name | Mandatory | Value
|
| shell_command | yes | The shell command to execute. Eg. index:rebuild
|
| timeout | | The max execution time in seconds to run the command |
HTTPGetCommandTask Params
| Name | Mandatory | Value
|
| url | yes | The URL to call
|
| output_file | yes | The file path where the output should be saved
|
| additional_http_headers | | Eg: "Accept-Language: en-us,en;\nAccept-Charset: ISO-8859-1,utf-8;"
|
| basic_auth_username | | If requested URL required basic authentication
|
| basic_auth_password | | If requested URL required basic authentication |
TikiCheckerCommandTask Params
No params