summaryrefslogtreecommitdiff
path: root/docs/system/task-scheduler.rst
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2020-12-08 14:57:44 +0100
committerrebortg <github@ghlr.de>2020-12-08 14:57:44 +0100
commitf6c43343bbea7c98b6e735f5204da1759343ca23 (patch)
tree8ddd1150ffaf65cd36678ebc95c7d9fb22ae1dce /docs/system/task-scheduler.rst
parente6d0a80db37769a3d40084a8d55abfd7b24b941a (diff)
parent0bb741b58bc0dd7f0beae7364ed519f7165bdbb7 (diff)
downloadvyos-documentation-f6c43343bbea7c98b6e735f5204da1759343ca23.tar.gz
vyos-documentation-f6c43343bbea7c98b6e735f5204da1759343ca23.zip
Merge branch 'sagitta' of https://github.com/rebortg/vyos-documentation
Diffstat (limited to 'docs/system/task-scheduler.rst')
-rw-r--r--docs/system/task-scheduler.rst40
1 files changed, 0 insertions, 40 deletions
diff --git a/docs/system/task-scheduler.rst b/docs/system/task-scheduler.rst
deleted file mode 100644
index 382da39f..00000000
--- a/docs/system/task-scheduler.rst
+++ /dev/null
@@ -1,40 +0,0 @@
-.. _task-scheduler:
-
-##############
-Task Scheduler
-##############
-
-The task scheduler allows you to execute tasks on a given schedule. It makes
-use of UNIX cron_.
-
-.. note:: All scripts excecuted this way are executed as root user - this may
- be dangerous. Together with :ref:`command-scripting` this can be used for
- automating (re-)configuration.
-
-.. cfgcmd:: set system task-scheduler task <task> interval <interval>
-
- Specify the time interval when `<task>` should be executed. The interval
- is specified as number with one of the following suffixes:
-
- * ``none`` - Execution interval in minutes
- * ``m`` - Execution interval in minutes
- * ``h`` - Execution interval in hours
- * ``d`` - Execution interval in days
-
- .. note:: If suffix is omitted, minutes are implied.
-
-.. cfgcmd:: set system task-scheduler task <task> crontab-spec <spec>
-
- Set execution time in common cron_ time format. A cron `<spec>` of
- ``30 */6 * * *`` would execute the `<task>` at minute 30 past every 6th hour.
-
-.. cfgcmd:: set system task-scheduler task <task> executable path <path>
-
- Specify absolute `<path>` to script which will be run when `<task>` is
- executed.
-
-.. cfgcmd:: set system task-scheduler task <task> executable arguments <args>
-
- Arguments which will be passed to the executable.
-
-.. _cron: https://en.wikipedia.org/wiki/Cron