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       inject_errors
37           Used only for testing! Specify % of I/O errors to simulate drives
38           failures.
39
40           (optional, integer, no default)
41

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

64       The following is an example configuration for a storage-mon resource
65       using the crm(8) shell:
66
67           primitive p_storage-mon ocf:heartbeat:storage-mon \
68             params \
69               drives=string \
70             op monitor timeout="120s" interval="30s" start-delay="0s"
71

EXAMPLE PCS

73       The following is an example configuration for a storage-mon resource
74       using pcs(8)
75
76           pcs resource create p_storage-mon ocf:heartbeat:storage-mon \
77             drives=string \
78             op monitor timeout="120s" interval="30s" start-delay="0s"
79

AUTHOR

84       ClusterLabs contributors (see the resource agent source for information
85       about individual authors)
86
87
88
89resource-agents UNKNOWN           01/25/2023           OCF_HEARTBEAT_STORAG(7)