Function: scheduler
Result: the list of elements
Scheduler
Access level: root
- command — Command
- interval — Period
- schedule_type — Scheduler
- state — Status
- description — Description
Inventory module settings
Function: scheduler.prop
Access level: root
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- elid — unique identifier (key element of scheduler function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of scheduler function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- mailto — Email. Enter the email address that will be used for notifications about your cronjobs.
- path — Path. Enter one or more paths (space separated) that will be used to search for executables.
Run the selected cron job
Function: run
Run the selected cron job
Access level: root
Delete
Function: scheduler.delete
Delete
Access level: root
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of scheduler function.
Result: successful operation or error message
Crob job
Function: scheduler.edit
Access level: root
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- elid — unique identifier (key element of scheduler function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of scheduler function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- mailto — Email. You can enter an e-mail address using the global setting button of the cronjob module. Afterwards you can receive information by e-mail about a cronjob.
- command — Command:. Enter the path to the script that you want to be executed by the cronjob.
- description — Description:. This field can be used for additional information about this cron job
- active — . (Optional parameter. To enable the option click "on".) Check the box to activate this cron job.
- schedule_type — Scheduler. You can configure the settings of a cronjob in basic or in expert mode. The expert mode has more options but you need to have more knowledge about cronjobs to be able to use the expert mode.
- run_every — Run. Select the main time frame this cron job will be executed.
- time_hour — Time. Enter the hour this cron job will be executed (value 0 -23).
- time_min — . Enter the minute this cron job will be executed (value 0 — 59).
- wday1 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Monday
- wday2 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Tuesday
- wday3 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Wednesday
- wday4 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Thursday
- wday5 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Friday
- wday6 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Saturday
- wday0 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Sunday
- month — Month. Select a month to start cron job
- month_day — Day of month. Select day of month to run the cron job
- input_min — Minutes. Enter the minutes this cronjob needs to be executed. Format: * — for all minutes
- input_hour — Hours. Enter the hours this cronjob needs to be executed. Format: * — all hours
- input_dmonth — Days of month. Enter the days this cronjob needs to be executed. Format: * — all days of month
- input_month — Months. Enter the days this cronjob needs to be executed. Format: * — all months
- input_dweek — Days of week. Enter the days of a week this cronjob needs to be executed.Format: * — all days of week
- hideout — . (Optional parameter. To enable the option click "on".) Check the box if you do not want to receive the output of this cron job by email.
Suspend
Function: scheduler.suspend
Suspend
Access level: root
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of scheduler function.
Result: successful operation or error message
Resume
Function: scheduler.resume
Resume
Access level: root
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of scheduler function.
Result: successful operation or error message