vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-12-16 18:42:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

automation: add custom pre/post-commit hooks

Browse Source
This commit is contained in:
fett0 2021-06-18 17:09:30 -03:00
parent f7fc3ce017
commit 6f94d588f5
1 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/automation/command-scripting.rst
View File

@ -106,23 +106,39 @@ group, the script can be safeguarded like this:
fi fi
Executing pre-hooks/post-hooks Scripts Executing pre-hooks/post-hooks Scripts
------------------------------- --------------------------------------
Vyos has the ability to run custom scripts before and after each commit Vyos has the ability to run custom scripts before and after each commit
≈ The default directories where your custom Scripts should be located are:
The default folder where you put your custom Scripts is:
.. code-block:: none .. 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 Scripts are run in alphabetical order. Their names must consist entirely of ASCII upper- and
/config/scripts/commit/post-hooks.d - folder with scripts that run after each commit 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. 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 Postconfig on boot
------------------ ------------------