man/send_nsca.cfg.in

   1 .\" Copyright (c) 2013 Holger Weiss <holger@weiss.in-berlin.de>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions are met:
   6 .\"
   7 .\" 1. Redistributions of source code must retain the above copyright notice,
   8 .\"    this list of conditions and the following disclaimer.
   9 .\"
  10 .\" 2. Redistributions in binary form must reproduce the above copyright notice,
  11 .\"    this list of conditions and the following disclaimer in the documentation
  12 .\"    and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  15 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  18 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24 .\" POSSIBILITY OF SUCH DAMAGE.
  25 .
  26 .TH send_nsca.cfg 5 "@date@" "Version @version@" "The NSCA\-ng Manual"
  27 .
  28 .SH NAME
  29 .
  30 .B send_nsca.cfg
  31 \- NSCA\-ng client configuration file
  32 .
  33 .SH SYNOPSIS
  34 .
  35 .B @sysconfdir@/send_nsca.cfg
  36 .
  37 .SH DESCRIPTION
  38 .
  39 The
  40 .BR send_nsca (8)
  41 process reads configuration data from the file specified with
  42 .B \-c
  43 on the command line or from
  44 .IR @sysconfdir@/send_nsca.cfg .
  45 .
  46 .SS File Format
  47 .
  48 Configuration settings are defined by specifying a variable name
  49 followed by an equals sign (\(lq=\(rq) and a value, one setting per
  50 line.
  51 Values can be strings or integers.
  52 Strings have to be enclosed in single or double quotes if they contain
  53 whitespace characters, hash mark characters, or literal quotation marks.
  54 Otherwise, quoting is optional.
  55 To specify a literal single or double quote in a string, either escape
  56 it by preceding it with a backslash (\(lq\\\(rq) or quote the string
  57 using the other quote character.
  58 A literal backslash must be preceded with a second backslash.
  59 .
  60 .PP
  61 Any whitespace surrounding tokens is ignored.
  62 Empty lines and comments are also ignored.
  63 Comments are introduced with a hash mark character (\(lq#\(rq) and span
  64 to the end of the line.
  65 If the last character of a line is a backslash (\(lq\\\(rq), the
  66 subsequent line is treated as a continuation of the current line (and
  67 the backslash is otherwise ignored).
  68 .
  69 .SS Settings
  70 .
  71 The
  72 .BR send_nsca (8)
  73 client recognizes the following variables.
  74 They may appear in arbitrary order.
  75 The type of each value is denoted after an equals sign in angle
  76 brackets.
  77 .
  78 .TP
  79 \fBdelay\fP\ =\ <\fIinteger\fP>
  80 .
  81 Wait for a random number of seconds between 0 and the specified delay
  82 before contacting the server.
  83 This might be useful to reduce the server load if many
  84 .BR send_nsca (8)
  85 clients are invoked simultaneously.
  86 The default setting is 0, which tells
  87 .BR send_nsca (8)
  88 to connect to the server immediately.
  89 The specified value will be ignored if
  90 .BR send_nsca (8)
  91 is called with the
  92 .B \-D
  93 option.
  94 .
  95 .TP
  96 \fBencryption_method\fP\ =\ <\fIstring\fP>
  97 .
  98 This setting is ignored.
  99 It is accepted for compatibility with
 100 .SM NSCA
 101 2.x.
 102 .
 103 .TP
 104 \fBidentity\fP\ =\ <\fIstring\fP>
 105 .
 106 Send the specified client identity to the server.
 107 The client identity is used for authentication and authorization.
 108 The same identity may be provided by multiple clients.
 109 By default, the local host name will be used.
 110 .
 111 .TP
 112 \fBpassword\fP\ =\ <\fIstring\fP>
 113 .
 114 Use the specified passphrase for authentication and encryption.
 115 The default password is \(lqchange-me\(rq.
 116 Change it!
 117 .
 118 .TP
 119 \fBport\fP\ =\ <\fIstring\fP>
 120 .
 121 Connect to the specified service name or port number on the server
 122 instead of using the default port (5668).
 123 The specified value will be ignored if
 124 .BR send_nsca (8)
 125 is called with the
 126 .B \-p
 127 option.
 128 .
 129 .TP
 130 \fBserver\fP\ =\ <\fIstring\fP>
 131 .
 132 Connect and talk to the specified server address or host name.
 133 The default server is \(lqlocalhost\(rq.
 134 The specified value will be ignored if
 135 .BR send_nsca (8)
 136 is called with the
 137 .B \-H
 138 option.
 139 .
 140 .TP
 141 \fBtimeout\fP\ =\ <\fIinteger\fP>
 142 .
 143 Close the connection if the server didn't respond for the specified
 144 number of seconds.
 145 If the timeout is set to 0,
 146 .BR send_nsca (8)
 147 won't enforce connection timeouts.
 148 The default timeout is 15 seconds.
 149 The specified value will be ignored if
 150 .BR send_nsca (8)
 151 is called with the
 152 .B \-o
 153 option.
 154 .
 155 .TP
 156 \fBtls_ciphers\fP\ =\ <\fIstring\fP>
 157 .
 158 Limit the cipher suites offered during the
 159 .SM TLS
 160 negotiation to the specified list of ciphers.
 161 The format of the string is described in the
 162 .BR ciphers (1)
 163 manual.
 164 By default, the ciphers in the list
 165 .SM \f(CWPSK-AES256-CBC-SHA:PSK-AES128-CBC-SHA:PSK-3DES-EDE-CBC-SHA:PSK-RC4-SHA\fP
 166 will be offered.
 167 .
 168 .SH EXAMPLES
 169 .
 170 The
 171 .B @sysconfdir@/send_nsca.cfg
 172 file might look similar to the following example.
 173 .
 174 .PP
 175 .RS
 176 .nf
 177 .ft CW
 178 .
 179 identity = "web-checker"
 180 password = "djMKCIcurJJLSQGT5qIhCfqCHQLTcvp9"
 181 server = "monitoring.example.com"
 182 tls_ciphers = "PSK-AES256-CBC-SHA"
 183 delay = 2
 184 port = 5668
 185 timeout = 10
 186 .
 187 .ft P
 188 .fi
 189 .RE
 190 .
 191 .SH CAVEATS
 192 .
 193 Please set the permissions appropriately to make sure that only
 194 authorized users can access the
 195 .B @sysconfdir@/send_nsca.cfg
 196 file.
 197 .
 198 .SH "SEE ALSO"
 199 .
 200 .BR send_nsca (8),
 201 .BR nsca\-ng (8),
 202 .BR nsca\-ng.cfg (5),
 203 .
 204 .PP
 205 .I http://www.nagios.org/developerinfo/externalcommands/
 206 .
 207 .SH AUTHOR
 208 .
 209 Holger Weiss <holger@weiss.in-berlin.de>
 210 .
 211 .\" vim:set filetype=nroff textwidth=72: