summaryrefslogtreecommitdiff
path: root/docs/system
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2019-03-29 21:57:55 +0100
committerrebortg <github@ghlr.de>2019-03-29 21:57:55 +0100
commit5e000b3ab915e70db8fe62f442a7c99c73d8e558 (patch)
tree3588c9d863bb3f71987a229fa3cfcbcdc776b2ca /docs/system
parent31247afcba724a4ebd6ab545ccfff29c7706b8d8 (diff)
downloadvyos-documentation-5e000b3ab915e70db8fe62f442a7c99c73d8e558.tar.gz
vyos-documentation-5e000b3ab915e70db8fe62f442a7c99c73d8e558.zip
add Task scheduler
Diffstat (limited to 'docs/system')
-rw-r--r--docs/system/index.rst1
-rw-r--r--docs/system/task-scheduler.rst59
2 files changed, 60 insertions, 0 deletions
diff --git a/docs/system/index.rst b/docs/system/index.rst
index 368b62ff..d2a3d763 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -16,4 +16,5 @@ should be ready for further configuration which is described in this chapter.
host-information
systemusers
syslog
+ task-scheduler
config-management \ No newline at end of file
diff --git a/docs/system/task-scheduler.rst b/docs/system/task-scheduler.rst
new file mode 100644
index 00000000..032a2bea
--- /dev/null
+++ b/docs/system/task-scheduler.rst
@@ -0,0 +1,59 @@
+.. _task-scheduler:
+
+
+Task scheduler
+--------------
+
+Task scheduler — allows scheduled task execution. Note that scripts excecuted this way are executed as root user - this may be dangerous.
+
+.. code-block:: sh
+
+ system
+ task-scheduler
+ task <name>
+ cron-spec <UNIX cron time spec>
+ executable
+ arguments <arguments string>
+ path <path to executable>
+ interval
+ <int32>[mhd]
+
+Interval
+********
+
+You are able to set the time as an time interval.
+
+.. code-block:: sh
+
+ set system task-scheduler task <name> interval <value><suffix>
+
+Sets the task to execute every N minutes, hours, or days. Suffixes:
+
+ * m — minutes
+ * h — hours
+ * d — days
+
+If suffix is omitted, minutes are implied.
+
+Or set the execution time in common cron time.
+
+.. code-block:: sh
+
+ set system task-scheduler task TEST crontab-spec "* * * 1 *"
+
+Example
+*******
+
+.. code-block:: sh
+
+ system
+ task-scheduler
+ task mytask
+ interval 2h
+ executable
+ path /config/scripts/mytask
+ arguments "arg1 arg2 arg3"
+ task anothertask
+ cron-spec "* * * 1 *"
+ executable
+ path /config/scripts/anothertask \ No newline at end of file