add commandscripting docu

This commit is contained in:
rebortg 2019-04-03 21:58:58 +02:00
parent b794545cd8
commit fdf235905c
3 changed files with 54 additions and 1 deletions

51
docs/commandscripting.rst Normal file
View File

@ -0,0 +1,51 @@
.. _commandscripting:
Command scripting
=================
VyOS supports executing configuration and operational commands non-interactively from shell scripts.
To include VyOS-specific functions and aliases you need to ``source /opt/vyatta/etc/functions/script-template`` files at the top of your script.
.. code-block:: sh
#!/bin/vbash
source /opt/vyatta/etc/functions/script-template
exit
Run configuration commands
--------------------------
Configuration commands are executed just like from a normal config session.
For example, if you want to disable a BGP peer on VRRP transition to backup:
.. code-block:: sh
#!/bin/vbash
source /opt/vyatta/etc/functions/script-template
configure
set protocols bgp 65536 neighbor 192.168.2.1 shutdown
commit
exit
Run operational commands
------------------------
Unlike a normal configuration sessions, all operational commands must be prepended with ``run``, even if you haven't created a session with configure.
.. code-block:: sh
#!/bin/vbash
source /opt/vyatta/etc/functions/script-template
run show interfaces
exit

View File

@ -30,6 +30,7 @@ as a router and firewall platform for cloud deployments.
high-availability.rst
clustering.rst
image-mgmt.rst
commandscripting.rst
troubleshooting.rst
examples.rst
commandtree/index.rst

View File

@ -4,7 +4,8 @@
Task scheduler
--------------
Task scheduler — allows scheduled task execution. Note that scripts excecuted this way are executed as root user - this may be dangerous.
| Task scheduler — allows scheduled task execution. Note that scripts excecuted this way are executed as root user - this may be dangerous.
| Together with :ref:`commandscripting` this can be used for automating configuration.
.. code-block:: sh