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
resource.
SUPPORTED PARAMETERS
- squid_exe
- This is a required parameter. This parameter specifies squid's
executable 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.
(required, string, no default) - squid_pidfile
- This is a required parameter. This parameter specifies a process id file for a squid instance managed by this RA. (required, 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 plural ports are used, you must specifiy the only one of them. (required, integer,
no default) - squid_stop_timeout
- This is an omittable parameter. On a stop action, a normal stop
method is firstly used. and then the confirmation of its completion is awaited for the specified seconds by this parameter. The default value is 10. (optional, integer, default 10) - debug_mode
- This is an optional parameter. This RA runs in debug mode when this
parameter 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 and omittable 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 it's requied, it's made by the following rules: "/var/log/" as a directory part, the basename of the configuration file given by "syslog_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: 60.
- monitor
- Performs a detailed status check. Suggested minimum timeout: 30s.
Suggested interval: 10s. - meta-data
- Retrieves resource agent metadata (internal use only). Suggested
minimum timeout: 5s. - validate-all
- Performs a validation of the resource configuration. Suggested
minimum timeout: 5.
EXAMPLE
- The following is an example configuration for a Squid resource using
the crm(8) shell: - primitive example_Squid ocf:heartbeat:Squid \
params \squid_exe=string \
squid_conf=string \
squid_pidfile=string \
squid_port=integer \op monitor depth="0" timeout="30s" interval="10s"
SEE ALSO
http://www.linux-ha.org/wiki/Squid_(resource_agent)
AUTHOR
- Linux-HA contributors (see the resource agent source for information about individual authors)