vtysh.texi 2.4 KB

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