'\" t
.\"     Title: ocf_heartbeat_ClusterMon
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 06/07/2017
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.0.0~rc1-4~bpo8+1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_CLUSTE" "7" "06/07/2017" "resource-agents 4.0.0~rc1-4~bp" "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_ClusterMon \- Runs crm_mon in the background, recording the cluster status to an HTML file
.SH "SYNOPSIS"
.HP \w'\fBClusterMon\fR\ 'u
\fBClusterMon\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This is a ClusterMon Resource Agent\&. It outputs current cluster status to the html\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBuser\fR
.RS 4
The user we want to run crm_mon as
.sp
(optional, string, default "root")
.RE
.PP
\fBupdate\fR
.RS 4
How frequently should we update the cluster status
.sp
(optional, integer, default
15)
.RE
.PP
\fBextra_options\fR
.RS 4
Additional options to pass to crm_mon\&. Eg\&. \-n \-r
.sp
(optional, string, no default)
.RE
.PP
\fBpidfile\fR
.RS 4
PID file location to ensure only one instance is running
.sp
(unique, optional, string, default "/tmp/ClusterMon_RESOURCE_ID\&.pid")
.RE
.PP
\fBhtmlfile\fR
.RS 4
Location to write HTML output to\&.
.sp
(unique, optional, string, default "/tmp/ClusterMon_RESOURCE_ID\&.html")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 20\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20\&. Suggested interval: 10\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 30\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a ClusterMon resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_ClusterMon ocf:heartbeat:ClusterMon \e
  op monitor depth="0" timeout="20" interval="10" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a ClusterMon resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_ClusterMon ocf:heartbeat:ClusterMon \e
  op monitor depth="0" timeout="20" interval="10" 
.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