'\" t
.\"     Title: ocf_heartbeat_anything
.\"    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_ANYTHI" "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_anything \- Manages an arbitrary service
.SH "SYNOPSIS"
.HP \w'\fBanything\fR\ 'u
\fBanything\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This is a generic OCF RA to manage almost anything\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBbinfile\fR
.RS 4
The full name of the binary to be executed\&. This is expected to keep running with the same pid and not just do something and exit\&.
.sp
(required, string, no default)
.RE
.PP
\fBcmdline_options\fR
.RS 4
Command line options to pass to the binary
.sp
(optional, string, no default)
.RE
.PP
\fBworkdir\fR
.RS 4
The path from where the binfile will be executed\&.
.sp
(optional, string, no default)
.RE
.PP
\fBpidfile\fR
.RS 4
File to read/write the PID from/to\&.
.sp
(optional, string, default "/var/run/anything_RESOURCE_ID\&.pid")
.RE
.PP
\fBlogfile\fR
.RS 4
File to write STDOUT to
.sp
(optional, string, default "/dev/null")
.RE
.PP
\fBerrlogfile\fR
.RS 4
File to write STDERR to
.sp
(optional, string, no default)
.RE
.PP
\fBuser\fR
.RS 4
User to run the command as
.sp
(optional, string, default "root")
.RE
.PP
\fBmonitor_hook\fR
.RS 4
Command to run in monitor operation
.sp
(optional, string, no default)
.RE
.PP
\fBstop_timeout\fR
.RS 4
In the stop operation: Seconds to wait for kill \-TERM to succeed before sending kill \-SIGKILL\&. Defaults to 2/3 of the stop operation timeout\&.
.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: 10s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a anything resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_anything ocf:heartbeat:anything \e
  params \e
    binfile=\fIstring\fR \e
  op monitor depth="0" timeout="20s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a anything resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_anything ocf:heartbeat:anything \e
  binfile=\fIstring\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="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