ocf_heartbeat_db2(7)

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

NAME

6       ocf_heartbeat_db2 - Resource Agent that manages an IBM DB2 LUW
7       databases in Standard role as primitive or in HADR roles as promotable
8       configuration. Multiple partitions are supported.
9

SYNOPSIS

11       db2 [start | stop | monitor | promote | demote | meta-data |
12           validate-all]
13

DESCRIPTION

15       Resource Agent that manages an IBM DB2 LUW databases in Standard role
16       as primitive or in HADR roles in promotable configuration. Multiple
17       partitions are supported.
18
19       Standard mode:
20
21       An instance including all or selected databases is made highly
22       available. Configure each partition as a separate primitive resource.
23
24       HADR mode:
25
26       A single database in HADR configuration is made highly available by
27       automating takeover operations. Configure a promotable resource with
28       notifications enabled and an additional monitoring operation with role
29       "Promoted".
30
31       In case of HADR be very deliberate in specifying intervals/timeouts.
32       The detection of a failure including promote must complete within
33       HADR_PEER_WINDOW.
34
35       In addition to honoring requirements for crash recovery etc. for your
36       specific database use the following relations as guidance:
37
38       "monitor interval" < HADR_PEER_WINDOW - (appr 30 sec)
39
40       "promote timeout" < HADR_PEER_WINDOW + (appr 20 sec)
41
42       For further information and examples consult
43       http://www.linux-ha.org/wiki/db2_(resource_agent)
44

SUPPORTED PARAMETERS

46       instance
47           The instance of the database(s).
48
49           (unique, required, string, no default)
50
51       dblist
52           List of databases to be managed, e.g "db1 db2". Defaults to all
53           databases in the instance. Specify one db for HADR mode.
54
55           (optional, string, no default)
56
57       admin
58           DEPRECATED: The admin user of the instance.
59
60           (optional, string, no default)
61
62       dbpartitionnum
63           The number of the partition (DBPARTITIONNUM) to be managed.
64
65           (optional, string, default "0")
66

SUPPORTED ACTIONS

68       This resource agent supports the following actions (operations):
69
70       start
71           Starts the resource. Suggested minimum timeout: 120s.
72
73       stop
74           Stops the resource. Suggested minimum timeout: 120s.
75
76       promote
77           Promotes the resource to the Master role. Suggested minimum
78           timeout: 120s.
79
80       demote
81           Demotes the resource to the Slave role. Suggested minimum timeout:
82           120s.
83
84       notify
85           Suggested minimum timeout: 10s.
86
87       monitor
88           Performs a detailed status check. Suggested minimum timeout: 60s.
89           Suggested interval: 20s.
90
91       monitor (Promoted role)
92           Performs a detailed status check. Suggested minimum timeout: 60s.
93           Suggested interval: 22s.
94
95       validate-all
96           Performs a validation of the resource configuration. Suggested
97           minimum timeout: 5s.
98
99       meta-data
100           Retrieves resource agent metadata (internal use only). Suggested
101           minimum timeout: 5s.
102

EXAMPLE CRM SHELL

104       The following is an example configuration for a db2 resource using the
105       crm(8) shell:
106
107           primitive p_db2 ocf:heartbeat:db2 \
108             params \
109               instance=string \
110             op monitor depth="0" timeout="60s" interval="20s" \
111             op monitor depth="0" timeout="60s" role="Promoted" interval="22s"
112
113           ms ms_db2 p_db2 \
114             meta notify="true" interleave="true"
115

EXAMPLE PCS

117       The following is an example configuration for a db2 resource using
118       pcs(8)
119
120           pcs resource create p_db2 ocf:heartbeat:db2 \
121             instance=string \
122             op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="20s" \
123             op monitor OCF_CHECK_LEVEL="0" timeout="60s" role="Promoted" interval="22s" promotable
124

AUTHOR

129       ClusterLabs contributors (see the resource agent source for information
130       about individual authors)
131
132
133
134resource-agents UNKNOWN           01/25/2023              OCF_HEARTBEAT_DB2(7)