ocf_heartbeat_storage-mon(7)

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

NAME

6       ocf_heartbeat_storage-mon - storage I/O health status
7

SYNOPSIS

9       storage-mon [start | stop | monitor | meta-data | validate-all]
10

DESCRIPTION

12       System health agent that checks the storage I/O status of the given
13       drives and updates the #health-storage attribute. Usage is highly
14       recommended in combination with the HealthSMART monitoring agent. The
15       agent currently support a maximum of 25 devices per instance.
16

SUPPORTED PARAMETERS

18       state_file
19           Location to store the resource state in.
20
21           (unique, optional, string, default
22           "/run/resource-agents/storage-mon-RESOURCE_ID.state")
23
24       drives
25           The drive(s) to check as a SPACE separated list. Enter the full
26           path to the device, e.g. "/dev/sda".
27
28           (unique, required, string, no default)
29
30       io_timeout
31           Specify disk I/O timeout in seconds. Minimum 1, recommended 10
32           (default).
33
34           (optional, integer, default 10)
35
36       check_interval
37           Specify interval between I/O checks in seconds.(Only supported with
38           the damonize option.)
39
40           (optional, integer, default 30)
41
42       inject_errors
43           Used only for testing! Specify % of I/O errors to simulate drives
44           failures.
45
46           (optional, integer, no default)
47
48       daemonize
49           Specifies to start storage-mon as a daemon and check for devices.
50
51           (optional, boolean, default false)
52

SUPPORTED ACTIONS

54       This resource agent supports the following actions (operations):
55
56       start
57           Starts the resource. Suggested minimum timeout: 10s.
58
59       stop
60           Stops the resource. Suggested minimum timeout: 120s.
61
62       monitor
63           Performs a detailed status check. Suggested minimum timeout: 120s.
64           Suggested interval: 30s.
65
66       meta-data
67           Retrieves resource agent metadata (internal use only). Suggested
68           minimum timeout: 5s.
69
70       validate-all
71           Performs a validation of the resource configuration. Suggested
72           minimum timeout: 10s.
73

EXAMPLE CRM SHELL

75       The following is an example configuration for a storage-mon resource
76       using the crm(8) shell:
77
78           primitive p_storage-mon ocf:heartbeat:storage-mon \
79             params \
80               drives=string \
81             op monitor timeout="120s" interval="30s" start-delay="0s"
82

EXAMPLE PCS

84       The following is an example configuration for a storage-mon resource
85       using pcs(8)
86
87           pcs resource create p_storage-mon ocf:heartbeat:storage-mon \
88             drives=string \
89             op monitor timeout="120s" interval="30s" start-delay="0s"
90

AUTHOR

95       ClusterLabs contributors (see the resource agent source for information
96       about individual authors)
97
98
99
100resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_STORAG(7)