Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
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  au-
     tomating  takeover operations. Configure a promotable resource with notifi-
     cations enabled and an additional	monitoring  operation  with  role  "Pro-
     moted".

     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 spe-
     cific 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 data-
	 bases in the instance. Specify one db for HADR mode.

	 (optional, string, no default)

     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.

     notify
	 Suggested minimum timeout: 10s.

     monitor
	 Performs a detailed status check. Suggested minimum timeout: 60s.  Sug-
	 gested interval: 20s.

     monitor (Promoted role)
	 Performs  a detailed status check. Suggested minimum timeout: 60s. Sug-
	 gested 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 mini-
	 mum 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)

resource-agents 4.13.0		   08/27/2026		    OCF_HEARTBEAT_DB2(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ocf_heartbeat_db2&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>

home | help