diff options
| -rw-r--r-- | doc/user/setup.rst | 21 |
1 files changed, 21 insertions, 0 deletions
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 ^^^^^^^^^^ |