From bca2d9bc701c43c987fa1d736f0ad66a4b8aa41a Mon Sep 17 00:00:00 2001 From: Trey Aspelund Date: Tue, 17 Aug 2021 19:29:55 -0400 Subject: [PATCH] doc: Add reference to vtysh in basic setup 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 --- doc/user/setup.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/user/setup.rst b/doc/user/setup.rst index 64a33765c2..dbbfca21e7 100644 --- a/doc/user/setup.rst +++ b/doc/user/setup.rst @@ -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 ^^^^^^^^^^