1send_nsca.cfg(5) The NSCA-ng Manual send_nsca.cfg(5)
2
6 send_nsca.cfg - NSCA-ng client configuration file
7
9 /etc/send_nsca.cfg
10
12 The send_nsca(8) process reads configuration data from the file speci‐
13 fied with -c on the command line or from /etc/send_nsca.cfg.
14 File Format
16 Configuration settings are defined by specifying a variable name fol‐
17 lowed by an equals sign (“=”) and a value, one setting per line. Val‐
18 ues can be strings or integers. Strings have to be enclosed in single
19 or double quotes if they contain whitespace characters, hash mark char‐
20 acters, or literal quotation marks. Otherwise, quoting is optional.
21 To specify a literal single or double quote in a string, either escape
22 it by preceding it with a backslash (“\”) or quote the string using the
23 other quote character. A literal backslash must be preceded with a
24 second backslash.
25 Any whitespace surrounding tokens is ignored. Empty lines and comments
27 are also ignored. Comments are introduced with a hash mark character
28 (“#”) and span to the end of the line. If the last character of a line
29 is a backslash (“\”), the subsequent line is treated as a continuation
30 of the current line (and the backslash is otherwise ignored).
31 Settings
33 The send_nsca(8) client recognizes the following variables. They may
34 appear in arbitrary order. The type of each value is denoted after an
35 equals sign in angle brackets.
36 delay = <integer>
38 Wait for a random number of seconds between 0 and the specified
39 delay before contacting the server. This might be useful to re‐
40 duce the server load if many send_nsca(8) clients are invoked
41 simultaneously. The default setting is 0, which tells
42 send_nsca(8) to connect to the server immediately. The speci‐
43 fied value will be ignored if send_nsca(8) is called with the -D
44 option.
45 encryption_method = <string>
47 This setting is ignored. It is accepted for compatibility with
48 NSCA 2.x.
49 identity = <string>
51 Send the specified client identity to the server. The client
52 identity is used for authentication and authorization. The same
53 identity may be provided by multiple clients. By default, the
54 local host name will be used.
55 password = <string>
57 Use the specified passphrase for authentication and encryption.
58 The default password is “change-me”. Change it!
59 port = <string>
61 Connect to the specified service name or port number on the
62 server instead of using the default port (5668). The specified
63 value will be ignored if send_nsca(8) is called with the -p op‐
64 tion.
65 server = <string>
67 Connect and talk to the specified server address or host name.
68 The default server is “localhost”. The specified value will be
69 ignored if send_nsca(8) is called with the -H option.
70 timeout = <integer>
72 Close the connection if the server didn't respond for the speci‐
73 fied number of seconds. If the timeout is set to 0,
74 send_nsca(8) won't enforce connection timeouts. The default
75 timeout is 15 seconds. The specified value will be ignored if
76 send_nsca(8) is called with the -o option.
77 tls_ciphers = <string>
79 Limit the cipher suites offered during the TLS negotiation to
80 the specified list of ciphers. The format of the string is de‐
81 scribed in the ciphers(1) manual. By default, the ciphers in
82 the list PSK-AES256-CBC-SHA:PSK-AES128-CBC-SHA:PSK-3DES-EDE-CBC-
83 SHA:PSK-RC4-SHA will be offered.
84
86 The /etc/send_nsca.cfg file might look similar to the following exam‐
87 ple.
88 identity = "web-checker"
90 password = "djMKCIcurJJLSQGT5qIhCfqCHQLTcvp9"
91 server = "monitoring.example.com"
92 tls_ciphers = "PSK-AES256-CBC-SHA"
93 delay = 2
94 port = 5668
95 timeout = 10
96
98 Please set the permissions appropriately to make sure that only autho‐
99 rized users can access the /etc/send_nsca.cfg file.
100
102 send_nsca(8), nsca-ng(8), nsca-ng.cfg(5),
103 http://www.nagios.org/developerinfo/externalcommands/
105
107 Holger Weiss <holger@weiss.in-berlin.de>
108Version 1.6 March 19, 2019 send_nsca.cfg(5)