ocf_heartbeat_ClusterMon(7)

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

NAME

6       ocf_heartbeat_ClusterMon - Runs crm_mon in the background, recording
7       the cluster status to an HTML file
8

SYNOPSIS

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

DESCRIPTION

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

SUPPORTED PARAMETERS

17       user
18           The user we want to run crm_mon as
19
20           (optional, string, default "root")
21
22       update
23           How frequently should we update the cluster status
24
25           (optional, integer, default 15000)
26
27       extra_options
28           Additional options to pass to crm_mon. Eg. -n -r
29
30           (optional, string, no default)
31
32       pidfile
33           PID file location to ensure only one instance is running
34
35           (unique, optional, string, default
36           "/tmp/ClusterMon_RESOURCE_ID.pid")
37
38       htmlfile
39           Location to write HTML output to.
40
41           (unique, optional, string, default
42           "/tmp/ClusterMon_RESOURCE_ID.html")
43

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

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

EXAMPLE PCS

73       The following is an example configuration for a ClusterMon resource
74       using pcs(8)
75
76           pcs resource create p_ClusterMon ocf:heartbeat:ClusterMon \
77             op monitor depth="0" timeout="20s" interval="10s"
78

AUTHOR

83       ClusterLabs contributors (see the resource agent source for information
84       about individual authors)
85
86
87
88resource-agents UNKNOWN           03/09/2020           OCF_HEARTBEAT_CLUSTE(7)