diff options
Diffstat (limited to 'docs/automation')
| -rw-r--r-- | docs/automation/command-scripting.rst | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/docs/automation/command-scripting.rst b/docs/automation/command-scripting.rst index 7836d4fd..1f9108f8 100644 --- a/docs/automation/command-scripting.rst +++ b/docs/automation/command-scripting.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-06-27 + .. _command-scripting: Command Scripting @@ -33,7 +35,7 @@ example, if you want to disable a BGP peer on VRRP transition to backup: Run operational commands ------------------------ -Unlike a normal configuration sessions, all operational commands must be +Unlike a normal configuration session, all operational commands must be prepended with ``run``, even if you haven't created a session with configure. .. code-block:: none @@ -43,8 +45,8 @@ prepended with ``run``, even if you haven't created a session with configure. run show interfaces exit -Other script language ---------------------- +Other script languages +---------------------- If you want to script the configs in a language other than bash you can have your script output commands and then source them in a bash script. @@ -107,7 +109,7 @@ group, the script can be safeguarded like this: 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: @@ -123,7 +125,8 @@ 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). +.. 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". @@ -147,8 +150,8 @@ Preconfig on boot The ``/config/scripts/vyos-preconfig-bootup.script`` script is called on boot before the VyOS configuration during boot process. -Any modifications done to work around unfixed bugs and implement enhancements -which are not complete in the VyOS system can be placed here. +Any modifications were done to work around unfixed bugs and implement +enhancements that are not complete in the VyOS system can be placed here. The default file looks like this: @@ -166,8 +169,8 @@ Postconfig on boot The ``/config/scripts/vyos-postconfig-bootup.script`` script is called on boot after the VyOS configuration is fully applied. -Any modifications done to work around unfixed bugs and implement enhancements -which are not complete in the VyOS system can be placed here. +Any modifications were done to work around unfixed bugs and implement +enhancements that are not complete in the VyOS system can be placed here. The default file looks like this: @@ -178,6 +181,6 @@ The default file looks like this: # applied. Any modifications required to work around unfixed bugs or use # services not available through the VyOS CLI system can be placed here. -.. hint:: For configuration/upgrade management issues, modification of these +.. hint:: For configuration/upgrade management issues, modification of this script should be the last option. Always try to find solutions based on CLI commands first.
\ No newline at end of file |