summaryrefslogtreecommitdiff
path: root/docs/configuration/system
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2022-07-07 17:06:48 +0200
committerGitHub <noreply@github.com>2022-07-07 17:06:48 +0200
commit14edf2698d3b063a06e3964dd1bd2961711d1d81 (patch)
tree651c58c451052683b7738c9d9641d3ccf900fe84 /docs/configuration/system
parenta04df9e0c61fee87f297972db17fee93878016de (diff)
parente1b2a017fdca013fa4aa7e16e5c56cef8d845ba3 (diff)
downloadvyos-documentation-14edf2698d3b063a06e3964dd1bd2961711d1d81.tar.gz
vyos-documentation-14edf2698d3b063a06e3964dd1bd2961711d1d81.zip
Merge pull request #804 from aapostoliuk/eventhandlerdocs
event handler: T3083: Created documentation for the new Event Handler
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