Return to vtysh.texi CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / quagga / doc

quagga

    1: @node VTY shell
    2: @chapter VTY shell
    3: 
    4: @command{vtysh} is integrated shell of Quagga software.
    5: 
    6: To use vtysh please specify ---enable-vtysh to configure script.  To use
    7: PAM for authentication use ---with-libpam option to configure script.
    8: 
    9: vtysh only searches @value{INSTALL_PREFIX_ETC} path for vtysh.conf which
   10: is the vtysh configuration file.  Vtysh does not search current
   11: directory for configuration file because the file includes user
   12: authentication settings.
   13: 
   14: Currently, vtysh.conf has only two commands.
   15: 
   16: @menu
   17: * VTY shell username::
   18: * VTY shell integrated configuration::
   19: @end menu
   20: 
   21: @node VTY shell username
   22: @section VTY shell username
   23: 
   24: @deffn {Command} {username @var{username} nopassword} {}
   25: 
   26: With this set, user foo does not need password authentication for user vtysh.
   27: With PAM vtysh uses PAM authentication mechanism.
   28: 
   29: If vtysh is compiled without PAM authentication, every user can use vtysh
   30: without authentication. vtysh requires read/write permission
   31: to the various daemons vty sockets, this can be accomplished through use
   32: of unix groups and the --enable-vty-group configure option.
   33: 
   34: @end deffn
   35: 
   36: @node VTY shell integrated configuration
   37: @section VTY shell integrated configuration
   38: 
   39: @deffn {Command} {service integrated-vtysh-config} {}
   40: Write out integrated Quagga.conf file when 'write file' is issued.
   41: 
   42: This command controls the behaviour of vtysh when it is told to write out
   43: the configuration.  Per default, vtysh will instruct each daemon to write
   44: out their own config files when @command{write file} is issued.  However, if
   45: @command{service integrated-vtysh-config} is set, when @command{write file}
   46: is issued, vtysh will instruct the daemons will write out a Quagga.conf with
   47: all daemons' commands integrated into it. 
   48: 
   49: Vtysh per default behaves as if @command{write-conf daemon} is set. Note
   50: that both may be set at same time if one wishes to have both Quagga.conf and
   51: daemon specific files written out. Further, note that the daemons are
   52: hard-coded to first look for the integrated Quagga.conf file before looking
   53: for their own file.
   54: 
   55: We recommend you do not mix the use of the two types of files. Further, it
   56: is better not to use the integrated Quagga.conf file, as any syntax error in
   57: it can lead to /all/ of your daemons being unable to start up. Per daemon
   58: files are more robust as impact of errors in configuration are limited to
   59: the daemon in whose file the error is made.
   60: 
   61: @end deffn