1. Manuals
  2. Tumbleweed
  3. resource-agents
  4. ocf_heartbeat_db2(7)

Scroll to navigation

OCF_HEARTBEAT_DB2(7) OCF resource agents OCF_HEARTBEAT_DB2(7)

NAME

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

SYNOPSIS

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

DESCRIPTION

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

Standard mode:

An instance including all or selected databases is made highly available. Configure each partition as a separate primitive resource.

HADR mode:

A single database in HADR configuration is made highly available by automating takeover operations. Configure a promotable resource with notifications enabled and an additional monitoring operation with role "Promoted".

In case of HADR be very deliberate in specifying intervals/timeouts. The detection of a failure including promote must complete within HADR_PEER_WINDOW.

In addition to honoring requirements for crash recovery etc. for your specific database use the following relations as guidance:

"monitor interval" < HADR_PEER_WINDOW - (appr 30 sec)

"promote timeout" < HADR_PEER_WINDOW + (appr 20 sec)

For further information and examples consult http://www.linux-ha.org/wiki/db2_(resource_agent)

SUPPORTED PARAMETERS

instance

The instance of the database(s).

(unique, required, string, no default)

dblist

List of databases to be managed, e.g "db1 db2". Defaults to all databases in the instance. Specify one db for HADR mode.

(optional, string, no default)

skip_basic_sql_health_check

Skip basic health check SQL query.

Only set to "true" when the "monitor_retries" and "monitor_retry_all_errors" parameters arent enough to avoid issues under high load.

(optional, boolean, default false)

monitor_retries

Monitor retries before failing.

(optional, string, default "1")

monitor_retries_sleep

Monitor sleep between tries.

(optional, string, default "1")

monitor_retry_all_errors

Set to true to retry monitor-action for all errors instead of the default "db2pd" race conditions.

(optional, string, default "false")

admin

DEPRECATED: The admin user of the instance.

(optional, string, no default)

dbpartitionnum

The number of the partition (DBPARTITIONNUM) to be managed.

(optional, string, default "0")

SUPPORTED ACTIONS

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 120s.

stop

Stops the resource. Suggested minimum timeout: 120s.

promote

Promotes the resource to the Master role. Suggested minimum timeout: 120s.

demote

Demotes the resource to the Slave role. Suggested minimum timeout: 120s.

monitor

Performs a detailed status check. Suggested minimum timeout: 60s. Suggested interval: 20s.

monitor (Promoted role)

Performs a detailed status check. Suggested minimum timeout: 60s. Suggested interval: 22s.

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 5s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

EXAMPLE CRM SHELL

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

primitive p_db2 ocf:heartbeat:db2 \


  params \


    instance=string \


  op monitor depth="0" timeout="60s" interval="20s" \


  op monitor depth="0" timeout="60s" role="Promoted" interval="22s" 

ms ms_db2 p_db2 \


  meta notify="true" interleave="true"

EXAMPLE PCS

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

pcs resource create p_db2 ocf:heartbeat:db2 \


  instance=string \


  op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="20s" \


  op monitor OCF_CHECK_LEVEL="0" timeout="60s" role="Promoted" interval="22s" promotable

SEE ALSO

http://clusterlabs.org/

AUTHOR

ClusterLabs contributors (see the resource agent source for information about individual authors)

12/22/2025 resource-agents UNKNOWN