carta
ocf_heartbeat_ClusterMon(7)

ocf_heartbeat_ClusterMon7

Runs crm_mon in the background, recording the cluster status to an html file

Usage

ClusterMon [{start | stop | monitor | meta-data | validate-all}]

Overview

This is a ClusterMon Resource Agent. It outputs current cluster status to the html.

Supported parameters

user

The user we want to run crm_mon as

(optional, string, default "root")

update

How frequently should we update the cluster status

(optional, integer, default 15000)

extra_options

Additional options to pass to crm_mon. Eg. -n -r

(optional, string, no default)

pidfile

PID file location to ensure only one instance is running

(unique, optional, string, default "/run/resource-agents/ClusterMon_RESOURCE_ID.pid")

htmlfile

Location to write HTML output to.

(unique, optional, string, default "/run/resource-agents/ClusterMon_RESOURCE_ID.html")

Supported actions

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

Example CRM shell

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

primitive p_ClusterMon ocf:heartbeat:ClusterMon \
  op monitor depth="0" timeout="20s" interval="10s" 

Example PCS

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

pcs resource create p_ClusterMon ocf:heartbeat:ClusterMon \
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s" 

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie)
  • Debian 7 (Wheezy)
  • Debian 6.0 (Squeeze)

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.