1VTYSH(1)                              FRR                             VTYSH(1)
2
3
4

NAME

6       vtysh - an integrated shell for FRRouting.
7

SYNOPSIS

9       vtysh [ -b ]
10
11       vtysh [ -E ] [ -d daemon ] [ -c command ]
12

DESCRIPTION

14       vtysh  is  an integrated shell for the FRRouting suite of protocol dae‐
15       mons.
16

OPTIONS

18       OPTIONS available for the vtysh command:
19
20       -b, --boot
21              Execute boot startup configuration. It makes sense only if inte‐
22              grated  config  file  is  in use (not default in FRRouting). See
23              Info file frr for more info.
24
25       -c, --command command
26              Specify command to be executed under batch mode. It behaves like
27              -c option in any other shell - command is executed and vtysh ex‐
28              its.
29
30              It's useful for gathering info from FRRouting daemons or  recon‐
31              figuring  daemons from inside shell scripts, etc. Note that mul‐
32              tiple commands may be executed by using more than one -c  option
33              and/or embedding linefeed characters inside the command string.
34
35       -d, --daemon daemon_name
36              Specify  which  daemon to connect to. By default, vtysh attempts
37              to connect to all FRRouting daemons running on the system.  With
38              this  flag,  one  can  specify a single daemon to connect to in‐
39              stead. For example, specifying '-d ospfd' will connect  only  to
40              ospfd.  This  can  be particularly useful inside scripts with -c
41              where the command is targeted for a single daemon.
42
43       -e, --execute command
44              Alias for -c. It's here only for compatibility with Zebra  rout‐
45              ing software and older FRR versions. This will be removed in fu‐
46              ture.
47
48       -E, --echo
49              When the -c option is being used, this flag will cause the stan‐
50              dard  vtysh  prompt and command to be echoed prior to displaying
51              the results. This is particularly useful to separate the results
52              when executing multiple commands.
53
54       -C, --dryrun
55              When  the -C option is being used, this flag will check the con‐
56              fig for syntatic validity.
57
58       -m, --markfile
59              Mark the input file with context ends, useful for cleanup  of  a
60              config file that has a lot of extraneous space and end markers
61
62       -n, --noerror
63              When executing cli that does not invoke a vtysh shell, if an er‐
64              ror ocurrs ignore it for purposes of return codes from vtysh.
65
66       -u, --user
67              Restrict access to configuration commands by preventing  use  of
68              the "enable" command. This option provides the same limited "se‐
69              curity"  as  password-protected  telnet  access.  This  security
70              should not be relied on in production environments.
71
72              Caveat emptor: VTYSH was never designed to be a privilege broker
73              and is not built using secure coding practices. No guarantees of
74              security are provided for this option and under no circumstances
75              should this option be used to provide any  semblance  of  secure
76              read-only access to FRR.
77
78       -h, --help
79              Display a usage message on standard output and exit.
80

ENVIRONMENT VARIABLES

82       VTYSH_PAGER
83              This should be the name of the pager to use. Default is more.
84

FILES

86       /usr/lib/frr/vtysh
87              The default location of the vtysh binary.
88
89       /etc/frr/vtysh.conf
90              The default location of the vtysh config file.
91
92       /etc/frr/frr.conf
93              The  default location of the integrated FRRouting routing engine
94              config file if integrated config file is in use.
95
96       ${HOME}/.history_frr
97              Location of history of commands entered via cli
98
99       $(PWD)/vtysh.log
100              If the vtysh process is configured to output  logs  to  a  file,
101              then  you will find this file in the directory where you started
102              vtysh.
103

WARNING

105       This man page is intended to be a quick reference for command line  op‐
106       tions.  The definitive document is the info file frr 7.5.1 or the docu‐
107       mentation available on the project website at https://frrouting.org/.
108

DIAGNOSTICS

110       The daemon may log to standard output, to a VTY,  to  a  log  file,  or
111       through syslog to the system logs. FRR supports many debugging options,
112       see the Info file, web docs or source for details.
113

SEE ALSO

115       frr-zebra(8),  vtysh(1),  frr-ripd(8),   frr-ripngd(8),   frr-ospfd(8),
116       frr-ospf6d(8),  frr-bgpd(8), frr-isisd(8), frr-babeld(8), frr-nhrpd(8),
117       frr-pimd(8), frr-pbrd(8), frr-ldpd(8),  frr-eigrpd(8),  frr-staticd(8),
118       frr-fabricd(8), frr-vrrpd(8), mtracebis(8) https://frrouting.org/
119

BUGS

121       FRR  eats  bugs  for  breakfast.  If you have food for the maintainers,
122       please email <dev@lists.frrouting.org>.
123

125       2021, FRR
126
127
128
129
1307.5.1                            Apr 23, 2021                         VTYSH(1)
Impressum