ocf_heartbeat_dovecot(7)

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

NAME

6       ocf_heartbeat_dovecot - Manages a highly available Dovecot IMAP/POP3
7       server instance
8

SYNOPSIS

10       dovecot [start | stop | monitor | meta-data | validate-all]
11

DESCRIPTION

13       This script manages Dovecot as an OCF resource in a high-availability
14       setup.
15

SUPPORTED PARAMETERS

17       binary
18           Full path to the Dovecot binary. For example, "/usr/sbin/dovecot".
19
20           (optional, string, default "/usr/sbin/dovecot")
21
22       config_file
23           Full path to a Dovecot configuration file. For example,
24           "/etc/dovecot/dovecot.conf".
25
26           (unique, optional, string, no default)
27
28       pid_file
29           Full path to a Dovecot PID file. For example,
30           "/var/run/dovecot/master.pid".
31
32           (unique, optional, string, default "/var/run/dovecot/master.pid")
33
34       parameters
35           The Dovecot daemon may be called with additional parameters.
36           Specify any of them here.
37
38           (optional, string, no default)
39

SUPPORTED ACTIONS

41       This resource agent supports the following actions (operations):
42
43       start
44           Starts the resource. Suggested minimum timeout: 20s.
45
46       stop
47           Stops the resource. Suggested minimum timeout: 20s.
48
49       reload
50           Suggested minimum timeout: 20s.
51
52       monitor
53           Performs a detailed status check. Suggested minimum timeout: 20s.
54           Suggested interval: 60s.
55
56       validate-all
57           Performs a validation of the resource configuration. Suggested
58           minimum timeout: 20s.
59
60       meta-data
61           Retrieves resource agent metadata (internal use only). Suggested
62           minimum timeout: 5s.
63

EXAMPLE CRM SHELL

65       The following is an example configuration for a dovecot resource using
66       the crm(8) shell:
67
68           primitive p_dovecot ocf:heartbeat:dovecot \
69             op monitor depth="0" timeout="20s" interval="60s"
70

EXAMPLE PCS

72       The following is an example configuration for a dovecot resource using
73       pcs(8)
74
75           pcs resource create p_dovecot ocf:heartbeat:dovecot \
76             op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s"
77

AUTHOR

82       ClusterLabs contributors (see the resource agent source for information
83       about individual authors)
84
85
86
87resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_DOVECO(7)