1send_nsca(8) The NSCA-ng Manual send_nsca(8)
2
6 send_nsca - send monitoring commands to NSCA-ng server
7
9 send_nsca [-CSstv] [-c file] [-D delay] [-d delimiter] [-e separator]
10 [-H server] [-o timeout] [-p port]
11 send_nsca -h | -V
13
15 The send_nsca utility transmits one or more check results or monitoring
16 commands to an nsca-ng(8) server. The communication with the server is
17 TLS encrypted and authenticated using pre-shared keys (as per RFC
18 4279). By default, send_nsca reads host or service check results from
19 the standard input. Multiple check results must be separated with an
20 ASCII ETB character (octal value: 27). Service check results are ex‐
21 pected to be in the following format:
22 host[tab]service[tab]status[tab]message[newline]
24 where host and service are the host name and service description as
26 configured in Nagios, status is the numeric return code, and message is
27 the output string. Host check results are expected to be in the same
28 format, just without the service description:
29 host[tab]status[tab]message[newline]
31 Note that multiline messages are supported.
33
35 -C Instead of accepting host or service check results in the format
36 described above, read “raw” monitoring commands for submission
37 to the Nagios command file from the standard input, one command
38 per line. The commands are expected to be in the format de‐
39 scribed in the Nagios documentation; except that the leading
40 bracketed timestamp may be omitted, in which case the current
41 timestamp is prepended to the provided command by send_nsca.
42 -c file
44 Read the configuration from the specified file instead of using
45 the default configuration file /etc/send_nsca.cfg.
46 -D delay
48 Wait for a random number of seconds between 0 and the specified
49 delay before contacting the server. This might be useful to re‐
50 duce the server load if many send_nsca clients are invoked si‐
51 multaneously. The default setting is 0, which tells send_nsca
52 to connect to the server immediately. If this option is speci‐
53 fied, the delay setting in the send_nsca.cfg(5) file is ignored.
54 -d delimiter
56 Use the specified delimiter instead of a horizontal tab to sepa‐
57 rate the fields when parsing host or service check results. The
58 delimiter must be a single character, a C-style backslash escape
59 sequence, the octal value of a character with a leading zero, or
60 the hexadecimal value of a character prefixed with “0x”. Any
61 ASCII character other than a backslash, newline, ETB, or NUL is
62 allowed. This option is ignored if the -C option is specified.
63 -e separator
65 Use the specified separator instead of an ASCII ETB character to
66 separate multiple host or service check results. The separator
67 must be a single character, a C-style backslash escape sequence,
68 the octal value of a character with a leading zero, or the hexa‐
69 decimal value of a character prefixed with “0x”. Any ASCII
70 character is allowed, but note that multiline check result mes‐
71 sages cannot be submitted if a newline character is used. This
72 option is ignored if the -C option is specified.
73 -H server
75 Connect and talk to the specified server address or host name.
76 By default, send_nsca attempts to communicate with “localhost”.
77 This option takes precedence over the server setting in the
78 send_nsca.cfg(5) file.
79 -h Print usage information to the standard output and exit.
81 -o timeout
83 Close the connection if the server didn't respond for the speci‐
84 fied number of seconds. If the timeout is set to 0, send_nsca
85 won't enforce connection timeouts. The default timeout is 15
86 seconds. This option is provided for compatibility with NSCA
87 2.x. If it's specified, the timeout setting in the
88 send_nsca.cfg(5) file is ignored.
89 -p port
91 Connect to the specified service name or port number instead of
92 using the default port (5668). This option takes precedence
93 over the port setting in the send_nsca.cfg(5) file.
94 -S Write all messages to the standard error output. This is the
96 default behaviour.
97 -s Send all messages (except for usage errors) to the system log‐
99 ger. This option may be combined with the -S option.
100 -t This option is ignored. It is accepted for compatibility with
102 NSCA 2.x.
103 -V Print version information to the standard output and exit.
105 -v Generate a message for each check result or monitoring command
107 sent to the nsca-ng(8) server. This option can be specified up
108 to three times in order to increase the verbosity.
109
111 The send_nsca utility exits 0 on success, and >0 if an error occurs.
112
114 /etc/send_nsca.cfg
115 The send_nsca.cfg(5) configuration file.
116
118 send_nsca.cfg(5), nsca-ng(8), nsca-ng.cfg(5)
119 http://www.nagios.org/developerinfo/externalcommands/
121
123 Holger Weiss <holger@weiss.in-berlin.de>
124Version 1.6 March 19, 2019 send_nsca(8)