ocf_heartbeat_Squid(7)

1OCF_HEARTBEAT_SQUID(7)        OCF resource agents       OCF_HEARTBEAT_SQUID(7)
2
3
4

NAME

6       ocf_heartbeat_Squid - Manages a Squid proxy server instance
7

SYNOPSIS

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

DESCRIPTION

12       The resource agent of Squid. This manages a Squid instance as an HA
13       resource.
14

SUPPORTED PARAMETERS

16       squid_exe
17           This is a required parameter. This parameter specifies squid's
18           executable file.  (required, string, no default)
19
20       squid_conf
21           This is a required parameter. This parameter specifies a
22           configuration file for a squid instance managed by this RA.
23           (unique, required, string, no default)
24
25       squid_pidfile
26           This is a required parameter. This parameter specifies a process id
27           file for a squid instance managed by this RA.  (unique, required,
28           string, no default)
29
30       squid_port
31           This is a required parameter. This parameter specifies a port
32           number for a squid instance managed by this RA. If plural ports are
33           used, you must specifiy the only one of them.  (unique, required,
34           integer, no default)
35
36       squid_stop_timeout
37           This is an omittable parameter. On a stop action, a normal stop
38           method is firstly used. and then the confirmation of its completion
39           is awaited for the specified seconds by this parameter. The default
40           value is 10.  (optional, integer, default 10)
41
42       debug_mode
43           This is an optional parameter. This RA runs in debug mode when this
44           parameter includes 'x' or 'v'. If 'x' is included, both of STDOUT
45           and STDERR redirect to the logfile specified by "debug_log", and
46           then the builtin shell option 'x' is turned on. It is similar about
47           'v'.  (optional, string, no default)
48
49       debug_log
50           This is an optional and omittable parameter. This parameter
51           specifies a destination file for debug logs and works only if this
52           RA run in debug mode. Refer to "debug_mode" about debug mode. If no
53           value is given but it's requied, it's made by the following rules:
54           "/var/log/" as a directory part, the basename of the configuration
55           file given by "syslog_ng_conf" as a basename part, ".log" as a
56           suffix.  (optional, string, no default)
57

SUPPORTED ACTIONS

59       This resource agent supports the following actions (operations):
60
61       start
62           Starts the resource. Suggested minimum timeout: 60s.
63
64       stop
65           Stops the resource. Suggested minimum timeout: 120s.
66
67       status
68           Performs a status check. Suggested minimum timeout: 60.
69
70       monitor
71           Performs a detailed status check. Suggested minimum timeout: 30s.
72           Suggested interval: 10s.
73
74       meta-data
75           Retrieves resource agent metadata (internal use only). Suggested
76           minimum timeout: 5s.
77
78       validate-all
79           Performs a validation of the resource configuration. Suggested
80           minimum timeout: 5.
81

EXAMPLE

83       The following is an example configuration for a Squid resource using
84       the crm(8) shell:
85
86           primitive p_Squid ocf:heartbeat:Squid \
87             params \
88               squid_exe=string \
89               squid_conf=string \
90               squid_pidfile=string \
91               squid_port=integer \
92             op monitor depth="0" timeout="30s" interval="10s"
93

AUTHOR

98       Linux-HA contributors (see the resource agent source for information
99       about individual authors)
100
101
102
103resource-agents 3.9.2             07/08/2011            OCF_HEARTBEAT_SQUID(7)