Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
OCF_HEARTBEAT_SYSLOG(7)        OCF resource agents	 OCF_HEARTBEAT_SYSLOG(7)

NAME
     ocf_heartbeat_syslog-ng - Syslog-ng resource agent

SYNOPSIS
     syslog-ng [start | stop | status | monitor | meta-data | validate-all]

DESCRIPTION
     This script manages a syslog-ng instance as an HA resource.

     For  Premium  Edition you should set the following parameters (based on de-
     fault    path    being    "/opt/syslog-ng"):    syslog_ng_binary="/opt/sys-
     log-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/sys-
     log-ng/var/syslog-ng.persist"	    pidfile="/opt/syslog-ng/var/run/sys-
     log-ng.pid"

     Additional  parameter  for  Premium  Edition  6  only: qdisk_dir="/opt/sys-
     log-ng/var/"

SUPPORTED PARAMETERS
     configfile
	 This parameter specifies a configuration file for a syslog-ng	instance
	 managed by this RA.

	 (required, string, no default)

     syslog_ng_binary
	 This parameter specifies syslog-ng's executable file.

	 (optional, string, default "/sbin/syslog-ng")

     syslog_ng_ctl
	 This parameter specifies the path of the syslog-ng-ctl executable file.

	 (optional, string, default "/sbin/syslog-ng-ctl")

     qdisk_dir
	 This parameter specifies the directory used for holding disk buffers of
	 syslog-ng (only supported in Premium Edition 6).

	 (optional, string, no default)

     control_file
	 This parameter specifies the path, where syslog-ng would place its con-
	 trol socket, through which it can be controlled.

	 (optional, string, no default)

     persist_file
	 This  parameter  specifies the path for syslog-ng's persist file, which
	 holds persistent information about the mapping of destinations and disk
	 buffers, the internal state of sources, etc.

	 (optional, string, no default)

     pidfile
	 This parameter specifies the path where the pid file of  syslog-ng  re-
	 sides.

	 (optional, string, no default)

     start_opts
	 This  parameter specifies startup options for a syslog-ng instance man-
	 aged by this RA. When no value is given, no startup  options  is  used.
	 Don't use option '-F'. It causes a stuck of a start action.

	 (optional, string, no default)

     kill_term_timeout
	 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.

	 (optional, integer, default 10)

SUPPORTED ACTIONS
     This resource agent supports the following actions (operations):

     start
	 Starts the resource. Suggested minimum timeout: 60s.

     stop
	 Stops the resource. Suggested minimum timeout: 120s.

     status
	 Performs a status check. Suggested minimum timeout: 60s.

     monitor
	 Performs a detailed status check. Suggested minimum timeout: 60s.  Sug-
	 gested interval: 60s.

     meta-data
	 Retrieves  resource agent metadata (internal use only). Suggested mini-
	 mum timeout: 5s.

     validate-all
	 Performs a validation of the resource configuration. Suggested  minimum
	 timeout: 5s.

EXAMPLE CRM SHELL
     The  following  is  an example configuration for a syslog-ng resource using
     the crm(8) shell:

	 primitive p_syslog-ng ocf:heartbeat:syslog-ng \
	   params \
	     configfile=string \
	   op monitor depth="0" timeout="60s" interval="60s"

EXAMPLE PCS
     The following is an example configuration for a  syslog-ng  resource  using
     pcs(8)

	 pcs resource create p_syslog-ng ocf:heartbeat:syslog-ng \
	   configfile=string \
	   op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="60s"

SEE ALSO
     http://clusterlabs.org/

AUTHOR
     ClusterLabs  contributors	(see  the  resource agent source for information
     about individual authors)

resource-agents 4.13.0		   08/27/2026		 OCF_HEARTBEAT_SYSLOG(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ocf_heartbeat_syslog-ng&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>

home | help