'\" t
.\"     Title: ocf_heartbeat_nagios
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_NAGIOS" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_nagios \- Nagios resource agent
.SH "SYNOPSIS"
.HP \w'\fBnagios\fR\ 'u
\fBnagios\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
OCF Resource script for Nagios 3\&.x or 4\&.x\&. It manages a Nagios instance as a HA resource\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBuser\fR
.RS 4
User running Nagios daemon (for file permissions)
.sp
(optional, string, default "nagios")
.RE
.PP
\fBgroup\fR
.RS 4
Group running Nagios daemon (for file permissions)
.sp
(optional, string, default "nagios")
.RE
.PP
\fBbinary\fR
.RS 4
Location of the Nagios binary
.sp
(optional, string, default "/usr/sbin/nagios")
.RE
.PP
\fBconfig\fR
.RS 4
Configuration file
.sp
(optional, string, default "/etc/nagios/nagios\&.cfg")
.RE
.PP
\fBlog\fR
.RS 4
Location of the Nagios log
.sp
(optional, string, default "/var/log/nagios/nagios\&.log")
.RE
.PP
\fBretention\fR
.RS 4
Location of the Nagios retention file
.sp
(optional, string, default "/var/log/nagios/retention\&.dat")
.RE
.PP
\fBcommand\fR
.RS 4
Location of the Nagios external command file
.sp
(optional, string, default "/var/log/nagios/rw/nagios\&.cmd")
.RE
.PP
\fBpid\fR
.RS 4
Location of the Nagios pid/lock
.sp
(optional, string, default "/var/run/nagios\&.pid")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a nagios resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_nagios ocf:heartbeat:nagios \e
  op monitor depth="0" timeout="20s" interval="10s" start\-delay="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a nagios resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_nagios ocf:heartbeat:nagios \e
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s" start\-delay="10s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR