.TH check_remote_by_udp 1 "November 2011" "ngtx"


.SH NAME
check_remote_by_udp \- nagios plugin for getting remote values by udp
.SH SYNOPSIS
.B check_remote_by_udp
[
.B \-L
]
[
.B \-A(0|1|2|3|4)
]
[
.B \-W
.I warnlevellow
]
[
.B \-C
.I critlevellow
]
.B \-w
.I warnlevel
.B \-c
.I critlevel
.B \-H
.I ip-address
.B \-p
.I port
[
.B \-t
.I timeout
]
[
.B \-u
.I unit
]
.B key
.br


.SH DESCRIPTION
.B check_remote_by_udp
is a nagios plugin for remote checking hosts by udp.
It was written as a (fast) alternative to net-snmp and it is designed
to work with
.B knoerred,
a small and fast udp-server.
.br
.B check_remote_by_udp
sends the given key with a LF to the remote server.
Then it expects a value as a result of the remote check.
It takes the numeric value from the last line of the remote udp response.
The value will be interpreted as a positive integer with up to 64 bits.
.br
If the remote value is greater than the specified warning or critical level then
.B check_remote_by_udp
will also recognize the line before and print it contents as additional data.
This additional or debug information is printed between the remote value and the
performance data.
.br


.SH OPTIONS

.TP
.B \-w warnlevel
Specify the warning level.
The remote value must be greater than the warnlevel to trigger.

.TP
.B \-W warnlevellow
Specify the warning low level.
The remote value must be less than warnlevellow to trigger.

.TP
.B \-c critlevel
Specify the critical level.
The remote value must be greater than the critlevel to trigger.

.TP
.B \-C critlevellow
Specify the critical low level.
The remote value must be less than the critlevellow to trigger.

.TP
.B \-H ip-address
Specify the IP address of the remote server to check.

.TP
.B \-p port
Specify the port of the udp server on the remote host.

.TP
.B \-u unit
Specify an optional unit string which is placed after the remote value and which is visible in nagios.

.TP
.B \-t timeout
The plugins internal timeout in seconds (default: 10).

.TP
.B \-L
Show additional data as link.

.TP
.B \-A(0|1|2|3|4)
Specify the level of the remote value which must be reached to
print the additional data. "-A0" causes printing if state is
"OK" and "-A4" will disable printing. "-A1" is currently the
default setting.


.SH "RETURN VALUE"
According to the Nagios Plugin API the Return Code is 0 for
state "OK", 1 for "WARNING", 2 for "CRITICAL" and "3" for
"UNKNOWN".


.SH FILES
.B check_remote_by_udp
does not use any files, but a sample nagios config is shown here:

.RS
# cat /etc/nagios/msc.cfg
.br
define service{
.br
  use                             service-1min
.br
  name                            load1
.br
  check_command                   check_remote_generic!8!20!load1
.br
  register                        0
.br
}
.br
# cat /etc/nagios/remote-generic.cfg
.br
define command{
.br
  command_name    check_remote_generic
.br
  command_line    $USER1$/check_remote_by_udp -w $ARG1$ -c $ARG2$ -H $HOSTADDRESS$ -p 8888 $ARG3$
.br
}
.RE


.SH "SEE ALSO"
.B check_remote_by_http(1),
.B knoerred(1),
.B knoerre(1)
.br
http://downloads.tuxad.de/ngtx


.SH AUTHOR
Frank Bergmann, udp://www.tuxad.com