From db246ebed19a19d7c9f48077742523095e74b876 Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Mon, 21 Feb 2022 19:44:09 +0100
Subject: command-scripting: add example for tremote SSH op-mode commands

(cherry picked from commit 66fcc79035cdcb5c4500e5bdeba62889668df1e2)
---
 docs/automation/command-scripting.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'docs/automation/command-scripting.rst')

diff --git a/docs/automation/command-scripting.rst b/docs/automation/command-scripting.rst
index 1f9108f8..af93a4a8 100644
--- a/docs/automation/command-scripting.rst
+++ b/docs/automation/command-scripting.rst
@@ -45,6 +45,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
 ----------------------
 
-- 
cgit v1.2.3