diff options
| author | aapostoliuk <a.apostoliuk@vyos.io> | 2022-07-04 09:59:33 -0400 |
|---|---|---|
| committer | aapostoliuk <a.apostoliuk@vyos.io> | 2022-07-04 09:59:33 -0400 |
| commit | e1b2a017fdca013fa4aa7e16e5c56cef8d845ba3 (patch) | |
| tree | 36fca0f898322e62bfe7306f0dba688fc3a7d167 /docs/configuration/system | |
| parent | b0544eab8dfbe583686c1fdb98241eaee6d11d8f (diff) | |
| download | vyos-documentation-e1b2a017fdca013fa4aa7e16e5c56cef8d845ba3.tar.gz vyos-documentation-e1b2a017fdca013fa4aa7e16e5c56cef8d845ba3.zip | |
event handler: T3083: Created documentation for the new Event Handler
Created documentation for the new Event Handler module
Diffstat (limited to 'docs/configuration/system')
| -rw-r--r-- | docs/configuration/system/eventhandler.rst | 51 | ||||
| -rw-r--r-- | docs/configuration/system/index.rst | 1 |
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 9b4bf2e3..5a6cb7b1 100644 --- a/docs/configuration/system/index.rst +++ b/docs/configuration/system/index.rst @@ -29,4 +29,3 @@ System :includehidden: default-route - eventhandler |