From c25c40dfa96dfeb022b203280c607c1f1835417b Mon Sep 17 00:00:00 2001
From: Robert Göhler <github@ghlr.de>
Date: Sun, 24 Jan 2021 22:14:00 +0100
Subject: Migrate new file structure to crux (#435)

* order workflows and add submodule

* rename gitmodules file

* delete docs/.gitignore

* add vyos custom linter

* correct __pycache__ in gitignore

* add test-coverage.py

* move draw.io folder

* arrange changelog, install history and about

* arrange: firewall

* arrange: highavailability

* arrange: loadbalancing

* arrange: nat

* arrange: services

* sort configexamples and configuration interfaces

* wireles: rename wireless

* rearrange: Protocols and Policy

* rearrange: Firewall and Zone Policy

* rearrange: Interfaces

* rearrange: Interfaces

* rearrange: dynamic DNS

* hostinfo: add page to index

* rearrange: appendix

* venv: add Pipfile

* rearrange: contributing

* index: remove debugging

* rearrange: fix all figure and refs

* rearrange: commandtree

* fix: cli, openvpn, install headline level

* protocols: change headline

* firewall: move mss clamping

* ip: separate ipv4 and ipv6

* arp: move to static page

* igmp: rename multicast page

* Update to year 2021
---
 docs/configuration/system/task-scheduler.rst | 60 ++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 docs/configuration/system/task-scheduler.rst

(limited to 'docs/configuration/system/task-scheduler.rst')

diff --git a/docs/configuration/system/task-scheduler.rst b/docs/configuration/system/task-scheduler.rst
new file mode 100644
index 00000000..7fe49988
--- /dev/null
+++ b/docs/configuration/system/task-scheduler.rst
@@ -0,0 +1,60 @@
+.. _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.
+| Together with :ref:`commandscripting` this can be used for automating configuration.
+
+.. code-block:: none
+
+  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:: none
+
+  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:: none
+
+  set system task-scheduler task TEST crontab-spec "* * * 1 *"
+
+Example
+*******
+
+.. code-block:: none
+
+  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
-- 
cgit v1.2.3