doc/manpages/watchfrr.rst

   1 ********
   2 WATCHFRR
   3 ********
   4
   5 .. include:: defines.rst
   6 .. |DAEMON| replace:: watchfrr
   7
   8 SYNOPSIS
   9 ========
  10 |DAEMON| |synopsis-options-hv|
  11
  12 |DAEMON| [option...] <daemon>...
  13
  14
  15 DESCRIPTION
  16 ===========
  17 |DAEMON| is a watchdog program that monitors the status of supplied frr daemons and tries to restart them in case they become unresponsive or shut down.
  18
  19 To determine whether a daemon is running, it tries to connect to the daemon's VTY UNIX stream socket, and send echo commands to ensure the daemon responds. When the daemon crashes, EOF is received from the socket, so that |DAEMON| can react immediately.
  20
  21 In order to avoid restarting the daemons in quick succession, you can supply the -m and -M options to set the minimum and maximum delay between the restart commands. The minimum restart delay is recalculated each time a restart is attempted.  If the time since the last restart attempt exceeds twice the value of -M, the restart delay is set to the value of -m, otherwise the interval is doubled (but capped at the value of -M).
  22
  23 OPTIONS
  24 =======
  25
  26 .. option:: --dry
  27
  28    Run |DAEMON| in "dry-run" mode, only monitoring the specified daemons but not performing any start/stop/restart actions.
  29
  30 .. option:: -d, --daemon
  31
  32    Run in daemon mode. When supplied, error messages are sent to Syslog instead of standard output (stdout).
  33
  34 .. option:: -S <directory>, --statedir <directory>
  35
  36    Set the VTY socket directory (the default value is "/var/run/frr").
  37
  38 .. option:: -l <level>, --loglevel <level>
  39
  40    Set the logging level (the default value is "6"). The value should range from 0 (LOG_EMERG) to 7 (LOG_DEBUG), but higher number can be supplied if extra debugging messages are required.
  41
  42 .. option:: --min-restart-interval <number>
  43
  44    Set the minimum number of seconds to wait between invocations of the daemon restart commands (the default value is "60").
  45
  46 .. option:: --max-restart-interval <number>
  47
  48    Set the maximum number of seconds to wait between invocations of the daemon restart commands (the default value is "600").
  49
  50 .. option:: -i <number>, --interval <number>
  51
  52    Set the status polling interval in seconds (the default value is "5").
  53
  54 .. option:: -t <number>, --timeout <number>
  55
  56    Set the unresponsiveness timeout in seconds (the default value is "10").
  57
  58 .. option:: -T <number>, --restart-timeout <number>
  59
  60    Set the restart (kill) timeout in seconds (the default value is "20"). If any background jobs are still running after this period has elapsed, they will be killed.
  61
  62 .. option:: -p <filename>, --pid-file <filename>
  63
  64    Set the process identifier filename (the default value is "/var/run/frr/|DAEMON|.pid").
  65
  66 .. option:: -b <string>, --blank-string <string>
  67
  68    When the supplied string is found in any of the command line option arguments (i.e., -r, -s, or -k), replace it with a space.
  69
  70    This is an ugly hack to circumvent problems with passing the command line arguments containing embedded spaces.
  71
  72 .. option:: -v, --version
  73
  74    Display the version information and exit.
  75
  76 .. option:: -h, --help
  77
  78    Display the usage information and exit.
  79
  80 The following 3 options specify scripts that |DAEMON| uses to perform start/stop/restart actions. Reasonable default values are built into watchfrr, so the use of these options should no longer be necessary:
  81
  82 .. option:: -s command, --start-command command
  83
  84   Supply a Bourne shell command to start a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
  85
  86 .. option:: -k command, --kill-command command
  87
  88    Supply a Bourne shell command to stop a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
  89
  90 .. option:: -r command, --restart command
  91
  92    Supply a Bourne shell command to restart a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
  93
  94 PREVIOUS OPTIONS
  95 ================
  96 Prior versions of |DAEMON| supported some additional options that no longer exist:::
  97
  98    -a, -A, -e, -R, -z
  99
 100 The ``-a``, ``-A`` and ``-R`` options were used to select alternate monitoring modes that offered different patterns of restarting daemons. The "correct" mode (phased restart) is now the default. The -e and -z options used to disable some monitoring aspects, |DAEMON| now always has all monitoring features enabled.
 101
 102 Removing these options should result in correct operation, if it does not please file a bug report.
 103
 104 FILES
 105 =====
 106
 107 |INSTALL_PREFIX_SBIN|/|DAEMON|
 108    The default location of the |DAEMON| binary.
 109
 110 |INSTALL_PREFIX_ETC|/|DAEMON|.conf
 111    The default location of the |DAEMON| config file.
 112
 113 $(PWD)/|DAEMON|.log
 114    If the |DAEMON| process is configured to output logs to a file, then you
 115    will find this file in the directory where you started |DAEMON|.
 116
 117 .. include:: epilogue.rst
 118