Chapter 8: Controller: /nodeworx/command/queue Up Part II: NodeWorx API Spec Chapter 10: Controller: /nodeworx/dns 

9 Controller: /nodeworx/cron

Required Permissions "CRON"
Action: add
Added in version 4.7.0-339
Description 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, 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
Added in version 4.7.0-339
Description Edit a cronjob on a user’s crontab.
Input Parameters
Name Type Notes Required?
enabled integer Example Values
1, 0
Example Default Value
1
No*
minute string Example Default Value
28,33,38,43,48,53,58,3,8,13,18,23
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: fail
Added in version n/a
Description Magic function - test for failure mechanism.
Action: getCurrentSystemTime
Added in version 6.1.19-1483
Description Get current system time in RFC822 format.
Action: options
Added in version 4.7.0-339
Description Manage options for cron users.
Input Parameters
Name Type Notes Required?
user string Example Values
axfrdns, example, iworx, 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/dash, /usr/sbin/jk_chrootsh
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
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
job integer Example Values
3, 4, 5, 6, 7, 8, 9, 10
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’systemtime’ => ’Wed, 11 Jul 18 15:39:22 -0400’,
’enabled’ => ’1’,
’minute’ => ’28,33,38,43,48,53,58,3,8,13,18,23’,
’hour’ => ’*’,
’day’ => ’*’,
’month’ => ’*’,
’dayofweek’ => ’*’,
’script’ => ’cd /home/interworx/cron ; ./iworx.pex --fively’,
’user’ => ’iworx’,
’job’ => ’3’,
),
)
Action: queryJobs
Added in version 4.8.0-393
Description List user jobs.
Input Parameters
Name Type Notes Required?
user string Example Values
axfrdns, example, iworx, nfsnobody, root
Yes
Action: reroute
Added in version n/a
Description Action to re-route from the current controller to a different one.
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 8: Controller: /nodeworx/command/queue Up Part II: NodeWorx API Spec Chapter 10: Controller: /nodeworx/dns 

(C) 2018 by InterWorx LLC