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.
19
20           (required, string, no default)
21
22       squid_conf
23           This is a required parameter. This parameter specifies a
24           configuration file for a squid instance managed by this RA.
25
26           (unique, required, string, no default)
27
28       squid_pidfile
29           This is a required parameter. This parameter specifies a process id
30           file for a squid instance managed by this RA.
31
32           (unique, required, string, no default)
33
34       squid_port
35           This is a required parameter. This parameter specifies a port
36           number for a squid instance managed by this RA. If plural ports are
37           used, you must specifiy the only one of them.
38
39           (unique, required, integer, no default)
40
41       squid_stop_timeout
42           On stop, a squid shutdown is invoked first. If the resource doesn´t
43           stop within this timeout, we resort to stopping processes by
44           sending signals and finally KILLing them.
45
46           (optional, integer, default 10)
47
48       debug_mode
49           This is an optional parameter. This RA runs in debug mode when this
50           parameter includes ´x´ or ´v´. If ´x´ is included, both of STDOUT
51           and STDERR redirect to the logfile specified by "debug_log", and
52           then the builtin shell option ´x´ is turned on. It is similar about
53           ´v´.
54
55           (optional, string, no default)
56
57       debug_log
58           This is an optional and omittable parameter. This parameter
59           specifies a destination file for debug logs and works only if this
60           RA run in debug mode. Refer to "debug_mode" about debug mode. If no
61           value is given but it´s requied, it´s made by the following rules:
62           "/var/log/" as a directory part, the basename of the configuration
63           file given by "syslog_ng_conf" as a basename part, ".log" as a
64           suffix.
65
66           (optional, string, no default)
67

SUPPORTED ACTIONS

69       This resource agent supports the following actions (operations):
70
71       start
72           Starts the resource. Suggested minimum timeout: 60s.
73
74       stop
75           Stops the resource. Suggested minimum timeout: 120s.
76
77       status
78           Performs a status check. Suggested minimum timeout: 60.
79
80       monitor
81           Performs a detailed status check. Suggested minimum timeout: 30s.
82           Suggested interval: 10s.
83
84       meta-data
85           Retrieves resource agent metadata (internal use only). Suggested
86           minimum timeout: 5s.
87
88       validate-all
89           Performs a validation of the resource configuration. Suggested
90           minimum timeout: 5.
91

EXAMPLE

93       The following is an example configuration for a Squid resource using
94       the crm(8) shell:
95
96           primitive p_Squid ocf:heartbeat:Squid \
97             params \
98               squid_exe=string \
99               squid_conf=string \
100               squid_pidfile=string \
101               squid_port=integer \
102             op monitor depth="0" timeout="30s" interval="10s"
103

AUTHOR

108       Linux-HA contributors (see the resource agent source for information
109       about individual authors)
110
111
112
113resource-agents 3.9.2             03/24/2017            OCF_HEARTBEAT_SQUID(7)