'\" t
.\"     Title: ocf_heartbeat_pound
.\"    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_POUND" "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_pound \- Manage a Pound instance
.SH "SYNOPSIS"
.HP \w'\fBpound\fR\ 'u
\fBpound\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
The Pound Resource Agent can manage Pound instances\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBconfig\fR
.RS 4
The Pound configuration file that Pound should manage, for example "/etc/pound\&.cfg"\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBname\fR
.RS 4
Override the name of the instance that should be given to Pound (defaults to the resource identifier)\&.
.sp
(unique, optional, string, default "RESOURCE_ID")
.RE
.PP
\fBpid\fR
.RS 4
Write the process\*(Aqs PID to the specified file\&. The default will include the specified name, i\&.e\&.: "/var/run/pound_production\&.pid"\&. Unlike what this help message shows, it is most likely not necessary to change this parameter\&.
.sp
(unique, optional, string, default "/var/run/pound_RESOURCE_ID\&.pid")
.RE
.PP
\fBbinary\fR
.RS 4
This is used to start Pound server\&. Normally use pound\&.
.sp
(optional, string, default "pound")
.RE
.PP
\fBctl_binary\fR
.RS 4
This is used to watch Pound status via Unix socket\&. Normally use poundctl\&.
.sp
(optional, string, default "poundctl")
.RE
.PP
\fBsocket_path\fR
.RS 4
Write the process\*(Aqs Unix socket\&. This parameter is same \*(AqControl\*(Aq parameter in configuration file, i\&.e\&.: Control "/var/lib/pound/pound\&.cfg"\&.
.sp
(optional, string, default "/var/lib/pound/pound\&.cfg")
.RE
.PP
\fBmaxfiles\fR
.RS 4
Determines how many files pound is allowed to open at a time\&. Helps to fix the \*(AqToo many open files\*(Aq error message\&.
.sp
(optional, integer, no default)
.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
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 20\&.
.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: 20\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a pound resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_pound ocf:heartbeat:pound \e
  params \e
    config=\fIstring\fR \e
  op monitor timeout="20" interval="10" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a pound resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_pound ocf:heartbeat:pound \e
  config=\fIstring\fR \e
  op monitor timeout="20" interval="10" depth="0" 
.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