]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: Add reference to vtysh in basic setup
authorTrey Aspelund <taspelund@nvidia.com>
Tue, 17 Aug 2021 23:29:55 +0000 (19:29 -0400)
committerTrey Aspelund <taspelund@nvidia.com>
Tue, 14 Sep 2021 20:42:56 +0000 (16:42 -0400)
Received user feedback that it was unclear how to get into the FRR
shell.  Adding a snippet to the basic setup page to help clarify.

Signed-off-by: Trey Aspelund <taspelund@nvidia.com>
doc/user/setup.rst

index 64a33765c2650d1d220900ba899aaf92facc077d..dbbfca21e7f42e1b97e103c9760faf11ef89674a 100644 (file)
@@ -176,6 +176,27 @@ Operations
 
 This section covers a few common operational tasks and how to perform them.
 
+Interactive Shell
+^^^^^^^^^^^^^^^^^
+FRR offers an IOS-like interactive shell called ``vtysh`` where a user can run
+individual configuration or show commands. To get into this shell, issue the
+``vtysh`` command from either a privilege user (root, or with sudo) or a user
+account that is part of the ``frrvty`` group.
+e.g.
+
+.. code-block:: console
+
+   root@ub18:~# vtysh
+
+   Hello, this is FRRouting (version 8.1-dev).
+   Copyright 1996-2005 Kunihiro Ishiguro, et al.
+
+   ub18#
+
+.. note::
+   The default install location for vtysh is /usr/bin/vtysh
+
+
 Restarting
 ^^^^^^^^^^