ocf_heartbeat_MailTo(7)

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

NAME

6       ocf_heartbeat_MailTo - Notifies recipients by email in the event of
7       resource takeover
8

SYNOPSIS

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

DESCRIPTION

13       This is a resource agent for MailTo. It sends email to a sysadmin
14       whenever a takeover occurs.
15

SUPPORTED PARAMETERS

17       email
18           The email address of sysadmin.
19
20           (required, string, no default)
21
22       subject
23           The subject of the email.
24
25           (optional, string, default "Resource Group")
26

SUPPORTED ACTIONS

28       This resource agent supports the following actions (operations):
29
30       start
31           Starts the resource. Suggested minimum timeout: 10s.
32
33       stop
34           Stops the resource. Suggested minimum timeout: 10s.
35
36       status
37           Performs a status check. Suggested minimum timeout: 10s. Suggested
38           interval: 10s.
39
40       monitor
41           Performs a detailed status check. Suggested minimum timeout: 10s.
42           Suggested interval: 10s.
43
44       meta-data
45           Retrieves resource agent metadata (internal use only). Suggested
46           minimum timeout: 5s.
47
48       validate-all
49           Performs a validation of the resource configuration. Suggested
50           minimum timeout: 5s.
51

EXAMPLE CRM SHELL

53       The following is an example configuration for a MailTo resource using
54       the crm(8) shell:
55
56           primitive p_MailTo ocf:heartbeat:MailTo \
57             params \
58               email=string \
59             op monitor depth="0" timeout="10s" interval="10s"
60

EXAMPLE PCS

62       The following is an example configuration for a MailTo resource using
63       pcs(8)
64
65           pcs resource create p_MailTo ocf:heartbeat:MailTo \
66             email=string \
67             op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="10s"
68

AUTHOR

73       ClusterLabs contributors (see the resource agent source for information
74       about individual authors)
75
76
77
78resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_MAILTO(7)