Controller: Cron

API Controller /nodeworx/cron
Required Permissions ["CRON"]
Action Description
add Add a job to a user's crontab.
edit Edit a cronjob on a user's crontab.
options Manage options for cron users.

Action: add

Add a job to a user's crontab.

Input Parameters

Name Type Notes Required?
interface string
Example Values
simple, advanced
Example Default Value
simple
 Yes
user string
Example Values
axfrdns, example, iworx, mydomain, nfsnobody, root
 Yes
minute struct (string)
Example Values
*, */2, */5, */10, */15, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, ...
Example Default Value
["*"]
 No*
hour struct (string)
Example Values
*, */2, */4, */6, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
Example Default Value
["*"]
 No*
day struct (string)
Example Values
*, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
Example Default Value
["*"]
 No*
month struct (string)
Example Values
*, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
Example Default Value
["*"]
 No*
dayofweek struct (string)
Example Values
*, 0, 1, 2, 3, 4, 5, 6
Example Default Value
["*"]
 No*
script string Yes
* indicates that it's actually required, but probably already has a valid default value

Action: edit

Edit a cronjob on a user's crontab.

Input Parameters

Name Type Notes Required?
minute string
Example Default Value
37,42,47,52,57,2,7,12,17,22,27,32
 No*
hour string
Example Default Value
*
 No*
day string
Example Default Value
*
 No*
month string
Example Default Value
*
 No*
dayofweek string
Example Default Value
*
 No*
script string
Example Default Value
cd /home/interworx/cron ; ./iworx.pex --fively
 No*
* indicates that it's actually required, but probably already has a valid default value

Action: options

Manage options for cron users.

Input Parameters

Name Type Notes Required?
user string
Example Values
axfrdns, example, iworx, mydomain, nfsnobody, root
 Yes
shell string
Help Entry
Use the dropdown to choose the shell to run the cron job on.
Example Values
/bin/sh, /bin/bash, /sbin/nologin, /bin/tcsh, /bin/csh, /bin/ksh
 No*
path struct (string)
Help Entry
The path contains the directories which will be in the search path for cron.
 No
mailto string
Help Entry
Enter an email address to be notified of the output of each cron job.
 No
* indicates that it's actually required, but probably already has a valid default value