summaryrefslogtreecommitdiffstats
path: root/debian/nrpe.8
blob: 67e280c47b361ec8000276115e2b1bc58f5e8f86 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH NAGIOS-NRPE 8 "January 14, 2004"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
nrpe \- Nagios Remote Plugin Executor - Server
.SH SYNOPSIS
.B nagios-nrpe
\fI[-n] -c <config_file> [-4|-6] <mode>\fR
.SH DESCRIPTION
.PP
The purpose of this addon is to allow you to execute Nagios plugins on a
remote host in as transparent a manner as possible.
.PP
This program runs as a background process on the remote host and processes
command execution requests from the check_nrpe plugin on the Nagios host.
.SH OPTIONS
.TP
\fB\-n\fR               = Do not use SSL
.TP
\fB\-c\fR <config_file> = Name of config file to use
.TP
\fB\-4\fR               = Use IPv4 only
.TP
\fB\-6\fR               = Use IPv6 only
.TP
<mode>           = One of the following two operating modes:
.TP
  \fB\-i\fR             =    Run as a service under inetd or xinetd
.TP
  \fB\-d\fR             =    Run as a standalone daemon
.TP
  \fB\-d \-s\fR          =    Run as a subsystem under AIX
.TP
  \fB\-f\fR             =    Don't fork() for systemd, launchd, etc.
.PP
Notes:
This program is designed to process requests from the check_nrpe
plugin on the host(s) running Nagios.  It can run as a service
under inetd or xinetd (read the docs for info on this), or as a
standalone daemon. Once a request is received from an authorized
host, NRPE will execute the command/plugin (as defined in the
config file) and return the plugin output and return code to the
check_nrpe plugin.
.SH AUTHOR
This manual page was written by Jason Thomas <jason@debian.org>,
for the Debian project (but may be used by others).