summaryrefslogtreecommitdiff
path: root/docs/configuration/system
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2023-06-12 21:26:19 +0200
committerrebortg <github@ghlr.de>2023-06-12 21:26:19 +0200
commit649d70929263e19413c1bf8f1133edfb1c06bfb9 (patch)
treef5295fc332eb83b9088092cddf87ab89a0423287 /docs/configuration/system
parent1d5b7e4f6f38b0b653bc61be1b86c06e3f0c045f (diff)
downloadvyos-documentation-649d70929263e19413c1bf8f1133edfb1c06bfb9.tar.gz
vyos-documentation-649d70929263e19413c1bf8f1133edfb1c06bfb9.zip
backport new eventhandler feature
Diffstat (limited to 'docs/configuration/system')
-rw-r--r--docs/configuration/system/eventhandler.rst51
-rw-r--r--docs/configuration/system/index.rst1
2 files changed, 0 insertions, 52 deletions
diff --git a/docs/configuration/system/eventhandler.rst b/docs/configuration/system/eventhandler.rst
deleted file mode 100644
index 3eab4e2c..00000000
--- a/docs/configuration/system/eventhandler.rst
+++ /dev/null
@@ -1,51 +0,0 @@
-.. _event-handler:
-
-Event Handler
--------------
-
-Event handler allows you to execute scripts when a string that matches a regex
-appears in a text stream (e.g. log file).
-
-It uses "feeds" (output of commands, or a named pipes) and "policies" that
-define what to execute if a regex is matched.
-
-.. code-block:: none
-
- system
- event-handler
- feed <name>
- description <feed description>
- policy <policy name>
- source
- preset
- syslog # Use the syslog logs for feed
- custom
- command <command to execute> # E.g. "tail -f /var/log/somelogfile"
- named-pipe <path to a names pipe>
- policy <policy name>
- description <policy description>
- event <event name>
- description <event description>
- pattern <regex>
- run <command to run>
-
-In this small example a script runs every time a login failed and an interface
-goes down
-
-.. code-block:: none
-
- vyos@vyos# show system event-handler
- feed Syslog {
- policy MyPolicy
- source {
- preset syslog
- }
- }
- policy MyPolicy {
- description "Test policy"
- event BadThingsHappened {
- pattern "authentication failure"
- pattern "interface \.* index \d+ .* DOWN.*"
- run /config/scripts/email-to-admin
- }
- } \ No newline at end of file
diff --git a/docs/configuration/system/index.rst b/docs/configuration/system/index.rst
index 9791ddb1..5bf781af 100644
--- a/docs/configuration/system/index.rst
+++ b/docs/configuration/system/index.rst
@@ -30,4 +30,3 @@ System
:includehidden:
default-route
- eventhandler