doc/manpages/vtysh.rst

   1 *****
   2 VTYSH
   3 *****
   4
   5 .. include:: defines.rst
   6 .. |DAEMON| replace:: eigrpd
   7
   8 SYNOPSIS
   9 ========
  10 vtysh [ -b ]
  11
  12 vtysh [ -E ] [ -d *daemon* ] [ -c *command* ]
  13
  14 DESCRIPTION
  15 ===========
  16 vtysh is an integrated shell for the FRRouting suite of protocol daemons.
  17
  18 OPTIONS
  19 =======
  20 OPTIONS available for the vtysh command:
  21
  22 .. option:: -b, --boot
  23
  24    Execute boot startup configuration. It makes sense only if integrated config file is in use (not default in FRRouting). See Info file frr for more info.
  25
  26 .. option:: -c, --command command
  27
  28    Specify command to be executed under batch mode. It behaves like -c option in any other shell - command is executed and vtysh exits.
  29
  30    It's useful for gathering info from FRRouting daemons or reconfiguring daemons from inside shell scripts, etc. Note that multiple commands may be executed by using more than one -c option and/or embedding linefeed characters inside the command string.
  31
  32 .. option:: -d, --daemon daemon_name
  33
  34    Specify which daemon to connect to. By default, vtysh attempts to connect to all FRRouting daemons running on the system. With this flag, one can specify a single daemon to connect to instead. For example, specifying '-d ospfd' will connect only to ospfd. This can be particularly useful inside scripts with -c where the command is targeted for a single daemon.
  35
  36 .. option:: -e, --execute command
  37
  38    Alias for -c. It's here only for compatibility with Zebra routing software and older FRR versions. This will be removed in future.
  39
  40 .. option:: -E, --echo
  41
  42    When the -c option is being used, this flag will cause the standard vtysh prompt and command to be echoed prior to displaying the results. This is particularly useful to separate the results when executing multiple commands.
  43
  44 .. option:: -h, --help
  45
  46    Display a usage message on standard output and exit.
  47
  48 ENVIRONMENT VARIABLES
  49 =====================
  50 VTYSH_PAGER
  51    This should be the name of the pager to use. Default is more.
  52
  53 FILES
  54 =====
  55 |INSTALL_PREFIX_SBIN|/vtysh
  56    The default location of the vtysh binary.
  57
  58 |INSTALL_PREFIX_ETC|/vtysh.conf
  59    The default location of the vtysh config file.
  60
  61 |INSTALL_PREFIX_ETC|/frr.conf
  62    The default location of the integrated FRRouting routing engine config file if integrated config file is in use.
  63
  64 ${HOME}/.history_frr
  65    Location of history of commands entered via cli
  66
  67 $(PWD)/|DAEMON|.log
  68    If the |DAEMON| process is configured to output logs to a file, then you
  69    will find this file in the directory where you started |DAEMON|.
  70
  71 .. include:: epilogue.rst
  72