diff options
| author | fett0 <fernando.gmaidana@gmail.com> | 2021-06-18 17:09:30 -0300 |
|---|---|---|
| committer | fett0 <fernando.gmaidana@gmail.com> | 2021-06-18 17:09:30 -0300 |
| commit | 6f94d588f55a8794f5379112adcfef901a9cf754 (patch) | |
| tree | b73b5cddefbc69286033483a3a09ceef4d959828 | |
| parent | f7fc3ce017b03f7c9f4a20a94e2a4d03ee935852 (diff) | |
| download | vyos-documentation-6f94d588f55a8794f5379112adcfef901a9cf754.tar.gz vyos-documentation-6f94d588f55a8794f5379112adcfef901a9cf754.zip | |
automation: add custom pre/post-commit hooks
| -rw-r--r-- | docs/automation/command-scripting.rst | 32 |
1 files changed, 24 insertions, 8 deletions
diff --git a/docs/automation/command-scripting.rst b/docs/automation/command-scripting.rst index b48b8dbf..43614c21 100644 --- a/docs/automation/command-scripting.rst +++ b/docs/automation/command-scripting.rst @@ -106,23 +106,39 @@ group, the script can be safeguarded like this: fi Executing pre-hooks/post-hooks Scripts -------------------------------- +-------------------------------------- Vyos has the ability to run custom scripts before and after each commit -≈ - -The default folder where you put your custom Scripts is: +The default directories where your custom Scripts should be located are: .. code-block:: none + /config/scripts/commit/pre-hooks.d - Directory with scripts that run before each commit + /config/scripts/commit/post-hooks.d - Directory with scripts that run after each commit -/config/scripts/commit/pre-hooks.d - folder with scripts that run before each commit -/config/scripts/commit/post-hooks.d - folder with scripts that run after each commit - -Scripts are run in alphabetical order. Their names must consist entirely of ASCII upper- and lower-case letters, ASCII digits, ASCII underscores, and ASCII minus-hyphens. +Scripts are run in alphabetical order. Their names must consist entirely of ASCII upper- and +lower-case letters,ASCII digits, ASCII underscores, and ASCII minus-hyphens. No other characters are allowed. +.. note:: Custom scripts are not executed with root privileges (Use sudo inside if this is necessary). + +A simple example is shown below, where the ops command executed in the post-hook script is "show interfaces". + +.. code-block:: none + + vyos@vyos# set interfaces ethernet eth1 address 30.30.30.30/24 + vyos@vyos# commit + Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down + Interface IP Address S/L Description + --------- ---------- --- ----------- + eth0 10.10.10.10/24 u/u + eth1 30.30.30.30/24 u/u + eth2 10.10.20.20/24 u/u + eth3 - u/u + lo 127.0.0.1/8 u/u + ::1/128 + Postconfig on boot ------------------ |