diff options
Diffstat (limited to 'docs/automation')
| -rw-r--r-- | docs/automation/command-scripting.rst | 40 |
1 files changed, 33 insertions, 7 deletions
diff --git a/docs/automation/command-scripting.rst b/docs/automation/command-scripting.rst index 14f2edfa..4486b0c9 100644 --- a/docs/automation/command-scripting.rst +++ b/docs/automation/command-scripting.rst @@ -46,6 +46,32 @@ prepended with ``run``, even if you haven't created a session with configure. run show interfaces exit +Run commands remotely +--------------------- + +Sometimes you simply wan't to execute a bunch of op-mode commands via SSH on +a remote VyOS system. + +.. code-block:: none + + ssh 192.0.2.1 'vbash -s' <<EOF + source /opt/vyatta/etc/functions/script-template + run show interfaces + exit + EOF + +Will return: + +``` +Welcome to VyOS +Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down +Interface IP Address S/L Description +--------- ---------- --- ----------- +eth0 192.0.2.1/24 u/u +lo 127.0.0.1/8 u/u + ::1/128 +``` + Other script languages ---------------------- @@ -116,20 +142,20 @@ 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 + /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. -Scripts are run in alphabetical order. Their names must consist entirely of -ASCII upper- and lower-case letters,ASCII digits, ASCII underscores, and +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 +A simple example is shown below, where the ops command executed in the post-hook script is "show interfaces". .. code-block:: none @@ -144,7 +170,7 @@ the post-hook script is "show interfaces". eth2 - u/u eth3 - u/u lo 203.0.113.5/24 u/u - + Preconfig on boot ----------------- @@ -159,9 +185,9 @@ The default file looks like this: .. code-block:: none #!/bin/sh - # This script is executed at boot time before VyOS configuration is applied. + # This script is executed at boot time before VyOS configuration is applied. # Any modifications required to work around unfixed bugs or use - # services not available through the VyOS CLI system can be placed here. + # services not available through the VyOS CLI system can be placed here. Postconfig on boot |