contrib/README

   1 NSCA-ng's "contrib" Directory
   2 =============================
   3
   4 This directory contains a collection of scripts that may be useful.  All
   5 scripts except for `nsca-ng.init` allow for specifying the path to the
   6 `send_nsca.cfg(5)` file via `-c <path>`.  Other `send_nsca(8)` options can
   7 be specified by setting the environment variable `SEND_NSCA_ARGS`.  All
   8 scripts print usage information when called with the `-h` option.
   9
  10 * `acknowledge`
  11
  12     Acknowledges a problem using `send_nsca(8)`.  If the `-S` option is
  13     specified, a service problem is acknowledged; otherwise, a host problem
  14     is acknowledged.  Example invocation:
  15
  16         $ acknowledge -H www -S HTTP
  17
  18 * `debug_server`
  19
  20     Opens a raw TLS connection to the `nsca-ng(8)` server, sends any lines
  21     read from the standard input, and prints any server responses to the
  22     standard output.  Requires `s_client(1)` from OpenSSL 1.0.0 or newer,
  23     and `xxd(1)`.  Example invocation:
  24
  25         $ debug_server -c /etc/send_nsca.cfg
  26
  27 * `disable_notifications`
  28
  29     Globally disables host and service notifications using `send_nsca(8)`.
  30     Example invocation:
  31
  32         $ disable_notifications
  33
  34 * `downtime`
  35
  36     Schedules a host or service downtime using `send_nsca(8)`.  If the `-S`
  37     option is used, a service downtime is scheduled; otherwise, a host
  38     downtime is scheduled.  The start and end times are specified with the
  39     `-s` and `-e` options, respectively.  They accept the same date string
  40     format as GNU `date(1)'s` `-d` option.  Requires GNU `date(1)` or BSD
  41     `date(1)`.  Example invocation (the `-s` and `-e` options could be
  42     omitted here, as these are their default values):
  43
  44         $ downtime -H mail -S IMAP -s now -e +2hours
  45
  46 * `enable_notifications`
  47
  48     Globally enables host and service notifications using `send_nsca(8)`.
  49     Example invocation:
  50
  51         $ enable_notifications
  52
  53 * `invoke_check`
  54
  55     Executes standard plugins and transmits their results using
  56     `send_nsca(8)`.  Example invocation:
  57
  58         $ invoke_check check_disk -w 20% -c 10%
  59
  60 * `nsca-ng.init`
  61
  62     Starts, stops, restarts, or reloads the `nsca-ng(8)` server running on
  63     the local system.  Example invocation:
  64
  65         $ nsca-ng.init start
  66
  67 <!-- vim:set filetype=markdown textwidth=76 joinspaces: -->