'\" t
.\"     Title: ocf_heartbeat_Pure-FTPd
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/13/2023
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.12.0-2
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_PURE\-" "7" "04/13/2023" "resource-agents 4.12.0-2" "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_Pure-FTPd \- Manages a Pure\-FTPd FTP server instance
.SH "SYNOPSIS"
.HP \w'\fBPure\-FTPd\fR\ 'u
\fBPure\-FTPd\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This script manages Pure\-FTPd in an Active\-Passive setup
.SH "SUPPORTED PARAMETERS"
.PP
\fBscript\fR
.RS 4
The full path to the Pure\-FTPd startup script\&. For example, "/sbin/pure\-config\&.pl"
.sp
(unique, optional, string, default "/sbin/pure\-config\&.pl")
.RE
.PP
\fBconffile\fR
.RS 4
The Pure\-FTPd configuration file name with full path\&. For example, "/etc/pure\-ftpd/pure\-ftpd\&.conf"
.sp
(unique, optional, string, default "/etc/pure\-ftpd/pure\-ftpd\&.conf")
.RE
.PP
\fBdaemon_type\fR
.RS 4
The Pure\-FTPd daemon to be called by pure\-ftpd\-wrapper\&. Valid options are "" for pure\-ftpd, "mysql" for pure\-ftpd\-mysql, "postgresql" for pure\-ftpd\-postgresql and "ldap" for pure\-ftpd\-ldap
.sp
(unique, optional, string, no default)
.RE
.PP
\fBpidfile\fR
.RS 4
PID file
.sp
(optional, string, default "/run/resource\-agents/pure\-ftpd\-RESOURCE_ID\&.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
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 60s\&.
.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: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a Pure\-FTPd resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_Pure\-FTPd ocf:heartbeat:Pure\-FTPd \e
  op monitor depth="0" timeout="20s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a Pure\-FTPd resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_Pure\-FTPd ocf:heartbeat:Pure\-FTPd \e
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s" 
.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