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       -H, --histfile
67              Override the history file for vtysh commands. You can set  vtysh
68              -H /dev/null to turn logging of at all.
69
70       -u, --user
71              Restrict  access  to configuration commands by preventing use of
72              the "enable" command. This option provides the same limited "se‐
73              curity"  as  password-protected  telnet  access.  This  security
74              should not be relied on in production environments.
75
76              Caveat emptor: VTYSH was never designed to be a privilege broker
77              and is not built using secure coding practices. No guarantees of
78              security are provided for this option and under no circumstances
79              should  this  option  be used to provide any semblance of secure
80              read-only access to FRR.
81
82       -h, --help
83              Display a usage message on standard output and exit.
84

ENVIRONMENT VARIABLES

86       VTYSH_PAGER
87              This should be the name of the pager to use. Default is more.
88
89       VTYSH_HISTFILE
90              Override the history file for vtysh  commands.  Logging  can  be
91              turned off using VTYSH_HISTFILE=/dev/null vtysh.  Environment is
92              preferred way to override the history  file  path  over  command
93              line argument (-H/--histfile).
94

FILES

96       /usr/lib/frr/vtysh
97              The default location of the vtysh binary.
98
99       /etc/frr/vtysh.conf
100              The default location of the vtysh config file.
101
102       /etc/frr/frr.conf
103              The  default location of the integrated FRRouting routing engine
104              config file if integrated config file is in use.
105
106       ${HOME}/.history_frr
107              Location of history of commands entered via cli
108
109       $(PWD)/vtysh.log
110              If the vtysh process is configured to output  logs  to  a  file,
111              then  you will find this file in the directory where you started
112              vtysh.
113

WARNING

115       This man page is intended to be a quick reference for command line  op‐
116       tions.  The definitive document is the info file frr 8.5.3 or the docu‐
117       mentation available on the project website at https://frrouting.org/.
118

DIAGNOSTICS

120       The daemon may log to standard output, to a VTY,  to  a  log  file,  or
121       through syslog to the system logs. FRR supports many debugging options,
122       see the Info file, web docs or source for details.
123

SEE ALSO

125       frr-zebra(8),  vtysh(1),  frr-ripd(8),   frr-ripngd(8),   frr-ospfd(8),
126       frr-ospf6d(8),  frr-bgpd(8), frr-isisd(8), frr-babeld(8), frr-nhrpd(8),
127       frr-pimd(8), frr-pbrd(8), frr-ldpd(8),  frr-eigrpd(8),  frr-staticd(8),
128       frr-fabricd(8), frr-vrrpd(8), mtracebis(8) https://frrouting.org/
129

BUGS

131       FRR  eats  bugs  for  breakfast.  If you have food for the maintainers,
132       please email <dev@lists.frrouting.org>.
133

COPYRIGHT

135       2023, FRR
136
137
138
139
1408.5.3                            Oct 10, 2023                         VTYSH(1)