'\" t
.\"     Title: ocf_heartbeat_syslog-ng
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_SYSLOG" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "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_syslog-ng \- Syslog\-ng resource agent
.SH "SYNOPSIS"
.HP \w'\fBsyslog\-ng\fR\ 'u
\fBsyslog\-ng\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This script manages a syslog\-ng instance as an HA resource\&.
.PP
For Premium Edition you should set the following parameters (based on default path being "/opt/syslog\-ng"): syslog_ng_binary="/opt/syslog\-ng/sbin/syslog\-ng" syslog_ng_ctl="/opt/syslog\-ng/sbin/syslog\-ng\-ctl" control_file="/opt/syslog\-ng/var/run/syslog\-ng\&.ctl" persist_file="/opt/syslog\-ng/var/syslog\-ng\&.persist" pidfile="/opt/syslog\-ng/var/run/syslog\-ng\&.pid"
.PP
Additional parameter for Premium Edition 6 only: qdisk_dir="/opt/syslog\-ng/var/"
.SH "SUPPORTED PARAMETERS"
.PP
\fBconfigfile\fR
.RS 4
This parameter specifies a configuration file for a syslog\-ng instance managed by this RA\&.
.sp
(required, string, no default)
.RE
.PP
\fBsyslog_ng_binary\fR
.RS 4
This parameter specifies syslog\-ng\*(Aqs executable file\&.
.sp
(optional, string, default "/sbin/syslog\-ng")
.RE
.PP
\fBsyslog_ng_ctl\fR
.RS 4
This parameter specifies the path of the syslog\-ng\-ctl executable file\&.
.sp
(optional, string, default "/sbin/syslog\-ng\-ctl")
.RE
.PP
\fBqdisk_dir\fR
.RS 4
This parameter specifies the directory used for holding disk buffers of syslog\-ng (only supported in Premium Edition 6)\&.
.sp
(optional, string, no default)
.RE
.PP
\fBcontrol_file\fR
.RS 4
This parameter specifies the path, where syslog\-ng would place its control socket, through which it can be controlled\&.
.sp
(optional, string, no default)
.RE
.PP
\fBpersist_file\fR
.RS 4
This parameter specifies the path for syslog\-ng\*(Aqs persist file, which holds persistent information about the mapping of destinations and disk buffers, the internal state of sources, etc\&.
.sp
(optional, string, no default)
.RE
.PP
\fBpidfile\fR
.RS 4
This parameter specifies the path where the pid file of syslog\-ng resides\&.
.sp
(optional, string, no default)
.RE
.PP
\fBstart_opts\fR
.RS 4
This parameter specifies startup options for a syslog\-ng instance managed by this RA\&. When no value is given, no startup options is used\&. Don\*(Aqt use option \*(Aq\-F\*(Aq\&. It causes a stuck of a start action\&.
.sp
(optional, string, no default)
.RE
.PP
\fBkill_term_timeout\fR
.RS 4
On a stop action, a normal stop method(pkill \-TERM) is firstly used\&. And then the confirmation of its completion is waited for the specified seconds by this parameter\&. The default value is 10\&.
.sp
(optional, integer, default
10)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 60s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 120s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 60s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 60s\&. Suggested interval: 60s\&.
.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 syslog\-ng resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_syslog\-ng ocf:heartbeat:syslog\-ng \e
  params \e
    configfile=\fIstring\fR \e
  op monitor depth="0" timeout="60s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a syslog\-ng resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_syslog\-ng ocf:heartbeat:syslog\-ng \e
  configfile=\fIstring\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="60s" 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