proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-12 01:42:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Add reference to vtysh in basic setup

Browse Source 
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>
This commit is contained in:
Trey Aspelund 2021-08-17 19:29:55 -04:00
parent 2a8ded2b97
commit bca2d9bc70
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/user/setup.rst
View 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
^^^^^^^^^^