ocf_heartbeat_MailTo(7)

ocf_heartbeat_MailTo7

Notifies recipients by email in the event of resource takeover

Usage

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

Overview

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

Supported parameters

email

The email address of sysadmin.

(required, string, no default)

subject

The subject of the email.

(optional, string, default "Resource Group")

Supported actions

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 10s.

stop

Stops the resource. Suggested minimum timeout: 10s.

status

Performs a status check. Suggested minimum timeout: 10s. Suggested interval: 10s.

monitor

Performs a detailed status check. Suggested minimum timeout: 10s. 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: 5s.

Example CRM shell

The following is an example configuration for a MailTo resource using the crm(8) shell:

primitive p_MailTo ocf:heartbeat:MailTo \
  params \
    email=string \
  op monitor depth="0" timeout="10s" interval="10s" 

Example PCS

The following is an example configuration for a MailTo resource using pcs(8)

pcs resource create p_MailTo ocf:heartbeat:MailTo \
  email=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="10s" 

Releases

8 releases since Debian 6.0 (Squeeze); the text changed 7 times.

  1. 6.0
  2. 7
  3. 8
  4. 9
  5. 10
  6. 11
  7. 12
  8. 13

Author

ClusterLabs contributors (see the resource agent source for information about individual authors)

From resource-agents 1:4.16.0-3+deb13u2 in Debian 13 (Trixie). Parsed by carta from the page's man source.