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

  
 
  

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

NAME
     ocf_heartbeat_Squid - Manages a Squid proxy server instance

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

DESCRIPTION
     The  resource  agent  of  Squid. This manages a Squid instance as an HA re-
     source.

SUPPORTED PARAMETERS
     squid_exe
	 This is a required parameter. This  parameter	specifies  squid's  exe-
	 cutable file.

	 (required, string, no default)

     squid_conf
	 This  is a required parameter. This parameter specifies a configuration
	 file for a squid instance managed by this RA.

	 (unique, required, string, no default)

     squid_opts
	 This is a optional parameter. This parameter specifies  the  start  op-
	 tions.

	 (optional, string, no default)

     squid_pidfile
	 Deprecated - do not use anymore

	 (unique, optional, string, no default)

     squid_port
	 This  is  a  required parameter. This parameter specifies a port number
	 for a squid instance managed by this RA. If multiple  ports  are  used,
	 you must specify only one of them.

	 (unique, required, integer, no default)

     squid_stop_timeout
	 On  stop,  a  squid  shutdown is invoked first. If the resource doesn't
	 stop within this timeout, we resort to stopping  processes  by  sending
	 signals and finally KILLing them.

	 (optional, integer, default 10)

     debug_mode
	 This is an optional parameter. This RA runs in debug mode when this pa-
	 rameter  includes  'x'  or  'v'. If 'x' is included, both of STDOUT and
	 STDERR redirect to the logfile specified by "debug_log", and  then  the
	 builtin shell option 'x' is turned on. It is similar about 'v'.

	 (optional, string, no default)

     debug_log
	 This  is  an optional parameter. This parameter specifies a destination
	 file for debug logs and works only if this RA run in debug mode.  Refer
	 to "debug_mode" about debug mode. If no value is given but is required,
	 it's constructed according to the following rules: "/var/log/" as a di-
	 rectory  part,  the  basename	of the configuration file given by "sys-
	 log_ng_conf" as a basename part, ".log" as a suffix.

	 (optional, string, no default)

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: 30s.  Sug-
	 gested interval: 10s.

     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 Squid resource using the
     crm(8) shell:

	 primitive p_Squid ocf:heartbeat:Squid \
	   params \
	     squid_exe=string \
	     squid_conf=string \
	     squid_port=integer \
	   op monitor depth="0" timeout="30s" interval="10s"

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

	 pcs resource create p_Squid ocf:heartbeat:Squid \
	   squid_exe=string \
	   squid_conf=string \
	   squid_port=integer \
	   op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="10s"

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_SQUID(7)

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

home | help