'\" t
.\"     Title: ocf_heartbeat_proftpd
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 12/17/2020
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_PROFTP" "7" "12/17/2020" "resource-agents UNKNOWN" "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_proftpd \- OCF Resource Agent compliant FTP script\&.
.SH "SYNOPSIS"
.HP \w'\fBproftpd\fR\ 'u
\fBproftpd\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This script manages Proftpd in an Active\-Passive setup
.SH "SUPPORTED PARAMETERS"
.PP
\fBbinary\fR
.RS 4
The Proftpd binary
.sp
(optional, string, default "/usr/sbin/proftpd")
.RE
.PP
\fBconffile\fR
.RS 4
The Proftpd configuration file name with full path\&. For example, "/etc/proftpd\&.conf"
.sp
(optional, string, default "/etc/proftpd\&.conf")
.RE
.PP
\fBpidfile\fR
.RS 4
The Proftpd PID file\&. The location of the PID file is configured in the Proftpd configuration file\&.
.sp
(optional, string, default "/var/run/proftpd\&.pid")
.RE
.PP
\fBcurl_binary\fR
.RS 4
The absolute path to the curl binary for monitoring with OCF_CHECK_LEVEL greater zero\&.
.sp
(optional, string, default "/usr/bin/curl")
.RE
.PP
\fBcurl_url\fR
.RS 4
The URL which is checked by curl with OCF_CHECK_LEVEL greater zero\&.
.sp
(optional, string, default "ftp://localhost/")
.RE
.PP
\fBtest_user\fR
.RS 4
The name of the ftp user for monitoring with OCF_CHECK_LEVEL greater zero\&.
.sp
(optional, string, default "test")
.RE
.PP
\fBtest_pass\fR
.RS 4
The password of the ftp user for monitoring with OCF_CHECK_LEVEL greater zero\&.
.sp
(optional, string, 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: 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
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 120s\&.
.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 proftpd resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_proftpd ocf:heartbeat:proftpd \e
  op monitor depth="0" timeout="20s" interval="60s" \e
  op monitor depth="10" timeout="20s" interval="120s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a proftpd resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_proftpd ocf:heartbeat:proftpd \e
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s" \e
  op monitor OCF_CHECK_LEVEL="10" timeout="20s" interval="120s" 
.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